Difference between revisions of "LlClearLinkMedia"
m (multi-prim effects sound reasonable here.) |
m (I once forgot to document a parameter for PRIM_TYPE_* flag.) |
||
| Line 5: | Line 5: | ||
|func_id=?|func_sleep=0.0|func_energy=0.0|mode | |func_id=?|func_sleep=0.0|func_energy=0.0|mode | ||
|func=llClearLinkMedia|return_type=integer | |func=llClearLinkMedia|return_type=integer | ||
|p1_type=integer|p1_name=face| | |p1_type=integer|p1_name=link|p1_desc | ||
|p2_type=integer|p2_name=face|p2_desc | |||
|func_footnote= | |func_footnote= | ||
|func_desc=Clears (deletes) the media and all {{HoverText|params|params specified by llSetPrimMediaParams or llSetLinkMedia}} from the given '''face''' on the '''link'''ed prim(s). | |func_desc=Clears (deletes) the media and all {{HoverText|params|params specified by llSetPrimMediaParams or llSetLinkMedia}} from the given '''face''' on the '''link'''ed prim(s). | ||
Revision as of 21:53, 3 August 2011
| 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: integer llClearLinkMedia( integer link, integer face );| ? | Function ID |
| 0.0 | Forced Delay |
| 0.0 | Energy |
Clears (deletes) the media and all params from the given face on the linked prim(s).
Returns an integer that is a STATUS_* flag which details the success/failure of the operation.
| • integer | link | – | Link number (0: unlinked, 1: root prim, >1: child prims and seated avatars) or a LINK_* flag
|
|
| • integer | face | – | face number |
|
| |||||||||||||||||||||
| Success/Failure Flags | Description | ||||||
|---|---|---|---|---|---|---|---|
| STATUS_OK | 0 | Result of function call was success | |||||
| STATUS_MALFORMED_PARAMS | 1000 | Function was called with malformed parameters | |||||
| STATUS_TYPE_MISMATCH | 1001 | Argument(s) passed to function had a type mismatch | |||||
| STATUS_BOUNDS_ERROR | 1002 | Argument(s) passed to function had a bounds error | |||||
| STATUS_NOT_FOUND | 1003 | Object or other item was not found | |||||
| STATUS_NOT_SUPPORTED | 1004 | Feature not supported | |||||
| STATUS_INTERNAL_ERROR | 1999 | An internal error occurred | |||||
| STATUS_WHITELIST_FAILED | 2001 | Whitelist Failed | |||||
Caveats
- The function silently fails if its face value indicates a face that does not exist.
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.
See Also
Functions
| • | llGetLinkNumber | – | Returns the link number of the prim the script is in. | |
| • | llClearPrimMedia | |||
| • | llSetLinkMedia | |||
| • | llGetLinkMedia |