llGetObjectDesc

Template:Needs Translation/LSL/de Template:Needs Translation/LSL/es Template:Needs Translation/LSL/el Template:Needs Translation/LSL/he Template:Needs Translation/LSL/nl Template:Needs Translation/LSL/hu Template:Needs Translation/LSL/no Template:Needs Translation/LSL/da Template:Needs Translation/LSL/sv Template:Needs Translation/LSL/tr Template:Needs Translation/LSL/pl Template:Needs Translation/LSL/pt Template:Needs Translation/LSL/ru Template:Needs Translation/LSL/th Template:Needs Translation/LSL/uk Template:Needs Translation/LSL/zh-Hans Template:Needs Translation/LSL/zh-Hant

/LSL

GetObjectDesc

llGetObjectDesc

Summary

Function: string llGetObjectDesc( );

0.0	Forced Delay
10.0	Energy

Returns a string containing the description of the prim the script is attached to.

To get the object's description (not the current prim's), use PRIM_DESC or OBJECT_DESC.

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.

  Important: This function does not get the description of the object's rootprim, but the description of the prim containing the script. Please use llList2String(llGetLinkPrimitiveParams(LINK_ROOT, [ PRIM_DESC ]), 0); instead.

Examples

<lsl> default {

   state_entry()
   {
   //  PUBLIC_CHANNEL has the integer value 0
       llSay(PUBLIC_CHANNEL, "This prim's description: " + llGetObjectDesc() );
   }

}

</lsl>

See Also

Functions

•	llSetObjectDesc	–	Sets the prim description.
•	llGetObjectName	–	Gets the prim name.
•	llSetObjectName	–	Sets the prim name.
•	llGetObjectDetails

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. The field is not multi-line so the newline character holds no meaning in this context.

Signature
function string llGetObjectDesc();