Difference between revisions of "LlRequestPermissions"

From Second Life Wiki
Jump to navigation Jump to search
m (grammar/spelling fix)
Line 5: Line 5:
|p2_type=integer|p2_name=perm|p2_desc=Permission mask (bitfield containing the permissions to request).
|p2_type=integer|p2_name=perm|p2_desc=Permission mask (bitfield containing the permissions to request).
|func_desc=Ask agent for permission to run certain classes of functions.
|func_desc=Ask agent for permission to run certain classes of functions.
|func_footer
|func_footer=Script execution continues without waiting for a response. When a response is given, a [[run_time_permissions]] event is put in the event queue.
|return_text
|return_text
|spec
|spec
|caveats=
|caveats=
<div>
<div>
*Permissions do not accumulate.
* Permissions do not accumulate.
**If a permission was requested with a previous call to this function and granted, then in subsequent call was not requested, that permission is released (lost).
** If a permission was requested with a previous call to this function and granted, then in subsequent call was not requested, that permission is released (lost).
**To request two (or more) different permissions at the same time you can using the bitwise OR <nowiki>(|):</nowiki> <lsl>llRequestPermissions(AvatarID, PERMISSION_TAKE_CONTROLS | PERMISSION_TRIGGER_ANIMATION)</lsl></div>
** To request two (or more) different permissions at the same time you can using the bitwise OR <nowiki>(|):</nowiki> <lsl>llRequestPermissions(AvatarID, PERMISSION_TAKE_CONTROLS | PERMISSION_TRIGGER_ANIMATION)</lsl></div>
*Scripts may hold permissions for only one agent at a time. To hold permissions for multiple agents you must use more than one script.
* Scripts may hold permissions for only one agent at a time. To hold permissions for multiple agents you must use more than one script.
* The result of granting permissions effects the return of [[llGetPermissions]] and [[llGetPermissionsKey]] immediately despite the [[run_time_permissions]] event being queued or bounced from the queue if it is full.
* Permission request dialogs never time out.
** If a script makes two permission requests, which ever response is last is considered the granted permissions.
|examples=Request permission to animate an avatar
|examples=Request permission to animate an avatar
<lsl>default
<lsl>default

Revision as of 23:20, 3 September 2008

Summary

Function: llRequestPermissions( key agent, integer perm );
0.0 Forced Delay
10.0 Energy

Ask agent for permission to run certain classes of functions.

• key agent avatar UUID that is in the same region
• integer perm Permission mask (bitfield containing the permissions to request).

Script execution continues without waiting for a response. When a response is given, a run_time_permissions event is put in the event queue.

Constants Action Category Granter Automatically granted when…
PERMISSION_DEBIT 0x2 take money from agent's account Money Owner
PERMISSION_TAKE_CONTROLS 0x4 take agent's controls Control Anyone sat on, attached
PERMISSION_TRIGGER_ANIMATION 0x10 start or stop Animations on agent Animation Anyone sat on, attached
PERMISSION_ATTACH 0x20 attach/detach from agent Attachment Owner or Anyone attached
PERMISSION_CHANGE_LINKS 0x80 change links Link Owner
PERMISSION_TRACK_CAMERA 0x400 track the agent's camera position and rotation Camera Anyone sat on, attached
PERMISSION_CONTROL_CAMERA 0x800 control the agent's camera
(must be sat on or attached; automatically revoked on stand or detach)
Camera Anyone sat on, attached
PERMISSION_TELEPORT 0x1000 teleport the agent Teleport Anyone[1]
PERMISSION_SILENT_ESTATE_MANAGEMENT 0x4000 manage estate access without notifying the owner of changes Estate Owner
PERMISSION_OVERRIDE_ANIMATIONS 0x8000 configure the overriding of default animations on agent Animation Anyone attached
PERMISSION_RETURN_OBJECTS 0x10000 Used by llReturnObjectsByOwner and llReturnObjectsByID to return objects from parcels Cleanup Owner, Group Owner

Caveats

  • Permissions do not accumulate.
    • If a permission was requested with a previous call to this function and granted, then in subsequent call was not requested, that permission is released (lost).
    • To request two (or more) different permissions at the same time you can using the bitwise OR (|): <lsl>llRequestPermissions(AvatarID, PERMISSION_TAKE_CONTROLS

Examples

Request permission to animate an avatar <lsl>default {

   touch_start(integer detected)
   {
       llRequestPermissions(llDetectedKey(0), PERMISSION_TRIGGER_ANIMATION);
   }
   run_time_permissions(integer perm)
   {
       if (perm & PERMISSION_TRIGGER_ANIMATION)
       {
           llStartAnimation("sit");
           llOwnerSay("animation will end in 5 seconds");
           llSetTimerEvent(5.0);
       }
   }
   timer()
   {
       llSetTimerEvent(0.0);
       llStopAnimation("sit");
   }

}</lsl>

To request two (or more) different permissions at the same time you can using the bitwise OR (|) or precompute the value.

<lsl>llRequestPermissions(AvatarID, PERMISSION_TAKE_CONTROLS

Notes

A dialog is presented to the agent to grant these permissions except for a few cases:

  • If agent is sitting on object - Control and Camera tracking permissions are granted without notification upon request.
  • If object is attached to agent - Control, Attach, and Animate permissions are granted without notification upon request so long as the script is in the root prim. If the script is not in the root prim, the user will see the confirmation dialog.
  • Permissions can persist across state changes - You do not need to request permissions in the state_entry() of each state in your script.

Regardless if a dialog is displayed you should always use the run_time_permissions event instead of depending upon this quirk.

See Also

Events

•  run_time_permissions Permission receiver event

Functions

•  llGetPermissions Get the permissions granted
•  llGetPermissionsKey Get the avatar who granted permissions.

Articles

•  Script permissions

Deep Notes

Footnotes

Signature

function void llRequestPermissions( key agent, integer perm );