Difference between revisions of "LlBreakLink"

From Second Life Wiki
Jump to: navigation, search
m
m (Simplifying example, the run_time_permissions state is not necessary if you grant before touching)
Line 3: Line 3:
 
{{LSL_Function|func_id=142|func_sleep=0.0|func_energy=10.0|func=llBreakLink
 
{{LSL_Function|func_id=142|func_sleep=0.0|func_energy=10.0|func=llBreakLink
 
|p1_type=integer|p1_name=linknum
 
|p1_type=integer|p1_name=linknum
|func_desc=Delinks the task with the given link number
+
|func_desc=Delinks the prim with the given link number in a linked object set
 
|func_footnote
 
|func_footnote
 
|return_text
 
|return_text
Line 13: Line 13:
 
|examples=
 
|examples=
 
<lsl>//-- requests permission to change links, then breaks the link
 
<lsl>//-- requests permission to change links, then breaks the link
//-- between the prim its in and the rest of the object, on touch.
+
//-- between the prim and the rest of the object, on touch.
 
default{
 
default{
 
   state_entry(){
 
   state_entry(){
Line 19: Line 19:
 
   }
 
   }
 
   
 
   
  run_time_permissions( integer vBitPermissions ){
 
    if (PERMISSION_CHANGE_LINKS & vBitPermissions){
 
      state sMain;
 
    }else{
 
      llResetScript();
 
    }
 
  }
 
}
 
 
state sMain{
 
 
   touch_start( integer vIntTouched ){
 
   touch_start( integer vIntTouched ){
     llBreakLink( LINK_THIS );
+
     llBreakLink( llGetLinkNumber() );
 
   }
 
   }
 
}</lsl>
 
}</lsl>

Revision as of 22:52, 9 December 2008


Summary

Function: llBreakLink( integer linknum );

Delinks the prim with the given link number in a linked object set

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

To run this function the script must request the PERMISSION_CHANGE_LINKS permission with llRequestPermissions and it must be granted by the owner.

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

Permissions
  • This function removes sitting avatars from the object, even if not sitting on the unlinked prim.
  • This function silently fails if called from a script inside an attachment.
  • This function fails if the owner does not have edit permissions on the object containing the script, the system message "Delink failed because you do not have edit permission" is received by the owner.
All Issues ~ Search JIRA for related Bugs

Examples

<lsl>//-- requests permission to change links, then breaks the link //-- between the prim and the rest of the object, on touch. default{

 state_entry(){
   llRequestPermissions( llGetOwner(), PERMISSION_CHANGE_LINKS );
 }

 touch_start( integer vIntTouched ){
   llBreakLink( llGetLinkNumber() );
 }
}</lsl>

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

Events

•  run_time_permissions Permission receiving event
•  changed CHANGED_LINK

Functions

•  llGetLinkNumber Returns the link number of the prim the script is in.
•  llGetPermissions Get the permissions granted
•  llGetPermissionsKey Get the agent who granted permissions
•  llRequestPermissions Request permissions
•  llBreakAllLinks Break all links
•  llCreateLink Link to another object

Articles

•  Script permissions

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 void llBreakLink( integer linknum );