Difference between revisions of "LlGetObjectPermMask"

From Second Life Wiki
Jump to navigation Jump to search
(add first example - promptly complain any time the SL GUI restricts copying differently than you wish)
 
(24 intermediate revisions by 8 users not shown)
Line 2: Line 2:
|func_id=287|func_sleep=0.0|func_energy=10.0
|func_id=287|func_sleep=0.0|func_energy=10.0
|func=llGetObjectPermMask
|func=llGetObjectPermMask
|return_type=integer|p1_type=integer|p1_name=mask
|return_type=integer|return_subtype=bit field
|p1_type=integer|p1_name=category|p1_desc=MASK_* flag
|func_footnote
|func_footnote
|func_desc
|func_desc
|return_text=that is the requested permission '''mask''' for the root object the task is attached to.
|return_text=of the requested permission {{LSLP|category}} for the object containing this script.
|spec
|spec
|caveats
|caveats
|constants={{LSL Constants Perm Mask}}
|constants={{LSL Constants Perm Mask}}
|examples=
|examples=
Promptly complain any time the SL GUI restricts copying differently than you wish.
<source lang="lsl2">
<pre>
if ((permsYouHave & permsYouWant) == permsYouWant)
// Remember the last perms described.
    llSay(0, "You have the perms you want.");
else
    llSay(0, "You don't have the perms you want.");
</source>
<source lang="lsl2">
integer ownerPerms = llGetObjectPermMask(MASK_OWNER);
integer copyAndModPerms = PERM_COPY | PERM_MODIFY;


integer everyonePerms;
if ((ownerPerms & copyAndModPerms) == copyAndModPerms)
integer nextPerms;
    llSay(0, "Owner has copy & modify perms.");
integer troubles;
else
    llSay(0, "Owner does not have copy & modify perms.");
</source>
<source lang="lsl2">
string getPermsAsReadableString(integer perm)
{
    integer allPerms = PERM_ALL;
    integer fullPerms = PERM_COPY | PERM_MODIFY | PERM_TRANSFER;


fetchPerms()
    integer copyModMovePerms = PERM_COPY | PERM_MODIFY | PERM_MOVE;
{
    integer copyModPerms = PERM_COPY | PERM_MODIFY;
     everyonePerms = llGetObjectPermMask(MASK_EVERYONE);
 
     nextPerms = llGetObjectPermMask(MASK_NEXT);
     integer copyTransMovePerms = PERM_COPY | PERM_TRANSFER | PERM_MOVE;
}
     integer copyTransPerms = PERM_COPY | PERM_TRANSFER;
 
    integer modTransMovePerms = PERM_MODIFY | PERM_TRANSFER | PERM_MOVE;
    integer modTransPerms = PERM_MODIFY | PERM_TRANSFER;
 
    integer copyMovePerms = PERM_COPY | PERM_MOVE;
 
    integer transMovePerms = PERM_TRANSFER | PERM_MOVE;


// Describe the perms.
    string output = " perms: ";


permsShouldBe()
    if ((perm & allPerms) == allPerms)
{
         output += "full and move";
        integer wasTroubles = troubles;
    else if ((perm & fullPerms) == fullPerms)
         troubles = 0;
         output += "full";
       
    else if ((perm & copyModMovePerms) == copyModMovePerms)
        if (!(everyonePerms & PERM_COPY))
        output += "copy & modify & move";
         {
    else if ((perm & copyModPerms) == copyModPerms)
            llOwnerSay("No = Allow anyone to copy " + llGetObjectName());
         output += "copy & modify";
            troubles += 1;
    else if ((perm & copyTransMovePerms) == copyTransMovePerms)
        }
        output += "copy & transfer & move";
       
    else if ((perm & copyTransPerms) == copyTransPerms)
        if (!(nextPerms & PERM_MODIFY))
         output += "copy & transfer";
         {
    else if ((perm & modTransMovePerms) == modTransMovePerms)
            llOwnerSay("No = Next owner can modify " + llGetObjectName());
        output += "modify & transfer & move";
            troubles += 1;
    else if ((perm & modTransPerms) == modTransPerms)
        }
         output += "modify & transfer";
        if (!(nextPerms & PERM_COPY))
    else if ((perm & copyMovePerms) == copyMovePerms)
         {
        output += "copy & move";
            llOwnerSay("No = Next owner can copy " + llGetObjectName());
    else if ((perm & PERM_COPY) == PERM_COPY)
            troubles += 1;
         output += "copy";
        }
    else if ((perm & transMovePerms) == transMovePerms)
        if (!(nextPerms & PERM_TRANSFER))
         output += "transfer & move";
         {
    else if ((perm & PERM_TRANSFER) == PERM_TRANSFER)
            llOwnerSay("No = Next owner can resell/ give away " + llGetObjectName());
         output += "transfer";
            troubles += 1;
    else if ((perm & PERM_MOVE) == PERM_MOVE)
        }
         output += "move";
          
    else
        if (wasTroubles && !troubles)
         output += "none";
         {
            llOwnerSay("Open / Yes Mod/ Yes Copy/ Yes Transfer");
        }
          
        if (wasTroubles || troubles)
         {
            llOwnerSay("");
         }
}


// Describe the perms when rezzed or reset, and when the perms change.
    // Remember, items in Second Life must have either
    //  PERM_COPY or PERM_TRANSFER when "talking about"
    //  owner perms or perms for next owner.


    return
        output;
}
default
default
{
{
    on_rez(integer start_param)
    {
        llResetScript();
    }
     state_entry()
     state_entry()
     {
     {
         fetchPerms();
         integer basePerms      = llGetObjectPermMask(MASK_BASE);
         permsShouldBe();
         integer ownerPerms    = llGetObjectPermMask(MASK_OWNER);
         llSetTimerEvent(1.0); // 1.0 = once per second
         integer nextOwnerPerms = llGetObjectPermMask(MASK_NEXT);
     }
        integer groupPerms     = llGetObjectPermMask(MASK_GROUP);
    timer()
         integer everyonePerms  = llGetObjectPermMask(MASK_EVERYONE);
    {
 
         integer wasEveryonePerms = everyonePerms;      
         llSay(0, "base"      + getPermsAsReadableString(basePerms));
        integer wasNextPerms = nextPerms;       
         llSay(0, "owner"      + getPermsAsReadableString(ownerPerms));
         fetchPerms();
         llSay(0, "next owner" + getPermsAsReadableString(nextOwnerPerms));
         if (everyonePerms != wasEveryonePerms)
         llSay(0, "group"      + getPermsAsReadableString(groupPerms));
         {
         llSay(0, "everyone"  + getPermsAsReadableString(everyonePerms));
            permsShouldBe();
         }
        else if (nextPerms != wasNextPerms)
         {
            permsShouldBe();
        }
     }
     }
}
}
</pre>
</source>
<source lang="lsl2">
integer isLocked()
{
    return !(llGetObjectPermMask(MASK_OWNER) & PERM_MOVE);
}
</source>
 
|helpers
|helpers
|also_functions={{LSL DefineRow||{{LSLG|llGetInventoryPermMask}}|}}
|also_functions={{LSL DefineRow||[[llGetInventoryPermMask]]|}}
|also_events
|also_events
|also_tests
|also_tests=
|also_articles
{{LSL DefineRow||[[llGetObjectPermMask_Test]]}}
|notes
|also_articles=
{{LSL DefineRow||[[hex]]}}
|notes=
The perms of a newly created object are often:
  Base = PERM_ALL
  Owner = PERM_ALL
  Next = PERM_MOVE or PERM_TRANSFER
  Group = 0 (none)
  Everyone = 0 (none)
|cat1=Permissions/Asset
|cat1=Permissions/Asset
|cat2=Object
|cat2=Object

Latest revision as of 10:58, 18 March 2018

Summary

Function: integer llGetObjectPermMask( integer category );

Returns a bit field (an integer) of the requested permission category for the object containing this script.

• integer category – MASK_* flag

Category Description
MASK_BASE 0 The base permissions.
MASK_OWNER 1 Current owner permissions.
MASK_GROUP 2 Active group permissions.
MASK_EVERYONE 3 Permissions everyone has.
MASK_NEXT 4 Permissions the next owner will have.
Permissions Value Description
PERM_ALL 0x7FFFFFFF Move/Modify/Copy/Transfer permissions
PERM_COPY 0x00008000 Copy permission
PERM_MODIFY 0x00004000 Modify permission
PERM_MOVE 0x00080000 Move permission
PERM_TRANSFER 0x00002000 Transfer permission

Examples

if ((permsYouHave & permsYouWant) == permsYouWant)
    llSay(0, "You have the perms you want.");
else
    llSay(0, "You don't have the perms you want.");

integer ownerPerms = llGetObjectPermMask(MASK_OWNER);
integer copyAndModPerms = PERM_COPY | PERM_MODIFY;

if ((ownerPerms & copyAndModPerms) == copyAndModPerms)
    llSay(0, "Owner has copy & modify perms.");
else
    llSay(0, "Owner does not have copy & modify perms.");

string getPermsAsReadableString(integer perm)
{
    integer allPerms = PERM_ALL;
    integer fullPerms = PERM_COPY | PERM_MODIFY | PERM_TRANSFER;

    integer copyModMovePerms = PERM_COPY | PERM_MODIFY | PERM_MOVE;
    integer copyModPerms = PERM_COPY | PERM_MODIFY;

    integer copyTransMovePerms = PERM_COPY | PERM_TRANSFER | PERM_MOVE;
    integer copyTransPerms = PERM_COPY | PERM_TRANSFER;

    integer modTransMovePerms = PERM_MODIFY | PERM_TRANSFER | PERM_MOVE;
    integer modTransPerms = PERM_MODIFY | PERM_TRANSFER;

    integer copyMovePerms = PERM_COPY | PERM_MOVE;

    integer transMovePerms = PERM_TRANSFER | PERM_MOVE;

    string output = " perms: ";

    if ((perm & allPerms) == allPerms)
        output += "full and move";
    else if ((perm & fullPerms) == fullPerms)
        output += "full";
    else if ((perm & copyModMovePerms) == copyModMovePerms)
        output += "copy & modify & move";
    else if ((perm & copyModPerms) == copyModPerms)
        output += "copy & modify";
    else if ((perm & copyTransMovePerms) == copyTransMovePerms)
        output += "copy & transfer & move";
    else if ((perm & copyTransPerms) == copyTransPerms)
        output += "copy & transfer";
    else if ((perm & modTransMovePerms) == modTransMovePerms)
        output += "modify & transfer & move";
    else if ((perm & modTransPerms) == modTransPerms)
        output += "modify & transfer";
    else if ((perm & copyMovePerms) == copyMovePerms)
        output += "copy & move";
    else if ((perm & PERM_COPY) == PERM_COPY)
        output += "copy";
    else if ((perm & transMovePerms) == transMovePerms)
        output += "transfer & move";
    else if ((perm & PERM_TRANSFER) == PERM_TRANSFER)
        output += "transfer";
    else if ((perm & PERM_MOVE) == PERM_MOVE)
        output += "move";
    else
        output += "none";

    //  Remember, items in Second Life must have either
    //  PERM_COPY or PERM_TRANSFER when "talking about"
    //  owner perms or perms for next owner.

    return
        output;
}
default
{
    state_entry()
    {
        integer basePerms      = llGetObjectPermMask(MASK_BASE);
        integer ownerPerms     = llGetObjectPermMask(MASK_OWNER);
        integer nextOwnerPerms = llGetObjectPermMask(MASK_NEXT);
        integer groupPerms     = llGetObjectPermMask(MASK_GROUP);
        integer everyonePerms  = llGetObjectPermMask(MASK_EVERYONE);

        llSay(0, "base"       + getPermsAsReadableString(basePerms));
        llSay(0, "owner"      + getPermsAsReadableString(ownerPerms));
        llSay(0, "next owner" + getPermsAsReadableString(nextOwnerPerms));
        llSay(0, "group"      + getPermsAsReadableString(groupPerms));
        llSay(0, "everyone"   + getPermsAsReadableString(everyonePerms));
    }
}

integer isLocked()
{
    return !(llGetObjectPermMask(MASK_OWNER) & PERM_MOVE);
}

Notes

The perms of a newly created object are often: 

 Base = PERM_ALL
 Owner = PERM_ALL
 Next = PERM_MOVE or PERM_TRANSFER
 Group = 0 (none)
 Everyone = 0 (none)

See Also

Functions

•  llGetInventoryPermMask

Articles

•  hex

Deep Notes

Search JIRA for related Issues

Tests

•  llGetObjectPermMask_Test

Signature

function integer llGetObjectPermMask( integer category );
Retrieved from "https://wiki.secondlife.com/w/index.php?title=LlGetObjectPermMask&oldid=1206811"