Difference between revisions of "LlGetLinkKey"

From Second Life Wiki
Jump to navigation Jump to search
m
m
(19 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{LSL_Function/link|linknum}}
{{LSL_Function
{{LSL_Function
|inject-2={{Issues/SVC-600}}{{LSL_Function/link|link|nogroup=*}}
|func_id=144|func_sleep=0.0|func_energy=10.0
|func_id=144|func_sleep=0.0|func_energy=10.0
|func=llGetLinkKey
|func=llGetLinkKey
|return_type=key|p1_type=integer|p1_name=linknum
|return_type=key
|p1_type=integer|p1_subtype=link|p1_name=link
|func_footnote
|func_footnote
|func_desc
|func_desc
|return_text=which is the key of the prim that is link number '''linknum''' in the current link set.
|Return_text=of the [[link]]ed prim {{LSLP|link}}
|spec
|spec
|caveats=*Do provide a non-negative '''linknum''' between 0 and [[llGetNumberOfPrims]] inclusive, such as [[LINK_ROOT]].
|caveats
* Don't provide [[LINK_THIS]] as the linknum, instead call [[llGetKey]], per bug [[#SVC-600|SVC-600]].
* Don't nonsensically provide a linknum that may refer to multiple prims, such as [[LINK_SET]], [[LINK_ALL_OTHERS]], or [[LINK_ALL_CHILDREN]].
|constants
|constants
|examples=Drag this script on to linked and unlinked prims, with avatars sitting or not, to see how llGetLinkKey relates to [[llGetKey]], [[llGetLinkNumber]], [[llGetNumberOfPrims]], [[LINK_ROOT]], etc.
|examples=Drag this script on to linked and unlinked prims, with avatars sitting or not, to see how llGetLinkKey relates to [[llGetKey]], [[llGetLinkNumber]], [[llGetNumberOfPrims]], [[LINK_ROOT]], etc.
<lsl>// Return the name of a link num else the empty string.
<source lang="lsl2">// Return the name of a link num else the empty string.
 
string getLinkNumName(integer link)
string getLinkNumName(integer link)
{
{
Line 26: Line 24:


// Say the key of each linked prim.
// Say the key of each linked prim.
default
default
{
{
Line 73: Line 70:
         llOwnerSay("OK");
         llOwnerSay("OK");
     }
     }
}</lsl>
}</source>
|helpers
|helpers
|also_functions={{LSL DefineRow||[[llGetKey]]|}}
|also_functions={{LSL DefineRow||[[llGetKey]]|}}
Line 82: Line 79:
|notes
|notes
|history
|history
|bugs=
|issues
{{Bug|SVC-600|[[llGetLinkKey]] returns the wrong result when passed [[LINK_THIS]]}}
|cat1=Key
|cat1=Key
|cat2
|cat2=Link/Get
|cat3
|cat3
|cat4
|cat4
}}
}}

Revision as of 02:03, 22 January 2015

Summary

Function: key llGetLinkKey( integer link );

Returns the key of the linked prim link

• integer link Link number (0: unlinked, 1: root prim, >1: child prims and seated avatars) or a LINK_* flag
Flag Description
LINK_ROOT 1 refers to the root prim in a multi-prim linked set[1]
Flag Description
LINK_THIS -4 refers to the prim the script is in

Caveats

All Issues ~ Search JIRA for related Bugs

Examples

Drag this script on to linked and unlinked prims, with avatars sitting or not, to see how llGetLinkKey relates to llGetKey, llGetLinkNumber, llGetNumberOfPrims, LINK_ROOT, etc.

// Return the name of a link num else the empty string.
string getLinkNumName(integer link)
{
    if (LINK_THIS == link) return "LINK_THIS";
    if (LINK_ALL_CHILDREN == link) return "LINK_ALL_CHILDREN";
    if (LINK_ALL_OTHERS == link) return "LINK_ALL_OTHERS";
    if (LINK_SET == link) return "LINK_SET";
    if (LINK_ROOT == link) return "LINK_ROOT";
    return "";
}

// Say the key of each linked prim.
default
{
    state_entry()
    {
        integer theLink = llGetLinkNumber();
        
        key theLinkKey = llGetKey();
        key owner = llGetOwner();
        key creator = llGetCreator();
        
        // Visit each link num.
        
        integer link;
        integer primmed = llGetNumberOfPrims();
        for (link = -5; link <= (primmed + 5); ++link)
        {
            key linkKey = llGetLinkKey(link);
            
            // Detail the key at the link num.
            
            string line = (string) linkKey; // large constant width
            
            if (linkKey == owner) line += " llGetOwner";
            if (linkKey == creator) line += " llGetCreator";
            if (linkKey == theLinkKey) line += " llGetKey";
            
            // Detail the link num.
            
            line += " @ " + (string) link;
            line += " " + getLinkNumName(link);
            if (link == theLink) line += " llGetLinkNumber";
            if (link == primmed) line += " llGetNumberOfPrims";
            
            // Say the detail if fun.
            
            if (linkKey != NULL_KEY)
            {
                llOwnerSay(line);
            }
        }
        
        // Always count the linked prims.
        
        llOwnerSay((string) primmed + " llGetNumberOfPrims");
        llOwnerSay("OK");
    }
}

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.

See Also

Functions

•  llGetLinkNumber Returns the link number of the prim the script is in.
•  llGetKey
•  llGetLinkName

Deep Notes

All Issues

~ Search JIRA for related Issues
   llGetLinkKey returns the wrong result when passed LINK_THIS

Footnotes

  1. ^ LINK_ROOT does not work on single prim objects. Unless there is an avatar sitting on the object.

Signature

function key llGetLinkKey( integer link );