Skip to content
lsl.devlsl.devLSL Dev

LlGetObjectDesc

Looking for the current API? Open the llGetObjectDesc reference →

Function notes

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

Return value notes

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

Caveats

Examples

Get this prim's description
default
{
    state_entry()
    {
    //  PUBLIC_CHANNEL has the integer value 0
        llSay(PUBLIC_CHANNEL, "This prim's description: " + llGetObjectDesc() );
    }
}
Get the root prim's description
default
{
    state_entry()
    {
    //  PUBLIC_CHANNEL has the integer value 0
        llSay(PUBLIC_CHANNEL, "Rootprim's description: "
            + llList2String(llGetLinkPrimitiveParams(LINK_ROOT, [ PRIM_DESC ]), 0));
    }
}

See also: functions

llSetObjectDesc — Sets the prim description.
llGetObjectName — Gets the prim name.
llSetObjectName — Sets the prim name.
llGetObjectDetails

See also: articles

Prim Attribute Overloading

Shared wiki helpers

The original page also injects shared parameter notes, caveats or issue information through these helpers. Their conditional MediaWiki logic is not reproduced here; inspect the preserved helper source for additional material.

Template:LSL Function/prim-desc

Original shared helper source (conditional wiki logic is not evaluated)
{{LSL Injection Test}}{{#if:

{{LSL Function/limits}}

{{#vardefine:caveats|{{#var:caveats}}
*The prim description is [[limit]]ed 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.{{Footnote|The pipe character historically has been used to separate fields in the serialized version of inventory and possibly other internal fields for prim parameters.}} 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.
}}

}}<noinclude>
{| {{Prettytable}}
|-{{Hl2}}
! #var
! value
|-
{{VarPairTable|also_articles}}
|-
{{VarPair|caveats}}
|}
{{Footnotes}}
</noinclude>
Original wiki source

Some wiki templates and tables need their original context. View this article on the Second Life Wiki. Technical wording and examples are retained from the source; historical guidance may differ from current behavior.