Difference between revisions of "LlAvatarOnLinkSitTarget"

From Second Life Wiki
Jump to: navigation, search
(Created page with "<!-- {{LSL Generic/RC|RC Magnum}} --> {{LSL_Function|func_id=?|func_sleep=0.0|func_energy=10.0 |mode=pre-release |inject-2={{LSL Function/link|link|}} |func=llAva…")
 
Line 17: Line 17:
 
|also_functions=
 
|also_functions=
 
{{LSL DefineRow||[[llAvatarOnSitTarget]]|}}
 
{{LSL DefineRow||[[llAvatarOnSitTarget]]|}}
{{LSL DefineRow||[[llSitLinkTarget]]|}}
+
{{LSL DefineRow||[[llLinkSitTarget]]|}}
 
{{LSL DefineRow||[[llGetLinkKey]]}}
 
{{LSL DefineRow||[[llGetLinkKey]]}}
 
|also_articles={{LSL DefineRow||[[CHANGED_LINK]]|}}
 
|also_articles={{LSL DefineRow||[[CHANGED_LINK]]|}}

Revision as of 11:44, 3 August 2011

Emblem-important-red.png Pre-release Documentation Warning!

This function is not available yet. This documentation was written prior to its final release so it may not match the final implementation.

Summary

Function: key llAvatarOnLinkSitTarget( integer link );

Returns a key that is the UUID of the user seated on the prim.

• integer link Link number (0: unlinked, 1: root prim, >1: child prims and seated avatars) or a LINK_* flag

If the prim lacks a sit target or there is no avatar sitting on the prim, then NULL_KEY is returned.

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

Caveats

  • A prim does not have a sit target unless llLinkSitTarget has been called with a nonzero vector as the first argument.
All Issues ~ Search JIRA for related Bugs

Examples

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. The position of an avatar on a sit target can be determined with the use of llGetObjectDetails (see llSitTarget for an example).

See Also

Events

•  changed

Functions

•  llGetLinkNumber Returns the link number of the prim the script is in.
•  llAvatarOnSitTarget
•  llLinkSitTarget
•  llGetLinkKey

Articles

•  CHANGED_LINK

Deep Notes

Search JIRA for related Issues

Footnotes

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

Signature

function key llAvatarOnLinkSitTarget( integer link );