Difference between revisions of "LlSetObjectDesc"
Jump to navigation
Jump to search
m (grammar fix) |
m (Expanded note on description tampering for data storage) |
||
| Line 47: | Line 47: | ||
{{LSL DefineRow||}} | {{LSL DefineRow||}} | ||
|notes= | |notes= | ||
* Object descriptions are often used to store data that needs to be protected from script resets (see, for example, [[Prim Attribute Overloading]]). | * Object descriptions are often used to store data that needs to be protected from script resets (see, for example, [[Prim Attribute Overloading]]). However, descriptions are not immutable and can be tampered with by users or other scripts, either intentionally or accidentally, so this method should only be considered a last resort for data storage. | ||
** [[llLinksetDataWrite]] and associated functions are generally better suited for this purpose, which allow for significantly more data storage and are much more secure against tampering | ** [[llLinksetDataWrite]] and associated functions are generally better suited for this purpose, which allow for significantly more data storage and are much more secure against tampering. | ||
|cat1=Prim | |cat1=Prim | ||
|cat2 | |cat2 | ||
Revision as of 19:08, 5 January 2023
| LSL Portal | Functions | Events | Types | Operators | Constants | Flow Control | Script Library | Categorized Library | Tutorials |
Caveats
- The prim description is limited to 127 bytes; any string longer then that will be truncated. This truncation does not always happen when the attribute is set or read.
- The pipe character '|' and the newline character '\n' are not legal in a prim's description. They will be replaced with '?'.[1]
- Note that when people have "Hover Tips on All Objects" selected in the viewer's "View" menu, they'll see the object description pop-up for any object under their mouse pointer. For that reason, it is good practice to only set human-friendly information in the description, e.g. keys and such.
- When an attached object is detached, changes made by script to the name and description (of the root prim) of the attachment will be lost. While the object is attached the name and description can be changed but it will not be reflected in inventory. This caveat does not apply to child prims.
Examples
| Set this prim's description | Set the root prim's description |
|---|---|
default
{
state_entry()
{
llSetObjectDesc("NEW PRIM DESCRIPTION");
}
}
|
default
{
state_entry()
{
llSetLinkPrimitiveParamsFast(LINK_ROOT,
[PRIM_DESC, "NEW ROOT PRIM DESCRIPTION"]);
}
}
|
Notes
- Object descriptions are often used to store data that needs to be protected from script resets (see, for example, Prim Attribute Overloading). However, descriptions are not immutable and can be tampered with by users or other scripts, either intentionally or accidentally, so this method should only be considered a last resort for data storage.
- llLinksetDataWrite and associated functions are generally better suited for this purpose, which allow for significantly more data storage and are much more secure against tampering.
See Also
Functions
| • | llGetObjectDesc | – | Gets the prim description. | |
| • | llGetObjectName | – | Gets the prim name. | |
| • | llSetObjectName | – | Sets the prim name. |
Articles
| • | Limits | – | SL limits and constrictions |
Deep Notes
Footnotes
- ^ The pipe character historically has been used to separate fields in the serialized version of inventory. The field is not multi-line so the newline character holds no meaning in this context.
Signature |
|---|
function void llSetObjectDesc( string description ); |