llAvatarOnLinkSitTarget
LSL Portal | Functions | Events | Types | Operators | Constants | Flow Control | Script Library | Categorized Library | Tutorials |
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 );0.0 | Forced Delay |
10.0 | Energy |
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.
|
|
Caveats
- link needs to be either an actual link number or a link constants that equate to a single prim, such as LINK_ROOT and LINK_THIS.
- LINK_SET, LINK_ALL_CHILDREN and LINK_ALL_OTHERS will not work.
- A prim does not have a sit target unless llSitTarget/llLinkSitTarget has been called with a nonzero vector as the first argument.
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.
llGetNumberOfPrims()
- Returns the number of prims and seated avatars.llGetObjectPrimCount(llGetKey())
- Returns only the number of prims in the object but will return zero for attachments.
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.
}
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 |