Created By Marine Kelley.
This document is for people who wish to modify or create their own LSL scripts to use the features of the RestrainedLove viewer. It does not explain LSL concepts such as messages and events, nor universal concepts such as UUIDs.
The RestrainedLove viewer executes certain behaviours when receiving special messages from scripts in-world. These messages are mostly calls to the llOwnerSay() LSL function.
The RestrainedLove viewer intercepts every llOwnerSay message sent to the viewer. Lines that begin with an at-sign (@) are parsed as RLV commands. Other lines are forwarded to the user in the Local Chat window, as usual. For instance, a call to llOwnerSay (@detach=n) sends the detach command with parameter n to the viewer on behalf of the object running the script.
The syntax of a message is:
@<command1>[:option1]=<param1>,<command2>[:option2]=<param2>,...,<commandN>[:optionN]=<paramN>
Note that there is only one '@' sign, placed at the beginning of the message. The viewer interprets this as "this entire llOwnerSay() message contains one or more commands to execute". For documentation purposes, commands are always presented with the leading @. However, it is an error to put the @ in front of each command within a multi-command message, and the subsequent commands will fail.
: Historical Note: Prior to Version 1.10, RLV only allowed one command per message. Version 1.10 added the ability to include multiple commands in one message, to avoid spamming users who are not using this viewer.
If at least one command fails (e.g. a typo), the viewer says … fails command : … and prints the entire message. However, correct commands are still parsed and executed, only the incorrect ones are ignored.
Many of these commands determine the subsequent behaviour of the object or avatar. For example, the @detach=n command locks the given object, making it undetachable. Some commands set global behaviours, which aren't limited to the object sending the command. For example, the @sendchat=n command will prevent the user from talking in local chat.
NOTE about commands with exceptions, such as @sendim or @sendchannel… @(rule):(exception)=n actually (and counter-intuitively) adds an exception for the given rule. @sendchannel:1=n, for example, allows chat on channel 1. This has been the source of at least two scripters' confusion. =add (which means the same as =n) and =rem (which means =y) exist for the purpose of adding and removing exceptions, respectively. Use them.
These behaviours are not persistent between sessions. Since an object changes its UUID every time it rezzes, the object must resend its status (undetachable, preventing IMs…) in the on_rez() event as well as whenever it changes its status.
Note: These commands are not case-sensitive but are spacing-sensitive. In other words, @detach = n will not work.
Notation convention: Parameters in [square brackets] are optional parameters that can be omitted. The pipe | and slash / signs separate options from which one must be used. Angle brackets (< and >) enclose parameters that are mandatory.
Footnotes: "(*)" are footnotes and will be explained at the end of the list
@version=<channel_number>Implemented in v1.0b
Makes the viewer automatically say the version of the RLV API it implements, immediately on the chat channel number <channel_number> that the script can listen to. Always use a positive integer. Remember that regular viewers do not answer anything at all so remove the listener after a timeout.
Warning : when logging in, the on_rez event of all the attachments occurs way before the avatar can actually send chat messages (about half the way through the login progress bar). This means the timeout should be long enough, like 30 seconds to one minute in order to receive the automatic reply from the viewer.
Warning 2 : On 02/22/2010, Linden Lab has released their Third Party Viewer policy which forbids using the term Life in the name of Third Party Viewers. Therefore Restrained Life had to be renamed to Restrained Love. However, for compatibility purposes, this @version command still works and will keep working, however you are encouraged to not use it in new scripts, and to not show the terms Restrained Life to the user anywhere. For new scripts, please use @versionnew below instead.
@versionnew=<channel_number>Implemented in v1.23
Makes the viewer automatically say the version of the RLV API it implements, immediately on the chat channel number <channel_number> that the script can listen to. Always use a positive integer. Remember that regular viewers do not answer anything at all so remove the listener after a timeout.
This command is the successor of @version and replaces it, although @version is kept for ascending compatibility purposes. It returns RestrainedLove viewer v… (SL …) (RestrainedLove is in one word).
Warning : when logging in, the on_rez event of all the attachments occurs way before the avatar can actually send chat messages (about half the way through the login progress bar). This means the timeout should be long enough, like 30 seconds to one minute in order to receive the automatic reply from the viewer.
@versionnum=<channel_number>Implemented in v1.21
Makes the viewer automatically say the version number of the RLV API it implements (please note that this is different from the version of the viewer, which the scripts should not have to care about), immediately on the chat channel number <channel_number> that the script can listen to. Always use a positive integer. Remember that regular viewers do not answer anything at all so remove the listener after a timeout. This command is less cumbersome than @version, since the script does not have to parse the response, it gets the version number immediately.
The version number is a mere integer that represents the version of the API. If the version is X.Y.Z.P, then the number will be X.10^6 + Y.10^4 + Z.10^2 + P. For example, 1.21.1 would be 1210100.
llGetAgentLanguage (key id) DEPRECATED: DO NOT USE !Implemented in v1.16
When calling this LSL function, the result is obtained immediately (no need to use a listener and a timer), is exactly equal to the one given by @version and cannot be hidden by the user. This string takes the place of the language returned by the regular SL viewer, which could answer values like en-us, fr, ko etc. Or nothing at all, if the user chose to hide their language setting. Being optional in the regular viewer, it cannot be trusted by a script, so hijacking this feature for the much more useful synchronous version checking in the RLV makes sense. IMPORTANT NOTE: this feature cannot be implemented in viewers prior to v1.21, even when they do implement RestrainedLove v1.16, so make sure you do fall back to the @version method whenever llGetAgentLanguage() returns an empty string. ALSO NOTE: In RestrainedLove 1.16, llGetAgentLanguage() will return an empty string when called by on_rez during login unless the call is delayed by several seconds (how many seconds may vary). FINAL NOTE: This feature was removed from v1.16.1 (and v1.16b, for the Cool SL Viewer).
@versionImplemented in v1.0a
This command must be sent in IM from an avatar to the user (will not work from objects). The viewer automatically answers its version to the sender in IM, but neither the message nor the answer appears in the user's IM window, so it's usually totally stealthy. However, some viewers, such as Firestorm, have the ability to send an autoreply message when someone begins typing an IM to the user. If the user has that option enabled, an IM window will open and display the auto response as soon as the @ is typed by the sender, but nothing else.
The blacklist (implemented in v2.8) is a list of RLV commands that the viewer is meant to ignore. It is modifiable at any time, but a restart is needed to take the changes into account. When a command is issued and it is part of the blacklist, the RLV will simply ignore it. Modifying the blacklist won't clear existing restrictions though, once they are issued, a restart is needed. When a command is received, a positive acknowledgement is sent to the script, whether the command was actually accepted or not. This way scripts that wait for notifications won't break if they can't handle a denial.
@versionnumbl=<channel_number>Implemented in v2.8
Makes the viewer automatically say the version number of the RLV API it implements (please note that this is different from the version of the viewer, which the scripts should not have to care about), followed by a comma (,) and the contents of the blacklist, immediately on the chat channel number <channel_number> that the script can listen to. Always use a positive integer. Remember that regular viewers do not answer anything at all so remove the listener after a timeout. This command is less cumbersome than @version followed by @getblacklist, since the script does not have to parse the response, it gets the version number immediately, and it does not have to send a second asynchronous request after the response to the first.
For example, @versionnumbl=2222 will answer 2080000,sendim,recvim if the blacklist is currently sendim,recvim. LSL allows for casting such a string into an integer without any trouble, it would return 2080000, discarding the first comma and all that is after it.
@getblacklist[:filter]=<channel_number>Implemented in v2.8
Makes the viewer automatically reply with the contents of the blacklist (if a filter is present, then only the commands containing that text will be part of the reply), immediately on the chat channel number <channel_number> that the script can listen to. Always use a positive integer. Remember that regular viewers do not answer anything at all so remove the listener after a timeout.
@getblacklistImplemented in v2.8
This command must be sent in IM from an avatar to the user (will not work from objects). The viewer automatically answers the contents of its blacklist to the sender in IM, but neither the message nor the answer appears in the user's IM window, so it's usually totally stealthy, with the same caveat mentioned above under @version.
@notify:<channel_number>[;word]=<rem/add>Implemented in v1.20, improved in v2.2 (and v1.24)
Makes the viewer automatically repeat any restriction it adds or removes on the specified channel, or only the restrictions which name contains the word specified after the semicolon (;) character. The response on the private channel <channel_number> is preceded with a slash (/) to avoid making the avatar send commands to other scripts without knowing it, and followed by an equal sign (=) and n or y according to whether the restriction is applied or lifted respectively. The @clear command will not add an equal sign. There is no way to know what object issued the restriction or lifted it, to avoid disclosing too much information about foreign scripts. It does not repeat one-shot commands either (force commands). For example, @notify:2222;detach=add will send /detach=n whenever an object is locked, and /detach=y whenever an object is unlocked, on channel 2222 to which the script will listen to.
Note : Since v2.2 (and v1.24) you can also set a notification for inventory offers. When your object gives an item or a folder, the avatar using a RLV v2.2 (and v1.24) or higher will respond automatically on the given channel one of the following :
/accepted_in_rlv inv_offer <folder> : The folder has been accepted and is now available under #RLV (don't forget that the viewer renames it, removing the #RLV/ prefix)./accepted_in_inv inv_offer <folder> : The folder has been accepted but is not shared./declined inv_offer <folder> : The folder has been declined and/or the user has pressed Block (formerly Mute).
Where <folder> is the full path of the folder or item given. For example, #RLV/~MyCuffs. There is a space before inv_offer, which is a token chosen in a way that it is easy to set a notification for it. If you just want to know whether your folder named #RLV/~MyCuffs has been accepted in the #RLV folder, issue a @notify:2222;accepted_in_rlv inv_offer #RLV/~MyCuffs=add command. If you just want to know whether the avatar has received something, issue a simple @notify:2222;inv_offer=add command.
Note 2 : Since v2.5 the viewer also sends notifications when wearing outfits :
/worn legally <layer> : The avatar has just worn a piece of clothing on the indicated layer./unworn legally <layer> : The avatar has just removed a piece of clothing from the indicated layer./attached legally <attach_point_name> : The avatar has just attached an object to the indicated attachment point./attached illegally <attach_point_name> : The avatar has just attached an object to the indicated attachment point, but was not allowed to (probably a script attached it automatically), and it will be detached in a few seconds./detached legally <attach_point_name> : The avatar has just detached an object from the indicated attachment point./detached illegally <attach_point_name> : The avatar has just detached an object from the indicated attachment point, but was not allowed to (probably a script kicked it off), and it will be re-attached in a few seconds.@permissive=<y/n>Implemented in v1.21
When denied, all restrictions turn into their secure counterparts (if any). This means an exception to a restriction will be ignored if it is not issued by the same object that issued the restriction. Using non-secure restrictions (the original ones, like @sendim, @recvim etc) and not using @permissive allow the avatar to benefit from exceptions issued by different objects.
Warning : Using this command (or any secure version of the original commands) may silently discard exceptions issued by different objects (it is even its primary purpose), hence some products may appear to cease working while this restriction is in effect. For example, a product that allows the avatar to always be able to send IMs a particular friend will not be able to overcome a @sendim_sec or a @permissive command sent by another object, and will look like it is broken. Therefore, use with caution and make the user aware of how secure your own product is !
@clearImplemented in v1.0a, but working only since v1.04a
This command clears all the restrictions and exceptions tied to a particular UUID.
Warning : when triggered on detach by default, this might prevent the automatic reattach when @defaultwear is active, as @clear will also lift @detach=n, thus the viewer thinks the item that gets detached by accident by a default-wear-action is unlocked and will not reattach it.
Possible workarounds:
@clear=<pattern>@clear on detach when you are sure the attachment is not locked@clear on detach at all and wait for the viewer to lift the set restrictions@clear=<string>Implemented in v1.0a, but working only since v1.04a
This command clears all the restrictions and exceptions tied to a particular UUID which name contains <string>. A good example would be @clear=tp which clears all the teleport restrictions and exceptions tied to that object, whereas @clear=tplure: would only clear the exceptions to the teleport-by-friend restriction
@getstatus[:<part_of_rule>[;<custom_separator>]]=<channel>Implemented in v1.10, slightly tweaked in v1.16 and v2.8
Makes the viewer automatically answer the list of rules the avatar is currently under, which would only contains the restrictions issued by the object that sends this command, immediately on the chat channel number <channel_number> that the script can listen to. Always use a positive integer. Remember that regular viewers do not answer anything at all so remove the listener after a timeout. The answer is a list of rules, separated by slashes ('/') or by any other separator if specified. Attention : since v1.16 a slash is prepended at the beginning of the string. This does not confuse llParseString2List() calls, but does confuse llParseStringKeepNulls() calls !
Since v2.8, if <custom_separator> is specified, it will replace the slash ('/') with the provided separator. Attention, the option part must be present, therefore there must be a colon (':') before the semicolon (';'), even if <part_of_rule> is absent.
This command is useful for people who write scripts that may conflict with other scripts in the same object (for instance : third-party plugins). Conflicts do not occur in different objects, that's why this command only replies the restrictions issued by the object calling it.
<part_of_rule> is the name of a rule, or a part of it, useful if the script only needs to know about a certain restriction.
Example : If the avatar is under tploc, tplure, tplm and sittp, here is what the script would get :
@getstatus=2222 ⇒ /tploc/tplure/tplm/sittp@getstatus:sittp=2222 ⇒ /sittp@getstatus:tpl=2222 ⇒ /tploc/tplure/tplm (because tpl is part of tploc, tplure and tplm but not sittp)@getstatus:tpl;#=2222 ⇒ #tploc#tplure#tplm (because tpl is part of tploc, tplure and tplm but not sittp, and the specified separator is #)@getstatus:;#=2222 ⇒ #tploc#tplure#tplm#sittp (because the specified separator is #)@getstatus:;=2222 ⇒ /tploc/tplure/tplm/sittp (because the specified separator is empty, so it defaults to /)@getstatusall[:<part_of_rule>[;<custom_separator>]]=<channel>Implemented in v1.15, slightly tweaked in v1.16 and v2.8
Makes the viewer automatically answer the list of rules the avatar is currently under, for all the objects regardless of their UUID, contrary to @getstatus, immediately on the chat channel number <channel_number> that the script can listen to. Always use a positive integer. Remember that regular viewers do not answer anything at all so remove the listener after a timeout. The answer is a list of rules, separated by slashes ('/') or by any other separator if specified. Attention : since v1.16 a slash is prepended at the beginning of the string. This does not confuse llParseString2List() calls, but does confuse llParseStringKeepNulls() calls !
Since v2.8, if <custom_separator> is specified, it will replace the slash ('/') with the provided separator. Attention, the option part must be present, therefore there must be a colon (':') before the semicolon (';'), even if <part_of_rule> is absent.
@fly=<y/n>Implemented in v1.12.2
When prevented, the user is unable to fly.
@temprun=<y/n>Implemented in v2.7
When prevented, the user is unable to run by double-tapping an arrow key. If you want to prevent the user from running at all, you must also use @alwaysrun.
@alwaysrun=<y/n>Implemented in v2.7
When prevented, the user is unable to switch running mode on by pressing Ctrl-R. If you want to prevent the user from running at all, you must also use @temprun. This command is useful when you want to force the user to accelerate before running, rather than running all the time, for example during combats or sports games.
@setrot:<angle_in_radians>=forceImplemented in v1.17
Forces the avatar to rotate towards a direction set by an angle in radians from the north. Note that this command is not very precise, nor will do anything if the action attempts to rotate the avatar by less than 10° (experimental value, it has been mentioned somewhere that 6° was the minimum). In other words, it is best to either check with a llGetRot() first, or to make the avatar turn twice, first 180° plus the desired angle, then by the angle we need. It isn't very elegant but it works.
@adjustheight:<distance_pelvis_to_foot_in_meters>;<factor>[;delta_in_meters]=forceImplemented in v2.5
Forces the avatar to modify its Z-offset, in other words its altitude. This value can already be changed through a debug setting in most third party viewers, this command allows to automate the change according to the animation.
Attention, certain viewers do not implement this command.
@camzoommax:<max_multiplier>=<y/n>Implemented in v2.9
When active, this restriction prevents the user from zooming in (with the Ctrl-0 key) further than <max_multiplier>, knowing that 1.0 is the default. If several objects issue this restriction, the viewer retains the smallest value of all.
@camzoommin:<min_multiplier>=<y/n>Implemented in v2.9
When active, this restriction prevents the user from zooming out (with the Ctrl-8 key) further than <min_multiplier>, knowing that 1.0 is the default. If several objects issue this restriction, the viewer retains the highest value of all.
@camdistmax:<max_distance>=<y/n>Implemented in v2.9
When active, this restriction prevents the user from moving the camera too far from the avatar, either with the mouse wheel or when focusing with the Alt key. If <max_distance> is set to 0, this command forces the avatar to stay in Mouselook. If several objects issue this restriction, the viewer retains the smallest value of all. This does not impact scripts that move the camera themselves, though.
@camdistmin:<min_distance>=<y/n>Implemented in v2.9
When active, this restriction prevents the user from moving the camera too close to the avatar, either with the mouse wheel or when focusing with the Alt key. If <min_distance> is set to something higher than 0, this command forces the avatar to go out of Mouselook, and prevents from going back to it. If several objects issue this restriction, the viewer retains the highest value of all. This does not impact scripts that move the camera themselves, though.
@camdrawmin:<min_distance>=<y/n>, @camdrawmax:<max_distance>=<y/n>, @camdrawalphamin:<min_alpha>=<y/n>, @camdrawalphamax:<max_alpha>=<y/n>Implemented in v2.9
When active, these two restriction make the viewer draw several concentric spheres around the avatar, with increasing opacities going from <min_alpha> at <min_distance> to <max_alpha> at <max_distance>. The result looks like fog darkening gradually as the distance increases, and it can completely block the view if @camdrawalphamax is set to 1 (the default).
There are several matters to take into account when issuing these restrictions :
@camdrawalphamin and @camdrawalphamax are specified and different. If either of them is omitted, only one sphere is rendered (which may be what the scripter wants).@camdrawalphamax (for example, if @camdrawalphamax is set to 0.75, a white fullbright wall in the distance will look dark grey, RGB 64/64/64), regardless of the number of spheres to draw.@camdrawmin, and @camdrawmin cannot be set below 0.4 (because it is not its role to force to Mouselook, and the sphere would not be rendered by the viewer under that limit).@camdrawcolor:<red>;<green>;<blue>=<y/n>Implemented in v2.9
When this command issues, the color of the fog designed by @camdrawmin and @camdrawmax is set to <red>, <green>, <blue>. Those three values are between 0.0 and 1.0, the default being black (0;0;0). When several objects issue this command, the resulting color is a mix of all.
@camunlock=<y/n>Implemented in v2.9
When active, this restriction prevents the user from unlocking the camera from the avatar, meaning that the user cannot use Alt to focus nor orbit the camera around the avatar. While the camera is locked, the sim forces it to stay in a line of sight from the avatar, meaning that this restriction is good to prevent from seeing through walls.
@camavdist:<distance>=<y/n>Implemented in v2.9
When active, this restriction makes all the avatars beyond <distance> look as if they were visually muted, but colored pitch black.
@camtextures=<y/n>Implemented in v2.9
When active, this restriction makes the viewer ignore every texture in world, except those on the attachments worn by the avatars, as well as their skins and clothes. The materials are untouched as well so this restriction is good for simulating the fact that the avatar cannot see, let alone read textures, but can still feel the world around.
@sendchat=<y/n>Implemented in v1.0b
When prevented, everything typed on channel 0 will be discarded. However, emotes and messages beginning with a slash ('/') will go through, truncated to strings of 30 and 15 characters long respectively (likely to change later). Messages with special signs like ()"-*=_^ are prohibited, and will be discarded. When a period ('.') is present, the rest of the message is discarded.
@chatshout=<y/n>Implemented in v1.15
When prevented, the avatar will chat normally even when the user tries to shout. This does not change the message in any way, only its range.
@chatnormal=<y/n>Implemented in v1.15
When prevented, the avatar will whisper even when the user tries to shout or chat normally. This does not change the message in any way, only its range.
@chatwhisper=<y/n>Implemented in v1.15
When prevented, the avatar will chat normally even when the user tries to whisper. This does not change the message in any way, only its range.
@redirchat:<channel_number>=<rem/add>Implemented in v1.16
When active, this restriction redirects whatever the user says on the public channel (/0) to the private channel provided in the option field. If several redirections are issued, the chat message will be redirected to each channel. It does not apply to emotes, and will not trigger any animation (typing start, typing stop, nodding) when talking. This restriction does not supersede @sendchannel.
NOTE: As of RLV v1.22.1 / RLVa 1.1.0, it had a bug that @redirchat also truncates emotes on channel 0. An additional @emote=add works around this side-effect. This bug was fixed in the Cool VL Viewer starting with v1.22g (but Marine's RLV v1.23 still had this bug) and RLV v2.0 (it is safe to assume it was fixed in all viewers starting with v1.24 and v2.0).
@recvchat=<y/n>Implemented in v1.0b
When prevented, everything heard in public chat will be discarded except emotes.
@recvchat_sec=<y/n>Implemented in v1.21
When prevented, everything heard in public chat will be discarded except emotes. This particular command accepts exceptions issued from the same object only, opposed to the non-secure way that accepts exceptions from any object.
@recvchat:<UUID>=<rem/add>Implemented in v1.01
When adding an exception, the user can hear chat messages from the sender whose UUID is specified in the command. This overrides the prevention for this avatar only (there is no limit to the number of exceptions), don't forget to remove it when it becomes obsolete.
@recvchatfrom:<UUID>=<y/n>Implemented in v2.3 and v1.25
When prevented, everything heard in public chat from the specified avatar will be discarded except emotes.
@emote=<rem/add>Implemented in v1.01
When adding this exception, the emotes are not truncated anymore (however, special signs will still discard the message).
@rediremote:<channel_number>=<rem/add>Implemented in v1.19
When active, this restriction redirects whatever emote the user says on the public channel (/0) to the private channel provided in the option field. If several redirections are issued, the emote will be redirected to each channel.
@recvemote=<y/n>Implemented in v1.19
When prevented, every emote seen in public chat will be discarded.
@recvemotefrom:<UUID>=<y/n>Implemented in v2.4
When prevented, everything emote seen in public chat from the specified avatar will be discarded.
@recvemote_sec=<y/n>Implemented in v1.21
When prevented, every emote seen in public chat will be discarded. This particular command accepts exceptions issued from the same object only, opposed to the non-secure way that accepts exceptions from any object.
@recvemote:<UUID>=<rem/add>Implemented in v1.19
When adding an exception, the user can see emotes from the sender whose UUID is specified in the command. This overrides the prevention for this avatar only (there is no limit to the number of exceptions), don't forget to remove it when it becomes obsolete.
@sendchannel[:<channel>]=<y/n>Implemented in v1.10
Complimentary of @sendchat, this command prevents the user from sending messages on non-public Chat channels. If channel is specified, it becomes an exception to the aforementioned restriction (then it is better to use rem or add instead of y or n respectively). It does not prevent the viewer automatic replies like @version=nnnn, @getstatus=nnnn etc…
@sendchannel_sec[:<channel>]=<y/n>Implemented in v1.10
Complimentary of @sendchat, this command prevents the user from sending messages on non-public channels. If channel is specified, it becomes an exception to the aforementioned restriction (then it is better to use rem or add instead of y or n respectively). It does not prevent the viewer automatic replies like @version=nnnn, @getstatus=nnnn etc… This particular command only accepts exceptions issued from the same object, opposed to its non-secure version which accepts exceptions from any other object.
@sendim=<y/n>Implemented in v1.0b
When prevented, everything typed in IM will be discarded and a bogus message will be sent to the receiver instead.
@sendim_sec=<y/n>Implemented in v1.21
When prevented, everything typed in IM will be discarded and a bogus message will be sent to the receiver instead. This particular command accepts exceptions issued from the same object only, opposed to the non-secure way that accepts exceptions from any object.
@sendim:<UUID>=<rem/add>Implemented in v1.01
When adding an exception, the user can send IMs to the receiver whose UUID is specified in the command. This overrides the prevention for this avatar only (there is no limit to the number of exceptions), don't forget to remove it when it becomes obsolete.
@sendimto:<UUID>=<y/n>Implemented in v2.3 and v1.25
When prevented, everything typed in IM to the specified avatar will be discarded and a bogus message will be sent instead.
@startim=<y/n>Implemented in v2.6
When prevented, the user is unable to start an IM session with anyone. Sessions that are already open are not impacted though.
@startim:<UUID>=<rem/add>Implemented in v2.6
When adding an exception, the user can start an IM session with the receiver whose UUID is specified in the command. This overrides the prevention for this avatar only (there is no limit to the number of exceptions), don't forget to remove it when it becomes obsolete.
@startimto:<UUID>=<y/n>Implemented in v2.6
When prevented, the user is unable to start an IM session with that person. Sessions that are already open are not impacted though.
@recvim=<y/n>Implemented in v1.0b
When prevented, every incoming IM will be discarded and the sender will be notified that the user cannot read them.
@recvim_sec=<y/n>Implemented in v1.21
When prevented, every incoming IM will be discarded and the sender will be notified that the user cannot read them. This particular command accepts exceptions issued from the same object only, opposed to the non-secure way that accepts exceptions from any object.
@recvim:<UUID>=<rem/add>Implemented in v1.01
When adding an exception, the user can read instant messages from the sender whose UUID is specified in the command. This overrides the prevention for this avatar only (there is no limit to the number of exceptions), don't forget to remove it when it becomes obsolete.
@recvimfrom:<UUID>=<y/n>Implemented in v2.3 and v1.25
When prevented, every IM received from the the specified avatar will be discarded and the sender will be notified that the user cannot read them.
@tplm=<y/n>Implemented in v1.0
When prevented, the user cannot use a landmark, pick or any other preset location to teleport there.
@tploc=<y/n>Implemented in v1.0
When prevented, the user cannot use teleport to a coordinate by using the map and such.
@tplure=<y/n>Implemented in v1.0
When prevented, the user automatically discards any teleport offer, and the avatar who initiated the offer is notified.
@tplure_sec=<y/n>Implemented in v1.21
When prevented, the user automatically discards any teleport offer, and the avatar who initiated the offer is notified. This particular command accepts exceptions issued from the same object only, opposed to the non-secure way that accepts exceptions from any object.
@tplure:<UUID>=<rem/add>Implemented in v1.0
When adding an exception, the user can be teleported by the avatar whose UUID is specified in the command. This overrides the prevention for this avatar only (there is no limit to the number of exceptions), don't forget to remove it when it becomes obsolete.
@sittp=<y/n>Implemented in v1.0
When limited, the avatar cannot sit on a prim unless it is closer than 1.5 m. This allows cages to be secure, preventing the avatar from warping its position through the walls (unless the prim is too close).
@standtp=<y/n>Implemented in v2.1.2 and v1.24
When this restriction is active and the avatar stands up, it is automatically teleported back to the location where it initially sat down. Please note that the last standing location is also stored when the restriction is issued, so this won't be a problem for grabbers and the like, that sit the victim, then move them inside a cell, which issues its restrictions, and then unsits them. In this case the avatar will stay in the cell.
@tpto:<X>/<Y>/<Z>=force (*)Implemented in v1.12
This command forces the avatar to teleport to the indicated coordinates. Note that these coordinates are always global, hence the script that calls this command will not be trivial. Moreso, if the destination contains a telehub or a landing point, the user will land there instead of the desired point. This is a SL limitation. Also keep in mind that @tpto is inhibited by @tploc=n, and from v1.15 and above, by @unsit too.
Here is a sample code to call that command properly :
// FORCE TELEPORT EXAMPLE // Listens on channel 4 for local coordinates and a sim name // and tells your viewer to teleport you there. // // By Marine Kelley 2008-08-26 // RLV version required : 1.12 and above // // HOW TO USE : // * Create a script inside a box // * Overwrite the contents of the script with this one // * Wear the box // * Say the destination coords Region/X/Y/Z on channel 4 : // Example : /4 Help Island Public/128/128/50 key kRequestHandle; // UUID of the dataserver request vector vLocalPos; // local position extracted from the Init () { kRequestHandle = NULL_KEY; llListen (4, "", llGetOwner (), ""); } default { state_entry () { Init (); } on_rez(integer start_param) { Init (); } listen(integer channel, string name, key id, string message) { list tokens = llParseString2List (message, ["/"], []); integer L = llGetListLength (tokens); if (L==4) { // Extract local X, Y and Z vLocalPos.x = llList2Float (tokens, 1); vLocalPos.y = llList2Float (tokens, 2); vLocalPos.z = llList2Float (tokens, 3); // Request info about the sim kRequestHandle=llRequestSimulatorData (llList2String (tokens, 0), DATA_SIM_POS); } } dataserver(key queryid, string data) { if (queryid == kRequestHandle) { // Parse the dataserver response (it is a vector cast to a string) list tokens = llParseString2List (data, ["<", ",", ">"], []); string pos_str = ""; vector global_pos; // The coordinates given by the dataserver are the ones of the // South-West corner of this sim // => offset with the specified local coordinates global_pos.x = llList2Float (tokens, 0); global_pos.y = llList2Float (tokens, 1); global_pos.z = llList2Float (tokens, 2); global_pos += vLocalPos; // Build the command pos_str = (string)((integer)global_pos.x) +"/"+(string)((integer)global_pos.y) +"/"+(string)((integer)global_pos.z); llOwnerSay ("Global position : "+(string)pos_str); // Debug purposes // Fire ! llOwnerSay ("@tpto:"+pos_str+"=force"); } } }
@accepttp[:<UUID>]=<rem/add>Implemented in v1.15, slightly improved in v1.16
Adding this rule will make the user automatically accept any teleport offer from the avatar which key is <UUID>, exactly like if that avatar was a Linden (no confirmation box, no message, no Cancel button). This rule does not supersede nor deprecate @tpto because the former teleports to someone, while the latter teleports to an arbitrary location. Attention : in v1.16 the UUID becomes optional, which means that @accepttp=add will force the user to accept teleport offers from anyone ! Use with caution !
@showinv=<y/n>Implemented in v1.10
Forces the inventory windows to close and stay closed.
@viewnote=<y/n>Implemented in v1.10
Prevents from opening notecards but does not close the ones already open.
@viewscript=<y/n>Implemented in v1.22
Prevents from opening scripts but does not close the ones already open.
@viewtexture=<y/n>Implemented in v1.22
Prevents from opening textures (and snapshots) but does not close the ones already open.
@edit=<y/n>Implemented in v1.03
When prevented from editing and opening objects, the Build & Edit window will refuse to open.
@edit:<UUID>=<rem/add>Implemented in v2.3 and v1.25
When adding an exception, the user can edit or open this object in particular.
@rez=<y/n>Implemented in v1.03
When prevented from rezzing stuff, creating and deleting objects, drag-dropping from inventory and dropping attachments will fail.
@editobj:<UUID>=<y/n>Implemented in v2.3 and v1.25
When prevented, the Build & Edit window will refuse to open when trying to edit or open the specified object.
@unsit=<y/n>Implemented in v1.10, modified in v1.15 to prevent teleporting as well
Hides the Stand up button. From v1.15 it also prevents teleporting, which was a way to stand up.
@sit:<UUID>=force (*)Implemented in v1.10
Does not work if the user is prevented from sit-tping and further than 1.5 meters away, or when prevented from unsitting.
@getsitid=<channel_number>Implemented in v1.12.4 but broken in all versions older than v1.24 and v2.2 (was reporting the UUID of the last object any avatar within draw distance sat upon)
Makes the viewer automatically answer the UUID of the object the avatar is currently sitting on, or NULL_KEY if they are not sitting.
@unsit=force (*)Implemented in v1.10
Self-explanatory but for some reason it randomly fails, so don't rely on it for now. Further testing is needed.
@sit=<y/n>Implemented in v1.16.2
Prevents the user from sitting on anything, including with @sit:<UUID>=force.
@detach=<y/n>Implemented in v1.0a
When called with the n option, the object sending this message (which must be an attachment) will be made nondetachable. It can be detached again when the y option is called.
@detach:<attach_point_name>=<y/n>Implemented in v1.20
When called with the n option, the attachment point of name <attach_point_name> will be locked either full (if it is occupied by an object at that time) or empty (if not). Any object that is occupying this point when the restriction is issued will be considered as undetachable, exactly like if it had issued a @detach=n command itself. If the point is empty it will stay that way, no item will be able to be attached there, and llAttachToAvatar() calls will fail (the object will be attached, then detached right away).
@addattach[:<attach_point_name>]=<y/n>Implemented in v1.22
When called with the n option, the attachment point of name <attach_point_name> will be locked empty. Any object that is occupying this point when the restriction is issued can be detached, but nothing can be attached there. If the point is empty it will stay that way, no item will be able to be attached there, and llAttachToAvatar() calls will fail (the object will be attached, then detached right away). If <attach_point_name> is not specified, then all the attachment points will be concerned. This command is the counterpart to @addoutfit, for attachments.
@remattach[:<attach_point_name>]=<y/n>Implemented in v1.22
When called with the n option, the attachment point of name <attach_point_name> will be locked full. Any object that is occupying this point when the restriction is issued will be rendered undetachable. If the point is empty it will allow the user to wear something, but then that object will become undetachable too, no item will be able to replace it, and llAttachToAvatar() calls will fail (the object will be attached, then detached right away). If <attach_point_name> is not specified, then all the attachment points will be concerned. This command is the counterpart to @remoutfit, for attachments.
Wear contextual menu : "@defaultwear=<y/n>Implemented in v1.21
When allowed, the user is always able to choose the Wearcommand on the contextual menu of the inventory, even when an object is locked on their avatar. This holds the risk of kicking that locked object, but it will be reattached automatically within 5 seconds (and successive locked objects every second until there is nothing left to reattach). However some objects may be scripted in a way that they drop their restrictions when detached, or simply not take into account the fact that even a locked object can be detached when using the RLV.
Therefore, using this command with the n option will suppress this comman, but it will still be available for objects that contain the target attachment point in their name or in the name of their parent folder, exactly like pre-1.21 RLV. This is a little less user-friendly but more secure when it comes to make sure no locked object may be detached accidentally.
@detach[:attachpt]=force (*) Implemented in v1.10
Where part is : chest|skull|left shoulder|right shoulder|left hand|right hand|left foot|right foot|spine| pelvis|mouth|chin|left ear|right ear|left eyeball|right eyeball|nose|r upper arm|r forearm| l upper arm|l forearm|right hip|r upper leg|r lower leg|left hip|l upper leg|l lower leg|stomach|left pec| right pec|center 2|top right|top|top left|center|bottom left|bottom|bottom right|neck|root If part is not specified, removes everything.
@remattach[:attachpt]=force (*) Implemented in v1.22
This command is an alias to @detach[:attachpt]=force (to keep things consistent).
@addoutfit[:<part>]=<y/n>Implemented in v1.10, added skin hair and eyes in v1.10.1, added physics in 2.6.1
Where part is : gloves|jacket|pants|shirt|shoes|skirt|socks|underpants|undershirt|skin|eyes|hair|shape|alpha|tattoo|physics If part is not specified, prevents from wearing anything beyond what the avatar is already wearing.
Note: Since the release of Viewer 2.0 there are two new avatar skin layers: Tattoo and Avatar Transparency Mask. The alpha and tattoo layers will only be supported by RLV compliant viewers that implement the new Viewer 2.0 features.
@remoutfit[:<part>]=<y/n> (underpants and undershirt are kept for teens)Implemented in v1.10, added skin hair and eyes in v1.10.1, added physics in 2.6.1
Where part is :
gloves|jacket|pants|shirt|shoes|skirt|socks|underpants|undershirt|skin|eyes|hair|shape|alpha|tattoo|physics
If part is not specified, prevents from removing anything in what the avatar is wearing.
Note: Since the release of Viewer 2.0 there are two new avatar skin layers: Tattoo and Avatar Transparency Mask. The alpha and tattoo layers will only be supported by RLV compliant viewers that implement the new Viewer 2.0 features.
@remoutfit[:<part>]=force (*) (teens can't be forced to remove underpants and undershirt)Implemented in v1.10
Where part is :
gloves|jacket|pants|shirt|shoes|skirt|socks|underpants|undershirt|alpha|tattoo|physics
If part is not specified, removes everything.
Note: Since the release of Viewer 2.0 there are two new avatar skin layers: Tattoo and Avatar Transparency Mask. The alpha and tattoo layers will only be supported by RLV compliant viewers that implement the new Viewer 2.0 features.
Note: skin, shape, eyes and hair cannot be removed since they are body parts (and removing any would result in an unrezzed avatar).
@getoutfit[:part]=<channel_number>Implemented in v1.10, added skin hair and eyes in v1.10.1, added physics in 2.6.1
Makes the viewer automatically answer the current occupation of clothes layers as a list of 0s (empty) and 1s (occupied) immediately on the chat channel number <channel_number> that the script can listen to. Always use a positive integer. Remember that regular viewers do not answer anything at all so remove the listener after a timeout.
The list of 0s and 1s corresponds to : gloves,jacket,pants,shirt,shoes,skirt,socks,underpants,undershirt,skin,eyes,hair,shape in that order.
If a part is specified, answers a single 0 (empty) or 1 (occupied) corresponding to the part.
@getoutfit=2222 ⇒ 0011000111 ⇒ avatar is wearing pants, shirt, underpants and undershirt, and of course a skin.@getoutfit:socks=2222 ⇒ 0 ⇒ the avatar is not wearing socks.Note: For viewers that implement the new Viewer 2.0 features, the list is:
gloves,jacket,pants,shirt,shoes,skirt,socks,underpants,undershirt,skin,eyes,hair,shape,alpha,tattoo
@getattach[:attachpt]=<channel_number>Implemented in v1.10
Makes the viewer automatically answer the current occupation of attachment points as a list of 0s (empty) and 1s (occupied) immediately on the chat channel number <channel_number> that the script can listen to. Always use a positive integer. Remember that regular viewers do not answer anything at all so remove the listener after a timeout.
The list of 0s and 1s corresponds to :
none,chest,skull,left shoulder,right shoulder,left hand,right hand,left foot,right foot,spine, pelvis,mouth,chin,left ear,right ear,left eyeball,right eyeball,nose,r upper arm,r forearm, l upper arm,l forearm,right hip,r upper leg,r lower leg,left hip,l upper leg,l lower leg,stomach,left pec, right pec,center 2,top right,top,top left,center,bottom left,bottom,bottom right,neck,root
in that order.
If an attachment point is specified, answers a single 0 (empty) or 1 (occupied) corresponding to the point.
@getattach=2222 ⇒ 011000011010000000000000100100000000101 ⇒ avatar is wearing attachments on chest, skull, left and right foot, pelvis, l and r lower leg, HUD bottom left and HUD bottom right.
@getattach:chest=2222 ⇒ 1 ⇒ avatar is wearing something on the chest.
Note : The first character (none) is always '0', so the index of each attach point in the string is exactly equal to the corresponding ATTACH_* macro in LSL. For instance, the index 9 in the string is ATTACH_BACK (which means spine). Remember the indices start at zero.
@acceptpermission=<rem/add>Implemented in v1.16
Forces the avatar to automatically accept attach and take control permission requests. The dialog box doesn't even show up. This command does not supersede @denypermission, of course.
@denypermission=<rem/add>Implemented in v1.16, DEPRECATED in v1.16.2
When prevented, all attach and take control permission requests are automatically declined, without even showing the dialog box. Due to the extreme annoyance it was making, and because locked objects automatically reattach themselves since v1.16.1, this command is NOW DEPRECATED, DON'T USE IT !
@detachme=force (*)Implemented in v1.16.2
This command forces the object that issues it to detach itself from the avatar. It is there as a convenience to avoid a race condition when calling @clear then llDetachFromAvatar(), sometimes the object could detach itself before clearing its restrictions, making it reattach automatically after a while. With this command one can issue a @clear,detachme=force to be sure @clear is executed first.
@unsharedwear=<y/n>Implemented in v2.5
When prevented, no object, piece of clothing or bodypart can be worn unless it is part of the #RLV folder (i.e. shared).
@unsharedunwear=<y/n>Implemented in v2.5
When prevented, no object, piece of clothing or bodypart can be removed from the avatar unless it is part of the #RLV folder (i.e. shared).
Implemented in v1.11, added sub-folders in v1.13
Makes the viewer automatically answer the list of folders contained into the folder named #RLV (if it exists), immediately on the chat channel number <channel_number> that the script can listen to. If folders are specified, it will give the list of sub-folders contained into the folder located at that path instead of the shared root (example : @getinv:Restraints/Leather cuffs/Arms=2222). Always use a positive integer. Remember that regular viewers do not answer anything at all so remove the listener after a timeout.
The answer is a list of names, separated by commas (,). Folders which names begin with a dot (.) will be ignored.
Implemented in v1.15
Makes the viewer automatically answer the list of folders contained into the folder named #RLV (if it exists), immediately on the chat channel number <channel_number> that the script can listen to. If folders are specified, it will give the list of sub-folders contained into the folder located at that path instead of the shared root (example : @getinvworn:Restraints/Leather cuffs/Arms=2222). Always use a positive integer. Remember that regular viewers do not answer anything at all so remove the listener after a timeout.
The answer is a comma-separated list of names, each one followed with a pipe (|) and two digits. The current folder is put in first position (as opposed to @getinv which does not show the current folder, obviously), but without a name, only the pipe and the two digits.
@getinvworn:Restraints/Leather cuffs=2222|02,Arms|30,Legs|10
Folders which names begin with a dot (.) will be ignored. The two digits are calculated as follows :
First digit : Proportion of items worn in the corresponding folder (including no-mod items). In this example, the 3 of 30 means "all the items in the "Arms" folder are currently worn, while the 1 of 10 means "no item in the Legs folder is currently worn, but there are items to wear".
Second digit : Proportion of items globally worn in all the folders contained inside the corresponding folder. In this example, the 2 of 02 means "some items are worn in some of the folders contained into Leather cuffs.
The digits, comprised between 0 and 3 included, have the following meaning :
:* 0 : No item is present in that folder :* 1 : Some items are present in that folder, but none of them is worn :* 2 : Some items are present in that folder, and some of them are worn :* 3 : Some items are present in that folder, and all of them are worn
@findfolder:part1[&&…&&partN]=<channel_number>Implemented in v1.13.1
Makes the viewer automatically answer the path to the first shared folder which name contains <part1> and <part2> and … and <partN>, immediately on the chat channel number <channel_number> that the script can listen to. The search is in depth first, notice the separator which is && like and. Always use a positive integer. Remember that regular viewers do not answer anything at all so remove the listener after a timeout. It does not take disabled folders into account (folders which name begins with a dot .), nor folders which name begins with a tilde (~). The answer is a list of folders, separated by slashes ('/').
@attach:<folder1/…/folderN>=force (*)Implemented in v1.11, added no-mod items in v1.12, added sub-folders in v1.13
Forces the viewer to attach every object and wear every piece of clothing contained inside the folder located at the specified path (which must be under #RLV). Objects names must contain the name of their target attachment point or they won't be attached. Each no-modify object must be contained inside a folder (one object per folder), which name contains the name of its target attachment point since it can't be renamed. Names cannot begin with a dot (.) since such folders are invisible to the scripts.
Attachment point names are the same as the ones contained into the "Attach To" submenu : skull, chest, l forearm…
Note 1 : Folder names can contain slashes, and will be chosen in priority when able (for instance, if @attach:Restraints/cuffs=force is issued, the Restraints/cuffs folder will be chosen before a cuffs folder contained inside a Restraints parent folder.
Note 2 : If the name of a folder begins with a plus sign (+), then this command will act exactly like @attachover. This rule can be changed through the use of the RestrainedLoveStackWhenFolderBeginsWith debug setting.
Attention : This command will likely change in the future, to revert back to how it used to behave in version 1.x, i.e. never add an object if the target attachment point is already taken, but rather replace the old object. The current behaviour is intended to be ensured by @attachoverorreplace and its derivatives. For now @attachoverorreplace is a synonym to @attach, but this won't always be the case. In other words, if you intend to make your script always replace existing attachments when attaching new ones, use @attach. If you want your script to always make attachments stack, use @attachover. If you want to give the user the choice through the name of the folder (as indicated above, by prepending the name by a + sign by default), use @attachoverorreplace.
@attachover:<folder1/…/folderN>=force (*)Implemented in v2.1.2 and v1.24
This command works exactly like @attach described hereabove, except that it won't kick objects and pieces of clothing that are already being worn.
@attachoverorreplace:<folder1/…/folderN>=force (*)Implemented in v2.5
This command works exactly like @attach described hereabove, it is a synonym.
@attachall:<folder1/…/folderN>=force (*)Implemented in v1.15
This command works exactly like @attach described hereabove, but also attaches whatever is contained into children folders.
@attachallover:<folder1/…/folderN>=force (*)Implemented in v2.1.2 and v1.24
This command works exactly like @attachall described hereabove, except that it won't kick objects and pieces of clothing that are already being worn.
@attachalloverorreplace:<folder1/…/folderN>=force (*)Implemented in v2.5
This command works exactly like @attachall described hereabove, it is a synonym.
@detach:<folder_name>=force (*)Implemented in v1.11
Forces the viewer to detach every object and unwear every piece of clothing contained inside <folder_name>(which must be directly under #RLV). If @detach is used with an attachment point name (skull, pelvis… see above), it takes priority over this way of detaching since it is the same command.
@detachall:<folder1/…/folderN>=force (*)Implemented in v1.15
This command works exactly like @detach described hereabove, but also detaches whatever is contained into children folders.
@getpath[:<attachpt> or <clothing_layer>]=<channel_number>Implemented in v1.16
Makes the viewer automatically answer the path to the shared folder containing the item that :
@getpath:spine=2222 ⇒ Restraints/Collar@getpath:pants=2222 ⇒ Casual/Jeans/Tight
Always use a positive integer. Remember that regular viewers do not answer anything at all so remove the listener after a timeout. It does not take disabled folders into account (folders which name begins with a dot .). The answer is a list of folders, separated by slashes ('/').
Please note : As version 1.40.4 is now live on the main grid, wearing several objects on the same attachment point is now possible. Therefore this command does not make much sense anymore since it can only respond with one folder, while the several objects could belong to several folders. Therefore it is better to use @getpathnew, since @getpath will slowly become deprecated as more and more users switch to 2.1 and beyond.
@getpathnew[:<attachpt> or <clothing_layer>]=<channel_number>Implemented in v2.1 and v1.24
Makes the viewer automatically answer the paths to the shared folders containing the item(s) that :
@getpathnew:spine=2222 ⇒ Restraints/Collar,Jewelry/Cute necklace@getpathnew:pants=2222 ⇒ Casual/Jeans/Tight
Always use a positive integer. Remember that regular viewers do not answer anything at all so remove the listener after a timeout. It does not take disabled folders into account (folders which name begins with a dot .). The answer is a list of folders, separated by slashes ('/'), if several paths must be returned because several outfits are concerned, they are organized in a list of strings separated by commas (',').
This command has been added to replace @getpath, since in 2.1 several objects can be worn on the same attachment point.
@attachthis[:<attachpt> or <clothing_layer>]=force (*)Implemented in v1.16
This command is a shortcut for a @getpath followed with an @attach command (this saves a listener and a timeout).
@attachthisover[:<attachpt> or <clothing_layer>]=force (*)Implemented in v2.1.2 and v1.24
This command works exactly like @attachthis described hereabove, except that it won't kick objects and pieces of clothing that are already being worn.
@attachthisoverorreplace[:<attachpt> or <clothing_layer>]=force (*)Implemented in v2.5
This command works exactly like @attachthis described hereabove, it is a synonym.
@attachallthis[:<attachpt> or <clothing_layer>]=force (*)Implemented in v1.16
This command is a shortcut for a @getpath followed with an @attachall command (this saves a listener and a timeout).
@attachallthisover[:<attachpt> or <clothing_layer>]=force (*)Implemented in v2.1.2 and v1.24
This command works exactly like @attachallthis described hereabove, except that it won't kick objects and pieces of clothing that are already being worn.
@attachallthisoverorreplace[:<attachpt> or <clothing_layer>]=force (*)Implemented in v2.5
This command works exactly like @attachallthis described hereabove, it is a synonym.
@detachthis[:<attachpt> or <clothing_layer>]=force (*)Implemented in v1.16
This command is a shortcut for a @getpath followed with a @detach command (this saves a listener and a timeout).
@detachallthis[:<attachpt> or <clothing_layer>]=force (*)Implemented in v1.16
This command is a shortcut for a @getpath followed with a @detachall command (this saves a listener and a timeout).
@detachthis[:<layer>|<attachpt>|<path_to_folder>]=<y/n>Implemented in v2.3 and v1.25
When prevented, the user is unable to remove a folder if either of these conditions is filled :
layer option is set (shirt, pants…) and the folder contains a piece of clothing that is worn on this layerattachpt option is set (l forearm, spine…) and the folder contains an attachment that is worn on this pointpath_to_folder option is set and the folder corresponds to this locationMoreso, this folder or these folders cannot be renamed, moved, deleted or modified.
@detachallthis[:<layer>|<attachpt>|<path_to_folder>]=<y/n>Implemented in v2.3 and v1.25
These commands do exactly like @detachthis, but also apply to their children folders recursively.
@attachthis:<layer>|<attachpt>|<path_to_folder>=<y/n>Implemented in v2.3 and v1.25
When prevented, the user is unable to attach a folder if either of these conditions is filled :
layer option is set (shirt, pants…) and the folder contains a piece of clothing that is meant to be worn on this layerattachpt option is set (l forearm, spine…) and the folder contains an attachment that is meant to be worn on this pointpath_to_folder option is set and the folder corresponds to this locationMoreso, this folder or these folders cannot be renamed, moved, deleted or modified.
@attachallthis[:<layer>|<attachpt>|<path_to_folder>]=<y/n>Implemented in v2.3 and v1.25
These commands do exactly like @attachthis, but also apply to their children folders recursively.
@detachthis_except:<folder>=<rem/add>Implemented in v2.5
When adding an exception, the user can remove the items contained into the indicated folder.
@detachallthis_except:<folder>=<rem/add>Implemented in v2.5
When adding an exception, the user can remove the items contained into the indicated folder, or in any of its children.
@attachthis_except:<folder>=<rem/add>Implemented in v2.5
When adding an exception, the user can wear the items contained into the indicated folder.
@attachallthis_except:<folder>=<rem/add>Implemented in v2.5
When adding an exception, the user can wear the items contained into the indicated folder, or in any of its children.
Note : These exceptions will be taken into account only for the restrictions that have been issued by the same object, you cannot put such an exception to a restriction issued by another object.
Note : The viewer checks which exception or restriction is the "closest parent" in the folders hierarchy to the folder that the user is trying to wear or remove. If the closest is an @attach[all]this_except or a @detach[all]this_except exception , then the folder can be worn or removed respectively. If the closest is an @attach[all]this or a @detach[all]this restriction, then the folder is locked, no matter how many exceptions are pointing on the folders that are parent to this one.
Example : A script issues a @attachallthis:=n restriction, preventing the whole #RLV folder and its children from being attached. It also issues a @detachallthis:=n restriction, preventing the whole #RLV folder and its children from being removed as well. Therefore the #RLV folder is now completely frozen.
However, the same object issues a @attachallthis:Jewelry/Gold=add exception, then a @detachallthis:Jewelry/Gold=add one, making the Jewelry/Gold folder available for wearing and removing. Finally, it issues a @attachallthis:Jewelry/Gold/Watch=n restriction followed by a @detachallthis:Jewelry/Gold/Watch=n restriction. As a result, the user can wear and remove only what is contained inside the Jewelry/Gold folder, except what is in Jewelry/Gold/Watch, and the rest is out of reach.
@fartouch=<y/n>Implemented in v1.11
When prevented, the avatar is unable to touch/grab objects from more than 1.5 m away, this command makes restraints more realistic since the avatar litterally has to press against the object in order to click on it.
@touchfar=<y/n>Implemented in v2.4
This command is a synonym of @fartouch
@touchall=<y/n>Implemented in v2.4
When prevented, the avatar is unable to touch/grab any object and attachment. This does not apply to HUDs.
@touchworld=<y/n>Implemented in v2.4
When prevented, the avatar is unable to touch/grab objects rezzed in-world, i.e. not attachments and HUDs.
@touchworld:<UUID>=<rem/add>Implemented in v2.5
When adding an exception, the user can touch this object in particular.
@touchthis:<UUID>=<rem/add>Implemented in v2.5
When prevented, the avatar is unable to touch/grab the object which UUID corresponds to the one specified in the command.
@touchme=<rem/add>Implemented in v2.6
When adding such an exception, the user can touch this object in particular.
@touchattach=<y/n>Implemented in v2.4
When prevented, the avatar is unable to touch attachments (theirs and other avatars'), but this does not apply to HUDs.
Implemented in v2.4
When prevented, the avatar is unable to touch their own attachments (theirs but can touch other people's), but this does not apply to HUDs.
Implemented in v2.4
When prevented, the avatar is unable to touch other people's attachments (but they can touch their owns). This does not apply to HUDs.
@showworldmap=<y/n>Implemented in v1.11
When prevented, the avatar is unable to view the world map, and it closes if it is open when the restriction becomes active.
@showminimap=<y/n>Implemented in v1.11
When prevented, the avatar is unable to view the mini map, and it closes if it is open when the restriction becomes active.
@showloc=<y/n>Implemented in v1.12
When prevented, the user is unable to know where they are : the world map is hidden, the parcel and region name on the top menubar are hidden, they can't create landmarks, nor buy the land, nor see what land they have just left after a teleport, nor see the location in the About box, and even system and object messages are obfuscated if they contain the name of the region and/or the name of the parcel. However, llOwnerSay calls are not obfuscated so radars will still work (and RL commands as well).
@shownames=<y/n>Implemented in v1.12.2, added more dummy names in v1.16
When prevented, the user is unable to see any name (including their own). The names don't show on the screen, the names on the chat are replaced by "dummy" names such as Someone, A resident, the tooltips are hidden, the pie menu is almost useless so the user can't get the profile directly etc.
@shownametags=<y/n>Implemented in v2.9
This restriction is the same as @shownames, except that it won't censor the chat with dummy names. However, avatars around will not have their names shown, the radar will be hidden, right-clicking on an avatar around will not disclose their names, and so on.
@showhovertextall=<y/n>Implemented in v1.19
When prevented, the user is unable to read any hovertext (2D text floating above some prims).
@showhovertext:<UUID>=<y/n>Implemented in v1.19
When prevented, the user is unable to read the hovertext floating above the prim which id is UUID. This is made that way so that the restriction can be issued on an object, by another one (unlike @detach which can only set this restriction on itself).
@showhovertexthud=<y/n>Implemented in v1.19
When prevented, the user is unable to read any hovertext showing over their HUD objects, but will be able to see the ones in-world.
@showhovertextworld=<y/n>Implemented in v1.19
When prevented, the user is unable to read any hovertext showing over their in-world objects, but will be able to see the ones over their HUD.
@setgroup:<group_name>=forceImplemented in v2.5
Forces the agent to change the active group, to the specified one. Of course, they must already be a member of this group. If <group_name> is none, then the agent will deactivate the current group and not show any group tag at all.
@setgroup=<y/n>Implemented in v2.5
When prevented, the user is unable to change the active group.
@getgroup=<channel_number>Implemented in v2.5
Makes the viewer automatically answer the name of the currently active group, immediately on the chat channel number <channel_number> that the script can listen to. Always use a positive integer. Remember that regular viewers do not answer anything at all so remove the listener after a timeout. The answer will simply be none if no group is active at the time. Please note that there is no way to obtain the UUID of the group, only the name.
@setdebug=<y/n>Implemented in v1.16
When prevented, the user is unable to change some viewer debug settings (Advanced > Debug Settings). As most debug settings are either useless or critical to the user's experience, a whitelist approach is taken : only a few debug settings are locked, the others are always available and untouched. At the time of this writing, the allowed debug settings are :
@setenv commands, can simulate nice effects. Note: renderresolutiondivisor is a Windlight only option (Basic Shaders must be enabled in graphics preferences) and as such, is not available in v1.19.0.5 or older viewers.@setdebug_<setting>:<value>=force (*)Implemented in v1.16
Forces the viewer to change a particular debug setting and set it to <value>. This command is actually a package of many sub-commands, that are regrouped under @setdebug_…, for instance @setdebug_avatarsex:0=force, @setdebug_renderresolutiondivisor:64=force etc.
See the list of allowed debug settings in the @setdebug command hereabove.
@getdebug_<setting>=<channel_number>Implemented in v1.16
Makes the viewer automatically answer the value of a debug setting, immediately on the chat channel number <channel_number> that the script can listen to. Always use a positive integer. Remember that regular viewers do not answer anything at all so remove the listener after a timeout. The answer is the value that has been set with the <setting> part of the matching @setdebug command, or by hand.
See the list of allowed debug settings in the @setdebug command hereabove.
@setenv=<y/n>Implemented in v1.14
When prevented, the user is unable to change the viewer environment settings (World > Environment Settings > Sunrise/Midday/Sunset/Midnight/Revert to region default/Environment editor are all locked out).
@setenv_<setting>:<value>=force (*)Implemented in v1.14
Forces the viewer to change a particular environment setting (time of day or Windlight) and set it to <value>. This command is actually a package of many sub-commands, that are regrouped under @setenv_…, for instance @setenv_daytime:0.5=force, @setenv_bluehorizonr:0.21=force etc.
This command (like any other force command) is silently discarded if the corresponding restriction has been set, here @setenv, but in this case the restriction is ignored if the change is issued from the object that has created it. In other words, a collar can restrict environment changes, yet force a change by itself, while another object could not do it until the collar lifts the restriction.
Although a range is specified for every value, no check is made in the viewer so a script can do what the UI can't do, for interesting effects. Use at your own risk, though. The ranges indicated here are merely the ones available on the sliders on the Environment Editor, for reference.
Each particular sub-command works as follows (the names are chosen to be as close to the Windlight panels of the viewer as possible) :
| @setenv_XXX:<value>=force where XXX is… | <value> range | ||
| daytime | 0.0-1.0 and <0 | ||
| preset | String | ||
| ambientr | 0.0-1.0 | ||
| ambientg | 0.0-1.0 | ||
| ambientb | 0.0-1.0 | ||
| ambienti | 0.0-1.0 | ||
| bluedensityr | 0.0-1.0 | ||
| bluedensityg | 0.0-1.0 | ||
| bluedensityb | 0.0-1.0 | ||
| bluedensityi | 0.0-1.0 | ||
| bluehorizonr | 0.0-1.0 | ||
| bluehorizong | 0.0-1.0 | ||
| bluehorizonb | 0.0-1.0 | ||
| bluehorizoni | 0.0-1.0 | ||
| cloudcolorr | 0.0-1.0 | ||
| cloudcolorg | 0.0-1.0 | ||
| cloudcolorb | 0.0-1.0 | ||
| cloudcolori | 0.0-1.0 | ||
| cloudcoverage | 0.0-1.0 | ||
| cloudx | 0.0-1.0 | ||
| cloudy | 0.0-1.0 | ||
| cloudd | 0.0-1.0 | ||
| clouddetailx | 0.0-1.0 | ||
| clouddetaily | 0.0-1.0 | ||
| clouddetaild | 0.0-1.0 | ||
| cloudscale | 0.0-1.0 | ||
| cloudscrollx | 0.0-1.0 | ||
| cloudscrolly | 0.0-1.0 | ||
| densitymultiplier | 0.0-0.9 | ||
| distancemultiplier | 0.0-100.0 | ||
| eastangle | 0.0-1.0 | ||
| hazedensity | 0.0-1.0 | ||
| hazehorizon | 0.0-1.0 | ||
| maxaltitude | 0.0-4000.0 | ||
| scenegamma | 0.0-10.0 | ||
| starbrightness | 0.0-2.0 | ||
| sunglowfocus | 0.0-0.5 | ||
| sunglowsize | 1.0-2.0 | ||
| sunmooncolorr | 0.0-1.0 | ||
| sunmooncolorg | 0.0-1.0 | ||
| sunmooncolorb | 0.0-1.0 | ||
| sunmooncolori | 0.0-1.0 | ||
| sunmoonposition | 0.0-1.0 | ||
Note: from the above settings, only the daytime one is supported by v1.19.0 (or older) viewers implementing RestrainedLove v1.14 and later. The other settings are ignored. This is because these viewers do not implement the Windlight renderer.
@getenv_<setting>=<channel_number>Implemented in v1.15
Makes the viewer automatically answer the value of an environment setting, immediately on the chat channel number <channel_number> that the script can listen to. Always use a positive integer. Remember that regular viewers do not answer anything at all so remove the listener after a timeout. The answer is the value that has been set with the <setting> part of the matching @setenv command, or by hand. See the table hereabove for a list of settings.
Note: only @getenv_daytime is supported by v1.19.0 (or older, i.e. non Windlight) viewers implementing RestrainedLove v1.15 and later.
Certain viewers use a different restriction system, based on the RestrainedLove API, which includes a number of extra commands. These extra commands are not part of the RestrainedLove API specification, but are documented here for convenience. These commands should not be relied on, as only certain viewers will be able to process them.
@touchhud[:<UUID>]=<y/n>When prevented, the avatar is unable to touch any HUDs. If sent with a UUID, the avatar is prevented from touching only the HUD indicated by the UUID.
@interact=<y/n>When prevented, the avatar is unable to touch any objects, attachments, or HUDs, cannot edit or rez, and cannot sit on objects.
@allowidle=<y/n>When prevented, the automatic activation of the Away status indicator after a period of avatar inactivity cannot be disabled. If the idle timeout duration has been set to zero, the default timeout of 30 minutes will be used.
Silently discarded if the user is prevented from doing so by the corresponding restriction. This is on purpose.
Ex : Force detach won't work if the object is undetachable. Force undress won't work if the user is prevented from undressing.
Such behaviours are global, which means they don't depend on a particular object. However, they are triggered by objects with a set UUID which can change, and several objects can add the same behaviour, which will be stored several times as the UUIDs are different.
This has a nice side effect : when wearing 2 locked devices that prevent chat, it is necessary to unlock them both to be able to chat again. But it has a nasty side effect, too : if the item changes UUID (for instance it was derezzed and rezzed again), and it doesn't allow chat beforehand, then the user will have to wait a short moment because the rule stays "orphaned" (its UUID is defunct) until the garbage collector kicks in.
Please note : Since 1.16.1 any locked object that is kicked off by any mean (llAttachToAvatar for example) will be reattached automatically by the viewer after a few seconds. This means that calling @clear on detaching will actually unlock the object, which will have to be relocked after being reattached. It is therefore not recommended anymore to call @clear on detach, as opposed to pre-1.16.1 versions.
Since v1.11, the viewer can "share" some of your items with scripts in world in order to let them force you to attach, detach and list what you have shared.
"Share" does NOT mean they will be taken by other people if they want to (some of the items may be no-transfer anyway), but only that they can force YOU to wear/unwear them at will through the use of a script YOUR restraints contain. They will remain in your inventory. In fact, this feature would be best named "Exposed folder".
To do this :
#RLV directly under My Inventory (right-click on My Inventory, select New Folder). We'll call this folder the shared root.So it would look like this :
My Inventory |- #RLV | |- cuffs | | |- left cuff (l forearm) (no copy) | | \- right cuff (r forearm) (no copy) | \- gag | \- gag (mouth) (no copy) |- Animations |- Body Parts . . .
For example : If you're owning a set of RR Straps and want to share them, just move the folder Straps BOXED under the shared root.
Either wear all the items of the folders you have just moved (one folder at a time !) or rename your items yourself, so that each item name contains the name of the target attachment point. For example : left cuff (l forearm), right ankle cuff (r lower leg). Please note that no-modify items are a bit more complex to share, because they cannot be renamed either by you or by the viewer. More on that below.
The attachment point name is the same as the one you find in the Attach To menu of your inventory, and is case insensitive (for example : chest, skull, stomach, left ear, r upper arm…). If you wear the item without renaming it first it will be renamed automatically, but only if it is in a shared folder, and does not contain any attachment point name already, and is mod. If you want to wear it on another attachment point, you'll need to rename it by hand first.
Pieces of clothing are treated exactly the same way (in fact they can even be put in the folder of a set of restraints and be worn with the same command). Shoes, for instance, are a good example of mixed outfits : some attachments and the Shoes layer. Clothes are NOT renamed automatically when worn, since their very type decides where they are to be worn (skirt, jacket, undershirt…).
HOW TO SHARE NO-MODIFY ITEMS :
As you already know, no-mod items cannot be renamed so the technique is a bit more complex. Create a sub-folder inside the outfit folder (such as cuffs in the example above), put ONE no-modify item in it. When wearing the object, you'll see the folder itself be renamed (that's why you must not put more than one object inside it). So if your outfit contains several no-mod objects, you'll need to create as many folders and put the no-mod objects in them, one in each folder.
Example with no-modify shoes :
My Inventory |- #RLV | \- shoes | |- left shoe (left foot) | | \- left shoe (no modify) (no transfer) <-- no-mod object | |- right shoe (right foot) | | \- right shoe (no modify) (no transfer) <-- no-mod object | \- shoe base (no modify) (no transfer) <-- this is not an object |- Animations |- Body Parts . . .
GOTCHAS :
@getinv command and chat messages are limited to 1023 characters. Choose wisely, and use short names. But with 9 characters per folder name average, you can expect to have about 100 folders available.Accept sub-folders given via llGiveInventoryList() into the shared folder :
Starting with RestrainedLove v1.16.2, you may give a list of items to a victim and have them stored as a sub-folder inside the #RLV folder (thus allowing you to @attach the given items later).
Issuing a llGiveInventoryList(victim_id, #RLV/~subfolder_name, list_of_stuff) command in a script makes a standard Keep/Discard/Mute dialog appear in the viewer of the victim (the avatar which key is victim_id).
Should the victim accept the offer, the list_of_stuff items are put into a new sub-folder of the #RLV folder. The name of this sub-folder is ~subfolder_name (it is the scripter's responsibility to use unique sub-folder names: if the name is the same as an existing sub-folder, two sub-folders with the same name will appear in the #RLV folder).
Note that the tilde character must be used as the first character for the name of the sub-folder (this is so that the victim can easily spot any sub-folder given to them in this way, and so that such sub-folder names appear last in the #RLV folder).
Note also that this feature may be disabled by the user, (by setting the RestrainedLoveForbidGiveToRLV debug setting to TRUE): in this case the given items are put into a folder named #RLV/~subfolder_name at the root of the inventory instead of inside the #RLV folder.
Since the user may either refuse the offer or have the feature disabled in their viewer, and since SL may take quite some time to perform the actual transfer of the objects on laggy days, you must check that the given folder is present (with @getinv), before attempting to @attach the given objects.
Here is how it works internally, for a better understanding of the gotchas you may encounter :
remoutfit), an Option (ex: shirt) and a Param (ex: force) and comes from an UUID (the unique identifier of the emitting object).force and those which Param is a number such as the channel number of a version call) and rules (those which Param is y, n, add or rem). clear is special but can be seen as a one-shot command.@versionnum = 1230001) and above) strictly negative. Using channel 0 is not allowed. Note that RestrainedLove can send a maximum of 255 characters on negative channels, while it can send up to 1023 characters on positive channels. Negative channels are useful to prevent the user from cheating, for example when asking for the @versionnum (since the user could use a non-RestrainedLove viewer and make the RestrainedLove devices believe they run within a RestrainedLove viewer by spoofing the reply to the version command on a positive channel, which they can't do on negative channels). Positive channels are best used for commands that may return large reply strings (@getpath, for example).n and add are exactly equal and are treated exactly the same way, they are just synonyms. Same goes for y and rem. The only purpose is to distinguish rules (sendchannel=n) from exceptions (sendchannel:8=add) in a script for clarity.n/add Param, and removed when receiving a y/rem Param.If UUID1 is a collar and UUID2 is a gag :
UUID1 ⇒ detach, tploc, tplm, tplure, sittp
UUID2 ⇒ detach, sendim, sendim:(keyholder)
Those two rules mean that the user cannot send IMs except to their keyholder, and cannot TP at all. Those two items are not detachable. Now if the collar sends @sendim=n, the table becomes :
UUID1 ⇒ detach, tploc, tplm, tplure, sittp, sendim
UUID2 ⇒ detach, sendim, sendim:(keyholder)
If it sends @sendim=n a second time nothing changes, as there is a check for its existence prior to adding it. If the gag is unlocked and detached, either it sends a @clear or the garbage collector kicks in so the rules linked to UUID2 disappear. However, the avatar is still unable to send IMs even to their keyholder, as the exception has disappeared as well. This is because rules linked to one object don't conflict with rules linked to another one.