Difference between revisions of "Template:LSL Function/link"

From Second Life Wiki
Jump to navigation Jump to search
m
m (Replaced <source> with <syntaxhighlight> — this was being propagated to other templates and pages as well!)
 
(One intermediate revision by one other user not shown)
Line 56: Line 56:
{{#if:{{{nocaveats|}}}||{{#if:{{{noavatar|}}}|
{{#if:{{{nocaveats|}}}||{{#if:{{{noavatar|}}}|
{{#vardefine:caveats|
{{#vardefine:caveats|
*{{LSLP|{{{1|}}}}} cannot be a seated avatar.
*{{LSLP|{{{1|}}}}} cannot be a {{HoverText|seated avatar|Avatars sitting on objects are assigned link numbers. They are always greater than link numbers of prims.}}.
{{#var:caveats}}}}
{{#var:caveats}}}}
}}{{#if:{{{nogroup|}}}|
}}{{#if:{{{nogroup|}}}|
Line 79: Line 79:
* <code>[[llGetObjectPrimCount]]([[llGetKey]]())</code> - Returns only the number of [[prim|prims]] in the [[object]] but will return zero for attachments.
* <code>[[llGetObjectPrimCount]]([[llGetKey]]())</code> - Returns only the number of [[prim|prims]] in the [[object]] but will return zero for attachments.


<source lang="lsl2">integer GetPrimCount() { //always returns only the number of prims
<syntaxhighlight lang="lsl2">integer GetPrimCount() { //always returns only the number of prims
     if(llGetAttached())//Is it attached?
     if(llGetAttached())//Is it attached?
         return llGetNumberOfPrims();//returns avatars and prims but attachments can't be sat on.
         return llGetNumberOfPrims();//returns avatars and prims but attachments can't be sat on.
     return llGetObjectPrimCount(llGetKey());//returns only prims but won't work on attachments.
     return llGetObjectPrimCount(llGetKey());//returns only prims but won't work on attachments.
}</source>See [[llGetNumberOfPrims]] for more about counting prims and avatars.
}</syntaxhighlight>See [[llGetNumberOfPrims]] for more about counting prims and avatars.


<h4>Errata</h4>
<h4>Errata</h4>

Latest revision as of 05:53, 4 May 2024

#var value
p__desc Link number (0: unlinked, 1: root prim, >1: child prims and seated avatars) or a LINK_* flag
also_functions
•  llGetLinkNumber Returns the link number of the prim the script is in.
constants_nb
Flag Description
LINK_ROOT 1 refers to the root prim in a multi-prim linked set[1]
LINK_SET -1 refers to all prims
LINK_ALL_OTHERS -2 refers to all other prims
Flag Description
LINK_ALL_CHILDREN -3 refers to all children, (everything but the root)
LINK_THIS -4 refers to the prim the script is in
notes

Link Numbers

Each prim that makes up an object has an address, a link number. To access a specific prim in the object, the prim's link number must be known. In addition to prims having link numbers, avatars seated upon the object do as well.

  • If an object consists of only one prim, and there are no avatars seated upon it, the (root) prim's link number is zero.
  • However, if the object is made up of multiple prims or there is an avatar seated upon the object, the root prim's link number is one.

When an avatar sits on an object, it is added to the end of the link set and will have the largest link number. In addition to this, while an avatar is seated upon an object, the object is unable to link or unlink prims without unseating all avatars first.

Counting Prims & Avatars

There are two functions of interest when trying to find the number of prims and avatars on an object.

integer GetPrimCount() { //always returns only the number of prims
    if(llGetAttached())//Is it attached?
        return llGetNumberOfPrims();//returns avatars and prims but attachments can't be sat on.
    return llGetObjectPrimCount(llGetKey());//returns only prims but won't work on attachments.
}
See llGetNumberOfPrims for more about counting prims and avatars.

Errata

If a script located in a child prim erroneously attempts to access link 0, it will get or set the property of the linkset's root prim. This bug (BUG-5049) is preserved for broken legacy scripts.