Difference between revisions of "LlSetObjectDesc"

Revision as of 03:35, 25 November 2012

Function: llSetObjectDesc( string description );


0.0	Forced Delay
10.0	Energy

Sets the prims description

• string

description

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.

Set this prim's description

Set the root prim's description

<lsl>

default {

   state_entry()
   {
       llSetObjectDesc("NEW PRIM DESCRIPTION");
   }

} </lsl>

<lsl> default {

   state_entry()
   {
       llSetLinkPrimitiveParamsFast(LINK_ROOT,
           [PRIM_DESC, "NEW ROOT PRIM DESCRIPTION"]);
   }

} </lsl>

^ 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 );

@@ Line 11: / Line 11: @@
 |constants
 |examples=
+{{{!}} class="sortable" width="100%" {{Prettytable}}
+{{!}}- {{Hl2}}
+! '''Set this prim's description'''
+! '''Set the root prim's description'''
+{{!}}-
+{{!!}}<lsl>
+default
+{
+    state_entry()
+    {
+        llSetObjectDesc("NEW PRIM DESCRIPTION");
+    }
+}
+</lsl>
+{{!!}}
 <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)
+     state_entry()
      {
-         // store owner's legacy name in the decription
+         llSetLinkPrimitiveParamsFast(LINK_ROOT,
-        // field of the prim containing the script
+            [PRIM_DESC, "NEW ROOT PRIM DESCRIPTION"]);
-        string ownerLegacyName = llKey2Name(llGetOwner());
-        llSetObjectDesc(ownerLegacyName);
      }
 }
 </lsl>
+{{!}}}
 |helpers
 |also_functions=

•	Limits	–	SL limits and constrictions
•	Prim Attribute Overloading