BLACK DRAGON STUDIOS
These instructions assume you have a familiarity with the editing of prims and sub-prims in a link set and how to change the name, description and inventory of a single prim in a link set. If you do not know how to edit a single prim in a link set it is advised that you reference help notecards, the SL Wiki and other sources you may know on Building in SL and editing prims in a link-set.
Ⓐ DOOR SCRIPTS
KRH S2 LINKED DOOR SYSTEM
BY KRAHAZIK DRAGON (ZAYTSEV)
MAY 2012 - VERSION 1.0
INSTRUCTIONS
These instructions assume you have a familiarity with the editing of prims and sub-prims in a link set and how to change the name, description and inventory of a single prim in a link set. If you do not know how to edit a single prim in a link set it is advised that you reference help notecards, the SL Wiki and other sources you may know on Building in SL and editing prims in a link-set.
Ⓐ DOOR SCRIPTS
There are four door scripts to choose from for the different door types of doors, Rotating, Sliding, Shrinking and Hollow. To use just place the script of the desired door type into the door prim. The first time the script is placed in the door prim it will check the description field to make sure the first two entries in its options list are correct, if not it will add the first two entries to the description field and set accordingly. When there is no option set the door will use an internal default for its movement parameters.
- Make sure the door prim is not occupying the same region coordinates as the root prim if part of a link set, unless the door is the root prim. If not part of a link set the door will function by itself.
- All doors that you want to move at the same time must all have the exact same door name. The door name is the name of the prim with the door script minus anything after a *. Any text after a * character is not counted as part of the door name.
EXAMPLE: Prim name = Test Door A*Left
Door name = Test Door A
- Door options and state are stored in the description field of the door prim with each option and its corresponding values separated by a back slash \ character. Only the first 2 options are fixed representing the door's open/close state as a 1 (open) or 0 (close). The second option is the door's lock state represented as either a 1 (locked) or a 0 (unlocked). All other options are optional with the door utilizing internal defaults for any option not present in the description. With the exception of the open/close and lock/unlock states, options may be placed in any order within the prim's description.
Options present which are not used by the door script, but may be used by other scripts in the prim, will be ignored and will not adversely effect the door script.
Options and their values are case sensitive.
- RM = Has no value. Used by all doors.
This option disables the door's touch function requiring the use of a remote switch to trigger the door. This option is only checked when the door script first starts up.
When adding or removing this option you must reset the script for it to take effect. - RD = Has no value. Used by Rotating and Sliding door scripts.
This option reverses the doors normal direction of movement. - VL = FLOAT, Volume. Used by all door scripts.
This option sets the volume level of the door sound effects.
Default value is 1. Valid value is a float between 0 and 1. - GRP = STRING, Group name. Used by all doors.
This option sets the door to a common group. Door will respond to command sent to the group name just as if the command had been sent to the door name. - OD = STRING, Other doors list. Used by all doors.
This option defines a comma separated list of other doors the door is tied to. When any of the doors in this list is open, the door will not open, only opening if all of the doors in the list are closed. Can be set to a single door, or can list multiple doors separating each door entry with a comma. Do not put any spaces between door names.
EXAMPLE: \OD\Door A,Door B,Door C - AX = STRING, Axis of movement. Used by Rotating and Shrinking door scripts.
This option defines which axis the door will move on and which axis is used for calculating default movement values.
Default value is X. Valid values are X Y or Z. - SM = Slient Mode. Has no value. Used by all doors.
This option when present will silent all door sounds and text messages.
- RA = FLOAT, Rotation angle in degrees. Used by rotating doors only.
This option defines how far the door will rotate when opening/closing in degrees.
Default value is 90. Valid value is a float between 0 and 359. - RT = FLOAT, Rotation time in seconds. Used by rotating doors only.
This option defines how long it takes for the door to complete its movement.
Default value is 0.2 seconds.
- SD = VECTOR, Slide distance. Used by sliding doors only.
This option defines how far the door will slide when moving and on which axis it moves.
Default is the width of the door on the Y axis minus 0.05m.
EXAMPLE: <0,1.5,0> = This would cause the door to slide 1.5 meters along the Y axis of the build (the root prim).
- SR = FLOAT, Shrink distance in meters. Used by shrinking doors only.
This option defines how much the door will shrink when opening and expand when closing.
Default is the width of the door on the defined axis minus 0.05m.
EXAMPLE: 1.5 = This would cause the door to shrink 1.5 meters along the defined axis of the door prim when closing and expand 1.5 meters along the defined axis when opening.
NOTE: This value can not be greater than the length of the defined axis. If it is greater than the length of the defined axis, then the default value will be used. - SO = VECTOR, Size Opened. Used by shrinking doors only.
This option defines the size of the door when open. This overrides the SR and AX values. - SC = VECTOR, Size Closed. Used by shrinking doors only.
This option defines the size of the door when closed. This overrides the SR and AX values.
- HS = INTEGER, Hollow shape. Used by hollow doors only.
This option defines the shape of the hollow opening when the door is open.
Default value is 0, default shape.
Valid value sare:
0 = Default
16 = Circle
32 = Square
48 = Triangle - HO = FLOAT, Hollow opening. Used by hollow doors only.
This option defines the size of the hollow opening when the door is open.
Default value is 0.8. Valid values are between 0 and 0.95.
- RM = Has no value. Used by all doors.
- Door Sounds. The door can be set to play a number of sound effects when certain actions are taken instead of displaying a text message. To set the door sounds just drop in the sound you wish to use and rename the sound file adding the type prefix followed by a dash to the front of the sound name.
EXAMPLE: OPEN - House Wooden Door
Sound Types are:- OPEN = Plays whenever the door is opened. Defaults to the 1st sound found in the prim if not set.
- CLOSE = Plays whenever the door is closed. If not set will play the open sound.
- LOCK = Plays any time the door is locked or unlocked.
- BELL = Plays when the bell command is received or the door is triggered while locked.
- ERROR = Plays when the door encounters and error.
- API Command System. The doors communicate with various parts of the system using linked messages on 2 channels. Channel 210 is used for the transmitting and receiving of commands and channel 310 is used for the sending and receiving of reports such as changes in door state.
Any time a door state changes (open/close or lock/unlock) the door reports it change of state in a linked message to the entire link set on channel 310.
Commands to the doors must be sent as a linked message on link channel 210.
Doors do NOT have any listeners and can not receive any commands via any chat channel.
Doors do NOT transmit any information on any chat channel.
Link message commands must be formatted correctly as:
<door name>|<command>
<door name> = Must be the door's name, group name, ALL, or ALL DOORS.
Valid door commands (for all door scripts) are:- TOGGLE = Toggles the door open/closed. If the door is open, it will close and vice versa.
- OPEN = Opens the door if it is not already open.
- CLOSE = Closes the door if it is not already closed.
- LOCK TOGGLE = Toggles the door lock lock/unlock. If the door is locked it will unlock and vice versa.
- LOCK = Locks the door.
- UNLOCK = Unlocks the door.
- RING BELL = Rings the door's bell sound if any.
- REPORT STATE = Causes the door to send its door state message on link channel 310.
- RESET = Resets the door script.
Ⓑ REMOTE TRIGGER SCRIPTS
There are two remote trigger scripts to chose from. Remote triggers are used in a prim other than the prim with the door script and used to trigger the door from some where else in the link-set. The prim with the remote switch script must have the same door name as the set of doors or door the switch is supposed to trigger. Switch options are done exactly the same as with door options.
Options and their values are case sensitive.
Options and their values are case sensitive.
- CMD = STRING, Commands. Used by Collision and Remote switches.
This option is a list of commands to be issued to the door with each command separated by an and & character.
Default value is TOGGLE. - TGT = STRING, Target name. Used by Collision and Remote switches.
This option defines the name of the door set the switch will command.
Overrides the prim name of the switch.
Default value is the name of the prim the switch is in minus anything after a * character.
Ⓒ AUTOCLOSE TIMER SCRIPT
The autoclose timer script is used to automatically close the door after a set time period has elapsed.
The autoclose script can be used in a prim with either a remote switch script or a door script or it can be placed in a prim by itself. The name of the prim containing the autoclose script must be the exact same name as the door prim the autoclose is supposed to close.
Options and their values are case sensitive.
The autoclose script can be used in a prim with either a remote switch script or a door script or it can be placed in a prim by itself. The name of the prim containing the autoclose script must be the exact same name as the door prim the autoclose is supposed to close.
Options and their values are case sensitive.
- AC = FLOAT, Autoclose time in seconds. Used by the autoclose timer.
This option defines how long the timer will wait before sending the close command to the door.
Default value is 0.0.
A value of 0.0 dissbles the autoclose timer. Any value above 0 will activate the timer when the door is opened.
Ⓓ DOOR LAMP SCRIPT
The door lamp script can be used to light up a prim to indicate when the door is open and closed. It can be placed in any prim as long as the name of that prim is the exact same as the door the lamp is supposed to respond to.
Options and their values are case sensitive.
Options and their values are case sensitive.
- FC = INTEGER, Light face. Used by the door lamp.
This option defines which face will be lit up when the door is opened.
Default value is -1. - OFC = VECTOR, Off Color. Used by the door lamp.
This option defines what color the lamp will be when it is off. - ONC = VECTOR, On Color. Used by the door lamp.
This option defines what color the lamp will be when it is on. - GL = FLOAT, Glow level. Used by the door lamp.
This option defines how much glow the lamp will have when it is on.
Default value is 0.5. Valid entry is any float between 0 and 1. - FB = No value, Full Bright. Used by the door lamp.
This option when present will set the defined face to full brightness when the lamp is on.
CREDITS AND SUPPORT
To check for and receive product updates just rez either the original product crate your product came in, or the product itself. If there is a newer version of the product it will be delivered to you automatically.
If you have any questions about any of our products you can join the Black Dragon Studios group and ask questions in group chat - secondlife:///app/group/74bd62f2-ec83-f2bf-37fa-7f50317bec72/about
If you do not have a free group slot you can subscribe to our message list using the Subscribe-O-Matic terminal in any of our satellite stores or the main office.
If you have any questions, please don't hesitate to contact me Krahazik Dragon (ĸraнazιĸ zaчтsev).
If you have any questions about any of our products you can join the Black Dragon Studios group and ask questions in group chat - secondlife:///app/group/74bd62f2-ec83-f2bf-37fa-7f50317bec72/about
If you do not have a free group slot you can subscribe to our message list using the Subscribe-O-Matic terminal in any of our satellite stores or the main office.
If you have any questions, please don't hesitate to contact me Krahazik Dragon (ĸraнazιĸ zaчтsev).
No comments:
Post a Comment