Difference between revisions of "PRIM DESC"

From Second Life Wiki
Jump to navigation Jump to search
m
m
Line 35: Line 35:
|events
|events
|location
|location
|cat1=Prim
|cat1=PrimitiveParams/Flags
|cat2=PrimitiveParams
|cat2=PrimitiveParams/Prim
|cat3
|cat3
|cat4
|cat4
}}
}}

Revision as of 20:52, 1 July 2012

Description

Constant: integer PRIM_DESC = 28;

The integer constant PRIM_DESC has the value 28

Used to get or set the prim's description.

llSetPrimitiveParams

llSetPrimitiveParams([ PRIM_DESC, string description ]);
• string description

The same syntax applies to llSetLinkPrimitiveParams and llSetLinkPrimitiveParamsFast but with an additional prefixed link parameter in the function call.

llGetPrimitiveParams

llGetPrimitiveParams([ PRIM_DESC ]);

Returns the list [ string description ]

• string description

The same syntax applies to llGetLinkPrimitiveParams, but with an additional prefixed link parameter in the function call.

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.


Related Articles

Functions

•  llSetPrimitiveParams
•  llSetLinkPrimitiveParams
•  llSetLinkPrimitiveParamsFast
•  llGetPrimitiveParams
•  llGetLinkPrimitiveParams
•  llGetObjectDesc
•  llSetObjectDesc

Articles

•  Limits SL limits and constrictions

Deep Notes

Search JIRA for related Issues

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

integer PRIM_DESC = 28;