llSetObjectDesc

From Second Life Wiki
Revision as of 12:00, 24 September 2012 by Kireji Haiku (talk | contribs) (added reference to llSetLinkPrimitiveParamsFast(LINK_ROOT, [PRIM_DESC, string desc]); in comment of example script)
Jump to navigation Jump to search

Summary

Function: llSetObjectDesc( string description );
0.0 Forced Delay
10.0 Energy

Sets the prims description

• string description

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 prim description may only contain printable ASCII characters (code points 32-126), except the pipe character '|', which is not permitted for historical reasons.[1] All other characters will be replaced with one '?' character per illegal UTF-8 byte.
  • 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

<lsl> // WARNING: // // llSetObjectDesc(string desc); sets the description of the prim containing the script. // // to set the description of a linkset's root prim use // llSetLinkPrimitiveParamsFast(LINK_ROOT, [PRIM_DESC, string desc]); instead

default {

   touch_start(integer total_number)
   {
       // store owner's legacy name in the decription
       // field of the prim containing the script
       string ownerLegacyName = llKey2Name(llGetOwner());
       llSetObjectDesc(ownerLegacyName);
   }

}

</lsl>

See Also

Functions

•  llGetObjectDesc Gets the prim description.
•  llGetObjectName Gets the prim name.
•  llSetObjectName Sets the prim name.

Articles

•  Limits SL limits and constrictions
•  Prim Attribute Overloading

Deep Notes

Footnotes

  1. ^ The pipe character historically has been used to separate fields in the serialized version of inventory and possibly other internal fields for prim parameters.

Signature

function void llSetObjectDesc( string description );