VGS BLACK MARKET
Awfuly Good Props To Do Awfully Bad Things

New Releases,VGPS,VGS Break and Enter (B&E)

February 13, 2013

VGS Break and Enter Door

✱General Info and Features✱

The VGS Break and Enter Door Script has been designed so that it should be easily installable in any of your doors and can be set for compatibility with all VGS Break and Enter type products. The script is ideal for sim builders in that it is copiable and in that the door allows you to set up a number of door properties so that it may be installed in a range of door types.

The door is suitable for Break and Enter/Home Invasion RP and can be set to broadcast its location to our VGS Homes Website, here.

It is also compatible with our VGPS Stalker Database System for those who enable web searches. All these features, of course, are optional and can be turned on or off.

►FEATURES◄

  1. Includes many pre-made doors;
  2. 6 possible user-types: Owner, Owner Admin, Tenant, Admin, Access and non-user;
  3. Owner Admin can perform most owner tasks;
  4. Compatible with CasperLet Rentboxes;
  5. Turn ‘pickable with VGS Break and Enter tools’ on/off (tools Include Crowbars, Lockpicks, Sledgehammers);
  6. Turn ‘broadcast on VGS Homes Website‘ on/off;
  7. Turn ‘Say If Home when broadcasting to website’ on/off;
  8. Various other menu driven setup options – auto-close, lock on close, group access on/off etc;
  9. Menu driven Access, Admin and Tenant lists;
  10. User notecard provides a hard-copy of a basic setup which reloads whenever a tenant leaves;
  11. Possible for Owner to restrict Tenant Setup Rights – e.g., stop your tenants turning their door’s pickability on/off etc;
  12. Set door’s rotation axis and rotation direction;
  13. Set a particular prim on the door to present user menu or use whole door instead;
  14. Add muptiple ‘Ring Bell’ options to the door to allow visitors differeny types of knock (6 sounds come with door but you can add your own);
  15. Compatible with VGS Alarms and Security Systems.

Contents:

Installing the Break and Enter Door Kit
  1. Installing the kit
  2. Setting up the Door
  3. Installing Bell/s
Using the Door
  1. User Menus
  2. Setup Menu
  3. !user_setup Notecard
Using VGS Homes Website
  1. Searching the Website
  2. VGPS Compatability

✻Installing the Break and Enter Door Kit✻

The VGS Door Kit comes with a number of pre-made doors. You can use these doors right away; however, if you have a door of your own you’d rather use, read the following:

To make use of the VGS Door Kit, you must:

  1. Have a door for which you have modify permissions.
  2. In multi-prim doors, ensure that the root prim (i.e., the prim in which the scripts will be installed) is the door’s hinge.

If the door is a single prim however, you will need to ensure it has been ‘path cut’ in half as the door’s rotation will occur through one of the prim’s central axes.

►To instal the kit:

  1. Unpack the door kit;
  2. Find the VGS Door Kit Installer in your inventory and rez it on the ground within 10m of the door;
  3. Right click your door and select edit from the context menu. Click ‘More’ to extend the ‘Edit Window’ and click on the Contents tab;
  4. Find the ‘_installer’ script in your inventory and by holding down your left mouse button on it, drag it into the door’s contents folder;
  5. Click your door and the Installer should install all the basic door items. Note the door will likely throw a few errors whilst it loads. This is normal.

►Setting up the Door

To setup the door so it functions as you want it to, you will need to use the top part of the ‘!user_setup’ notecard. Open the card by:

  1. Right-clicking the door and selecting Edit;
  2. Clicking the Content tab;
  3. Double-clicking the ‘!user_setup’ Notecard.

For now, you need concern yourself only with the following parts:

Direction: 1
Axis: z
Lock Link: 0
Offset: <0.0, 0.0, 0.0>

•Direction•
Accepts values 1 and -1. Will alter the door so that it rotates inward or outward. Rotation will take place down the very centre of one of your door’s hinge/root prim axes.

•Axis•
Accepts values x, y and z and refers to the axis along which the door will rotate. Unless the hinge/root prim has been rotated, you will most likely want the z (blue) axis to serve as your axis of rotation.

•Lock Link•
This option is used for multi-prim doors and allows you to select which prim on the door, if clicked, will return a user menu. If set to 0, when a user clicks anywhere on the door, they will ALWAYS get a user menu and have to click ‘open’ to enter. However, you may have a handle prim on your door or a security pad whose ‘link number’ is 3. Entering 3 as the Lock Link will ensure users only get a door menu if they click that security pad or handle. Clicking anywhere else on the door will open the door without fuss.

NOTE: non-users still get the non-user menu wherever they click. Only Owners, Tenants, Admin and Access list members may use the Lock Link user menu and so must know where it is.

Included in this kit is a script for getting a link number. To use it,

  1. Right-click the door and open the Edit Window;
  2. Tick ‘Edit Linked’ at the top of the Edit Window;
  3. Click on the door prim that you would like to use as the door’s lock and then click on the Content tab;
  4. Find the Linknumber Finder Script in your inventory and drag it into the prim’s contents folder. It will automatically whisper the Prim’s link number then disappear.
  5. Uncheck the ‘Edit Linked’ box in the Edit Window and then enter the link number you were given as the door’s ‘Lock Link:’ value. Only that link will in future return the user menu.

•Offset•
The ‘Offset’ category allows you to set the Break-In Animation Offset which is entered as a vector value and allows you to control where an avatar will move to and animate when they try to break in. Because the door’s root may be the hinge, then the door’s basic position is also considered to be the hinge. This can lead to incongruity when animating wouldbe burglars. The Offset allows you some control over this. The Offset position too is also the position that is broadcast to our website TP link, thus ensuring (as far as we can) wouldbe criminals TP outside your home.

The Offset value must be entered as a vector, hence it should be entered as 3 floating point number values, separated by commas and set in-between a pair of opened and closed angle brackets. E.g. a vector should look like this:

<0.2, 0.5, 0.0>

When you right-click an object and select Edit, you will see three arrows (assuming Position is checked in the Edit Window) – a red arrow (x), a green arrow (y) and a blue arrow (z). The three values above represent a direction along these x, y and z axes offset from the position of the root prim. Hence, in the above example, the intruder avatar would animate 0.2m along the positive x-axis of the root prim and 0.5m along its positive y axis (‘positive’ here means following in the direction of the object’s positioning arrows). If you want to Offset the intruder down the negative axis of the root prim (i.e. going in the opposite direction that the prim’s position arrows point) then you should enter negative values in the vector. For instance:

<-0.3, 0.5, 0.0>

will have the intruder animate 0.3m along the negative x-axis (i.e. 0.3m in the opposite direction of the red positioning arrow) and 0.5m along the positive y-axis (i.e. 0.5m following the direction of the green arrow).

For best effects, you should try to adjust these so that an intruder will animate in front and at the center of your door.

•Final Note: Make sure all data on the ‘!user_setup’ notecard is entered in the

Setting Name: value

format described above. The Setting Name part is case sensitive and the colon must remain to separate the values. Not maintaining this data structure will break the feature. E.g., in

Direction: -1

‘Direction’ must have a captial ‘D’ and be followed by a colon prior to entering the value -1.

►Installing Bells/Knocks Etc

You can install a number of bell/knock sounds in the VGS door. These can either be those sounds that come with the door or your own custom sounds. To use your own custom sound you must have modify permissions and rename the sound so the name begins with a ‘$’ sign (without quotes). Hence, if you have a fast knocking sound, you might name it:

$Fast Knock

The name following the ‘$’ is what will show in the menu for non door-users. E.g., someone clicking a door with the above sound installed would get the option ‘Fast Knock’. Keep the names at between 10-12 characters or they will be truncated. A good selection of different knock/ring types should allow for more elaborate RP interaction. You may install upto 6 bell/knock sounds.

✻Using the Door✻

The new VGS Door has 6 different User Types:

  1. Owner/Landlord – Doors actual owner;
  2. Owner Admin – Admin with most owner options available;
  3. Tennant – Main Tennant. (Is Landlord if not set);
  4. Admin – Set by tenant with basic admin rights;
  5. General User – Anyone on Access List;
  6. Non-user – Rest of SL population.

Each user has a certain number of options available to them. The fullest range of options applies only to the Owner and the least number to Access List members.

►Non-user Options

Non-users have no permissions regarding the door and represent the entire SL population.

•Do Nothing or Cancel
Lag friendly way to close the menu;

•Open/Close
Opens or Closes the door (only possible if door is unlocked.)

•Ring Bell (or alternative)
If the bell feature is On, this will ring or knock at the door etc. The door may be loaded with upto 6 different Knock/Ring sounds to accommodate and inspire various kinds of RP.

•Break In
If the door is pickable, you can use a VGS Break and Enter device such as the Lockpick, Sledgehammer or Crowbar to break into the house. Equip the B&E device and then select this option.

•Help
Gives out a Help notecard.

►General User Options

These options apply to all user types except Non-Users:

•Cancel / Open / Close / Help
See above.

•Lock/Unlock
Locks or unlocks the door denying or allowing other SL residents entry.

►Admin Options

As well as the above options, those on the Admin List have the following additional options:

•Access
Opens the ‘Access Menu’ and provides a list of those currently on it.

•Main Menu (Access Menu Option)
Returns you to the Main Menu.

•Add (Access Menu Option)
Lets you add more people to the Access List. Click ‘Add’ then enter a comma separated list of usernames within 5 mins on channel 5. Type each username exactly as it appears and for single usernames, add ‘Resident’. E.g., if you want to add David204, Alan Dent, Andrea21 and marTIN Christmas to the list, type:

/5 David204 Resident, Alan Dent, Andrea21 Resident, marTIN Christmas

There can be upto 10 names on the Access List.

•Remove (Access Menu Option)
Allows you to remove people from the access list. Click Remove then select the names you want to remove from the resultant menu.

•Clear All (Access Menu Option)
Will clear the whole Access List

►Tennant Options

Tennants have access to all the above options as well as the following options:

•Admin
Lets you add people to the Admin List. The Admin Menu returns exactly the same options as the Access Menu and names are entered in exactly the same way. Again, there is a maximum of 10 adnims.

•Setup
Gives tenant a look at how the Owner has the door set up. Depending on what Setup Rights the Owner has given the tenant, the tenant may be able to alter some of Setup settings.

(See Setup Menu Section for Setup Menu details.)

►Owner and Owner Admin Options

Owners and Owner Admin have access to all the above options as well as the following options:

•Reset
Resets all the door scripts – any setup options, tenants, access and admin lists will be lost.

NOTE: If an Owner Admin uses this option, a full reset is not performed and the Owner Admin list is kept. Only the actual door owner can perform a full reset which will empty even the Owner Admin list.

•Owner Admin
Lets you add and aemove Administrators with most Landlord/Owner powers. Use Add, Remove and Clear All options exactly as you would in Access and Admin lists (See above).

•Tenant
Enters the Tenant Menu

•Add (Tenant Menu Option)
Lets you Add a new tenant – write name on channel 5 as you would with Admin or Access Lists. There can only be 1 tenant however. The tenant must be within 20m of the door or they will not be entered (this is not true for the Admin or Access lists).

•Remove (Tenant Menu Option)
Removes the tenant and replaces tenant with Owner.

•Set Rights (Tenant Menu Option)
Allows you to give Tenants access to Setup options such as Find on Web and Pickable (See Setup Menu section). This allows you to give or restrict door setup options for tenants. For instance, you may have a tenant who is your sub and whose home you want to be broadcast to our website and for them to be unable to turn it off. Alternatively, you might want Find On Web to be off by default but for a tenant to be able to switch it on if they like.

•CasperLet
Gives access to Casper Rent Box options. Allows Casper rent boxes to control current tenant.

•Select Box (CasperLet Menu Option)
Click this and then click the Casper Rent Box you wish to associate with this door. SL residents paying this box will become the door’s new tenant.

•Clear Box (CasperLet Menu)
Clear the current Casper Rent Box associated with the door.

✻Setup Optioins✻

•Close Time: <number>
Sets an Automatic Close Timer so if the door is left open, it will auto-close after that time. Selecting this option will return a menu for you to set the timer. The value must be greater than 5 seconds or the feature will not switch on. In the Setup List, <number> is the number of seconds currently set. E.g., the menu may display:

✔Close Time: 10

This would signify that the ‘close door if open’ timer is currently on and will close the door in 10 seconds after its being opened.

•Cls On Pick
If the close timer is on (set to more than 5 seconds), then this option will say if the door should auto-close after it’s been picked. If no, picking the door will leave it open untill someone else closes it.

•Lock On Cls
If this option is set to On, the door will auto-lock whenever it is closed. This will be the case even if it is picked and auto-closes.

•Group Entry
Means that SL residents whose Group Tags are set to the same group as the door will be treated as general ‘Access List’ level users. I.e., they will be able to open, lock and unlock the door.

•Test Pick
Only available to the Owner, this mode should be switched off unless you are testing a lockpick. It forces the door to treat everyone as if they were an outsider – no one can unlock or open the door whilst this mode is active. It is also useful for testing your bell sounds.

•Bell
Turns bell feature on/off.

•Pickable
Turns use VGS Break and Enter devices on/off. If this option is set, robbers, stalkers, sex offenders, security services etc will be able to use VGS devices to break into your home.

•Find On Web
If this option is On, the door will be broadcasting its position to the VGS Homes website. This is to cater for Break and Enter, burglary/stalker/home invasion roleplay. See here:

http://www.vgsblackmarket.com/homes/

This option can only be set if the door is Pickable.

•Say If Home
If the door is Pickable and if Find On Web is set, this option may be set to tell the website when you are at home.

The Door Owner must give the tenant permission to change any of the above setting (see Tenant->Set Rights in User Menus section). If no such permissions are granted, Setup will just return an empty menu displaying the current settings’ values.

✻!user_setup Notecard✻

The !user_setup Notecard allows you to hard-set certain conditions to the door. The first 4 options (Direction, Axis, Lock Link and Offset) are covered in the Intalling the Breachable Door Kit section. This section is concerned only with the Tenant Rights and Setup sectopns.

The Tenant Rights and Setup parts of the !user_setup notecard let the Owner hard set the door’s very basic Tenant Rights and Setup which are applied whenever the door’s tenant changes. Hence, for example, you can give the tenant permission to set a door to pickable and have its default state as not pickable. If a tenant decides to turn this state on, then leaves, the door will reload the basic Setup of not pickable but retain rights for the next tenat to turn it back on.

To open the !user_setup notecard, you must be the door’s Owner:

  1. Right-click the door and select Edit from the context menu;
  2. Click ‘More’ to extend the Edit Window then click Content tab;
  3. Double-click the !user_setup notecard to open it.

Towards the end of the notecard you will see:

Tenant Rights: Close Time, Cls On Pick, Lock On Cls, Group Entry, Bell, Find On Web, Say If Home, Pickable

Setup: Close Time/10, Bell, Pickable

The setup is inserted in a Setting: Values format. The setting Tenant Rights represents those options your tenants are allowed to change whereas the Setup setting defines the default door setup reloaded each time a tenant leaves. Hence, in the above, tenants will be able to change all setup options and the door will default when they leave, to a close time of 10 seconds, the bell on and the door pickable.

To enter the values, you must write a comma separated list after the colon (:) as shown above. Any options omitted will be unavailable (in the case of Tenant Rights) or unset (in the case of Setup). The values should be written as they are seen in the setup menu – Tenant Rights, above, provides an exhaustive list of all the available values. If you wanted to have all the options set to On by default for instance, you would write:

Setup: Close Time/10, Cls On Pick, Lock On Cls, Group Entry, Bell, Find On Web, Say If Home, Pickable

Notice that Close Time is an exceptional case as it needs both to be set to on and a time value. Hence, Close Time must be followed by a ‘/’ then the number of seconds it takes to close following it. E.g., Close Time/30 will set the close timer at 30 seconds. If you want no default setup, just write:

Setup:

The Values are not case sensitive, however the settings Setup and Tenant Rights are and must be exactly as seen. You may therefore write:

Setup: close time/20, pickable

But not:

setup: close time/20

Also Note that Test Pick may not be set here for either setting. Test Pick may not be turned on by tenants as a rule and can only be switched on when by the Owner using the Setup Menu.

✻Using VGS Homes Website✻

The VGS Breachable Doors can be set to broadcast their location to a website here:

http://www.vgsblackmarket.com/homes/

•Easy Searching•
The website can be searched by Resident name – which will be the current tenant – or Region name. You only need enter part of the name to search it.

The doors may also be set to tell the website when a tenant is at home. This is shown under the Last Here section and where this feature is switched off, it will just say ‘Hidden’.

You can change the table order by clicking on the various headers, for example, clicking ‘Last Here’ will order all entrants according to when they were last at home. Hidden users will appear last.

•VGPS Transmitter/Tracknet Compatible•
Certain names will appear with 1 or 2 icons at the side of them. These icons designate whether or not the tenant has a VGPS Transmitter or Tracknet profile. Transmitter users will have a T icon by their name, Tracknet users a little target icon. You can hover over the icons to identify its type and click it to goto the VGPS profile. If the icon is flashing, the tenant is currently using their transmitter and is grabbable and trackable.

NOTE These icons will ONLY appear if the tenant has a web profile. It is possible to own a transmitter or tracknet, but have web profiles turned off. In this case, the icons will not be shown.

Leave a comment

RSS feed for comments on this post. TrackBack URL

You can use these XHTML tags: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>