User Tools

Site Tools


touchbound_system:cage

Built to last by a local blacksmith, this cage has seen its fair share of use and abuse as shown by the amount of edge wear and the corrosion stains on the marble block it was erected upon.

Nonetheless, it will serve its new owner for a long time in exchange for a little bit of hinge grease and a touch of paint.

Supported TouchBound functions

Sensing zones

  • Door: Will open/close the cage, or rattle it if locked.
  • Door lockpoint: Can be used with TouchBound Padlocks to lock/unlock the door.
  • Hatch: Will open/close the feed port, or rattle it if locked.
  • Hatch lockpoint: Can be used with TouchBound Padlocks to lock/unlock the feed port.
  • Anchor plates: Can be used to leash TouchBound compatible accessories to the cage.

Supported locks

Anchors

The cage features 4 anchors placed (by default) on the left, right, back and top face of the cage. These anchors can be used as regular TouchBound Anchor plates however, they count as a single target, allowing you to use all 4 anchors on the same avatar, at the same time.

Poses

The cage includes a sit point with a set of 9 poses. You can change pose by using the up/down arrow keys and adjust the offset with the pageUp pageDown keys. The position chosen will be saved until the cage configuration/animation list is changed.

Adjusting

The pose's default Z offset is set to work for me (Kyrah Abattoir) a 1m76 tall avatar, however setting the Z offset to your liking is easy:

  • Select the pose you wish to adjust.
  • Use the PgUp/Down arrows to set your avatar to the desired height, pay special attention to the offset value, which shows up for a few seconds as a hover text in the middle of the cage.
  • Right click/Edit the cage content and find the animation you just used.
  • Change the animation name so that the height offset is at the very end of it with a SPACE right before it. Ex: “My Animation Name -0.25” (without quotes)
  • The cage will automatically reload the animation list and use this value from now on.

Adding more

All you have to do is to drag and drop the new animations inside the cage and it will be detected automatically.

NOTE: Animations are loaded in alphabetical order

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.

//KDC cage configuration
//**********************
//All lines starting by "//" will be ignored.

//Allow the cage to attempt to force teleport prisoners that attempt to escape.
//(Do not use this unless your parcel's teleport routing is set to "anywhere"!!!)
//Valid settings: YES/NO
FORCE_TP=NO

//If you want the door to auto open on unlock
//Valid settings: YES/NO
AUTO_OPEN_DOOR=NO
AUTO_OPEN_HATCH=NO

//To restrict cage locking to a list of people
//Ex: John Doe,Kyrah Abattoir
//The list can only use legacy names (John Doe,Jessie Resident)
//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.
//Valid settings: YES/NO
RESTRICT_TO_GROUP=NO

//If no user or group restriction is set the cage locking will default to public,
//In which case putting a timer is recommended.

//NOTE: No matter the setting, the cage WILL require a TB padlock to lock.

//The timer will automatically unlock the cage doors after the given time has passed
//Times are expressed in minutes
//A value of 0 disable the auto unlocks
AUTO_UNLOCK_DOOR=0
AUTO_UNLOCK_HATCH=0


//This is where you specify the cage skin.
//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.
//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.
//Values can be entered in the following format: "<R,G,B>" (red green blue) from 0 to 255
BASE_TINT=<255,255,255>
CAGE_TINT=<255,255,255>

Anchor modding

The position of the anchor plates doesn't affect their function, feel free to edit the cage and place them where you prefer, or unlink them entirely, however, do not rename them if you want to keep them functional.

Textures

A set of 10 materials is provided with the cage, basic UV maps are also provided.

touchbound_system/cage.txt · Last modified: 2017/04/04 12:35 (external edit)