Differences

This shows you the differences between two versions of the page.

--- touchbound_system:cage [2016/02/24 19:44] – kyrahabattoir
+++ touchbound_system:cage [2024/02/28 10:41] (current) – [Supported locks] Added heavy lock support. kyrahabattoir
@@ Line 16: / Line 16: @@
    * [[touchbound_system:FingerprintPadlock|Fingerprint padlocks]].
    * [[touchbound_system:keyedpadlock|Keyed padlocks]].
+   * [[touchbound_system:heavyduty|Heavy Duty Padlock]].
+If **The KDC Experiment** Second Life experience is enabled on the current parcel, it will also use this feature to recapture avatars that manage to get out of the cell.
+//NOTE: If RLV-Relay teleport is enabled, the cell will only attempt to use RLV teleport if it cannot use experience teleport.//
+====== RLV & Experience ======
+By default, the KDC Lattice Cage will attempt to apply RLV restrictions to its occupant(s) with an RLV Relay, as soon as the door is closed.
+  - Touch distance to 1.5m maximum.
+  - Cannot use landmarks to teleport.
+  - Cannot be teleported by others.
+  - Cannot teleport home.
+  - Cannot edit the Lattice Cage itself.
 ====== Anchors ======
 {{:touchbound_system:cage_anchor.png  }}
@@ Line 34: / Line 46: @@
 ====== Configuration ======
 The Lattice Cage comes with a notecard based configuration allowing to tweak some of its features.
-===== Sample Configuration =====
-**IMPORTANT!! Ensure that the land the cage is on has teleport routing set to "anywhere" if you want to use FORCE_TP or this feature won't work properly!**
-**Be aware that if FORCE_TP is ON, the effect is active as soon as the door is __closed__, regardless of it's locking state, and is deactivated as soon as the door is opened.**
+**IMPORTANT!! As of version 5, the configuration is adjusted by RENAMING the different configuration notecards rather than editing their content. With the exception of the "config.whitelist" notecard.
+===== Master Key =====
 <code>
-//KDC cage configuration
+config.masterkey= : No master key is set.
-//**********************
+config.masterkey=<LockID>: Keys that match the lockcode <LockID> will always be able to unlock the cage.
-//All lines starting by "//" will be ignored.
-//Allow the cage to attempt to force teleport prisoners that attempt to escape.
+NOTE: Multiple LockIDs can be defined one after the other.
-//(Do not use this unless your parcel's teleport routing is set to "anywhere"!!!)
+Example: "config.masterkey=<LockID1>,<LockID2>,<LockID3>"
-//Valid settings: YES/NO
+</code>
-FORCE_TP=NO
-//If you want the door to auto open on unlock
+===== Secure Lock =====
-//Valid settings: YES/NO
-AUTO_OPEN_DOOR=NO
-AUTO_OPEN_HATCH=NO
-//To restrict cage locking to a list of people
+<code>
-//Ex: John Doe,Kyrah Abattoir
+config.securelock=: (default) No lock restriction.
-//The list can only use legacy names (John Doe,Jessie Resident)
+config.securelock=<LockID>: Only the Lock <LockID> can be installed on the cage locking points.
-//Or usernames (john.doe,jessie) separated by commas.
-//Leave empty to disable.
-RESTRICT_TO_USERS=
-//Uncomment the next line to restrict cage locking to the group the cage is set to.
+NOTE: Multiple LockIDs can be defined one after the other.
-//Valid settings: YES/NO
+Example: "config.securelock=<LockID1>,<LockID2>,<LockID3>"
-RESTRICT_TO_GROUP=NO
+</code>
+On keyed lock and key sets, the LockID will be written in the locks & keys description after they have been initialized.
-//If no user or group restriction is set the cage locking will default to public,
+===== Auto Open =====
-//In which case putting a timer is recommended.
-//NOTE: No matter the setting, the cage WILL require a TB padlock to lock.
+<code>
+config.door.auto-open=Yes : Then door will auto-open when the lock is removed.
+config.door.auto-open=No : The door have to be manually opened when unlocked.
+</code>
+<code>
+config.hatch.auto-open=Yes : Then hatch will auto-open when the lock is removed.
+config.hatch.auto-open=No : The hatch have to be manually opened when unlocked.
+</code>
-//The timer will automatically unlock the cage doors after the given time has passed
+===== Lock Time =====
-//Times are expressed in minutes
-//A value of 0 disable the auto unlocks
-AUTO_UNLOCK_DOOR=0
-AUTO_UNLOCK_HATCH=0
+<code>
+config.max-locktime=0 : Locks will behave normally.
+config.max-locktime=<minutes> : Any lock used on this object will be converted into "time release locks" so they can be removed after the configured time has elapsed.
+</code>
-//This is where you specify the cage skin.
+===== RLV Force-teleport =====
-//A blank value will disable updating the skin (useful if you have custom textures)
-//Valid settings: AGED,BLACK,BLUE,GREY,OLIVE,PINK,PURPLE,RED,WHITE,YELLOW
-BASE_SKIN=BLACK
-CAGE_SKIN=BLACK
-//This is where you specify the cage tint/color.
+IMPORTANT! Do not enable this feature unless parcel teleport routing is set to "Anywhere"!
-//A blank value will disable updating the tint (useful if you prefer to tint the cage manually)
-//GREY and BLACK skins are best for that.
+(About Land > Options > Teleport Routing)
-//Values can be entered in the following format: "<R,G,B>" (red green blue) from 0 to 255
-BASE_TINT=<255,255,255>
+<code>
-CAGE_TINT=<255,255,255>
+config.rlv.teleport=Yes : The cage will try to teleport escapees using their RLV relay.
+config.rlv.teleport=No : The cage will only use experience powers to teleport escapees, if possible.
+</code>
+//NOTE: The cell will only attempt to use RLV teleport if it cannot use experience teleport.//
+===== RLV Build/Edit prevention =====
+<code>
+config.rlv.nobuild=Yes : Cage occupants with a relay won't be able to build or edit objects.
+config.rlv.nobuild=No : Default.
+</code>
+===== Appearance =====
+These two notecards determinate which skin texture will be loaded by the cage color script, possible values are:
+Aged,Black,Blue,Grey,Olive,Pink,Purple,Red,White,Yellow
+<code>
+config.texture-base=Aged
+config.texture-cage=Aged
+</code>
+These two notecards determinate which tint will be loaded by the cage color script, values are expressed in RGB colors <R,G,B>, if you prefer to use manual tinting, you can safely delete those two notecards.
+<code>
+config.tint-base=<255,255,255>
+config.tint-cage=<255,255,255>
 </code>
 ====== Anchor modding ======