Difference between revisions of "Template:LSL Function/link"
Jump to navigation
Jump to search
(have to be more careful when linking, it's an ugly problem. I wish there were a command that stripped the wiki syntax and left nothing but the text.) |
m (Replaced <source> with <syntaxhighlight> — this was being propagated to other templates and pages as well!) |
||
| (11 intermediate revisions by 3 users not shown) | |||
| Line 40: | Line 40: | ||
{{#if:{{{nogroup|}}}||{{!}} {{LSL Const|LINK_ALL_CHILDREN|integer|-3|c={{{verb|refers to}}} all children, (everything but the root)}} | {{#if:{{{nogroup|}}}||{{!}} {{LSL Const|LINK_ALL_CHILDREN|integer|-3|c={{{verb|refers to}}} all children, (everything but the root)}} | ||
{{!}} {{#var:value}} | {{!}} {{#var:value}} | ||
{{!}} {{{verb|refers to}}} all children, (everything but the [[Link#Root_Prim|root]]) | {{!}} {{{verb|refers to}}} all children, (everything but the [[Link#Root_Prim|root]])}} | ||
{{!}}- | {{!}}- | ||
{{!}} {{LSL Const|LINK_THIS|integer|-4|c={{{verb|refers to}}} the prim the script is in}} | {{!}} {{LSL Const|LINK_THIS|integer|-4|c={{{verb|refers to}}} the prim the script is in}} | ||
| Line 51: | Line 51: | ||
}} | }} | ||
{{#vardefine:p_{{{1|}}}_desc|[[Link]] number ({{#if:{{{nounlinked|}}}||0: {{HoverText|unlinked|When an object is made up of only one prim, and there are no avatars seated upon it, the link number of the (root) prim is zero.}}, }}1: {{HoverText|[[Link#Root_Prim|root]] prim|When an object is made up of multiple prims or there is an avatar seated upon the object, the root prim's link number is one}}, >1: child prims and {{HoverText|seated avatars|Avatars sitting on objects are assigned link numbers. They are always greater than prim link numbers.}}) {{#if:{{{nlf|}}}||or a <code>LINK_*</code> [[flag]]}}{{{2|}}} }} | {{#vardefine:p_{{{1|}}}_desc|[[Link]] number ({{#if:{{{nounlinked|}}}||0: {{HoverText|unlinked|When an object is made up of only one prim, and there are no avatars seated upon it, the link number of the (root) prim is zero.}}, }}1: {{HoverText|[[Link#Root_Prim|root]] prim|When an object is made up of multiple prims or there is an avatar seated upon the object, the root prim's link number is one}}, >1: child prims{{#if:{{{noavatar|}}}|| and {{HoverText|seated avatars|Avatars sitting on objects are assigned link numbers. They are always greater than prim link numbers.}}}}) {{#if:{{{nlf|}}}||or a <code>LINK_*</code> [[flag]]}}{{{2|}}} }} | ||
{{#vardefine:p_{{{1|}}}_hover|Link number ({{#if:{{{nounlinked|}}}||0: unlinked, }}1: root prim, >1: child prims and seated avatars) {{#if:{{{nlf|}}}||or a LINK_* flag}}{{#if:{{{3|}}}|{{{3|}}}|{{{2|}}}}} }} | {{#vardefine:p_{{{1|}}}_hover|Link number ({{#if:{{{nounlinked|}}}||0: unlinked, }}1: root prim, >1: child prims{{#if:{{{noavatar|}}}|| and seated avatars}}) {{#if:{{{nlf|}}}||or a LINK_* flag}}{{#if:{{{3|}}}|{{{3|}}}|{{{2|}}}}} }} | ||
{{#if:{{{nocaveats|}}}||{{#if:{{{nogroup|}}}| | {{#if:{{{nocaveats|}}}||{{#if:{{{noavatar|}}}| | ||
{{#vardefine:caveats| | |||
*{{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}}}} | |||
}}{{#if:{{{nogroup|}}}| | |||
{{#vardefine:caveats| | {{#vardefine:caveats| | ||
*{{LSLP|{{{1|}}}}} needs to be either an actual [[llGetLinkNumber|link number]] or a link constants that equate to a single prim, such as [[LINK_ROOT]] and [[LINK_THIS]]. | *{{LSLP|{{{1|}}}}} needs to be either an actual [[llGetLinkNumber|link number]] or a link constants that equate to a single prim, such as [[LINK_ROOT]] and [[LINK_THIS]]. | ||
| Line 69: | Line 73: | ||
* However, if the [[object]] is made up of multiple prims or there is an avatar seated upon the [[object]], the [[Link#Root_Prim|root]] [[prim]]'s link number is one. | * However, if the [[object]] is made up of multiple prims or there is an avatar seated upon the [[object]], the [[Link#Root_Prim|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. | 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 [[llUnSit|unseating]] all avatars first. | ||
<h4>Counting Prims & Avatars</h4> | <h4>Counting Prims & Avatars</h4> | ||
There are two functions of interest when trying to find the number of prims and avatars on an object. | There are two functions of interest when trying to find the number of prims and avatars on an object. | ||
| Line 75: | 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. | ||
< | <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. | ||
}</ | }</syntaxhighlight>See [[llGetNumberOfPrims]] for more about counting prims and avatars. | ||
<h4>Errata</h4> | |||
If a script located in a [[Link#Child_Prim|child]] prim erroneously attempts to access link 0, it will get or set the property of the linkset's [[Link#Root_Prim|root]] prim. This bug ({{jira|BUG-5049}}) is preserved for broken legacy scripts. {{PBR}} | |||
{{#var:notes}} | {{#var:notes}} | ||
}} | }} | ||
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 |
| |||||||||||||||||||||||
| constants_nb |
| |||||||||||||||||||||||
| notes | Link NumbersEach 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.
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 & AvatarsThere 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.
}
ErrataIf 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. | |||||||||||||||||||||||