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

From Second Life Wiki
Jump to navigation Jump to search
m (oops)
(It's more along the lines of notes, not spec.)
Line 25: Line 25:
}}
}}


{{#vardefine:spec|
{{#vardefine:notes|
<h3>Link Numbers</h3>
<h3>Link Numbers</h3>
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.
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.
Line 32: Line 32:


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 the avatars first.
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 the avatars first.
{{{!}} class="collapsible collapsed" style="background-color:transparent;"
<h4>Counting Prims & Avatars</h4>
{{!}} style="font-size:120%; font-weight:bold; white-space:nowrap" {{!}} Counting Prims & Avatars
There are two functions of interest when trying to find the number of prims and avatars on an object.
!
{{!}} width="100%" {{!}}
{{!}}-
{{!}} colspan="3" {{!}}There are two functions of interest when trying to find the number of prims and avatars on an object.
* <code>[[llGetNumberOfPrims]]()</code> - Returns the number of prims and seated avatars.
* <code>[[llGetNumberOfPrims]]()</code> - Returns the number of prims and seated avatars.
* <code>[[llGetObjectPrimCount]]([[llGetKey]]())</code> - Returns only the number of prims in the object.
* <code>[[llGetObjectPrimCount]]([[llGetKey]]())</code> - Returns only the number of prims in the object but will return zero for attachments.
{{!}}}
 
{{#var:spec}}
<lsl>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.
}</lsl>
{{#var:notes}}
}}
}}


Line 59: Line 60:
{{VarPair|constants_nb}}
{{VarPair|constants_nb}}
|-
|-
{{VarPair|spec}}
{{VarPair|notes}}
|}
|}
</noinclude>
</noinclude>

Revision as of 01:05, 27 December 2010

#var value
p__desc Link number (0: unlinked, 1: root prim, >1: child prims) 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 sends to the root prim in a multi-prim linked set[1]
LINK_SET -1 sends to all prims
LINK_ALL_OTHERS -2 sends to all other prims
Flag Description
LINK_ALL_CHILDREN -3 sends to all children, (everything but the root)
LINK_THIS -4 sends 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 the avatars first.

Counting Prims & Avatars

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

<lsl>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.

}</lsl>