Difference between revisions of "LlGetInventoryPermMask"

From Second Life Wiki
Jump to navigation Jump to search
(Changed last example: corrected original logic fault and corruption by later editing. Avoid inappropriate do...while. Avoid multiple function calls in the loop where possible.)
 
(5 intermediate revisions by 4 users not shown)
Line 2: Line 2:
|inject-2={{LSL_Function/inventory|item|uuid=false}}
|inject-2={{LSL_Function/inventory|item|uuid=false}}
|func_id=289|func_sleep=0.0|func_energy=10.0
|func_id=289|func_sleep=0.0|func_energy=10.0
|func=llGetInventoryPermMask|return_type=integer
|func=llGetInventoryPermMask|return_type=integer|return_subtype=bit field
|p1_type=string|p1_name=item
|p1_type=string|p1_name=item
|p2_type=integer|p2_name=mask|p2_desc=MASK_* flag
|p2_type=integer|p2_name=category|p2_desc=MASK_* flag
|func_footnote
|func_footnote
|func_desc
|func_desc
|return_text=bitfield that is the requested permission {{LSLP|mask}} for the inventory {{LSLP|item}}{{LSLC|FixMe}}<!--this is terrible!-->
|return_text=of the requested permission {{LSLP|category}} for the inventory {{LSLP|item}}
|spec
|spec
|caveats
|caveats
|constants={{LSL Constants Perm Mask}}
|constants={{LSL Constants Perm Mask}}
|examples=
|examples=
<lsl>
<source lang="lsl2">
if ((permsYouHave & permsYouWant) == permsYouWant)
if ((permsYouHave & permsYouWant) == permsYouWant)
     llSay(PUBLIC_CHANNEL, "You have the perms you want.");
     llSay(PUBLIC_CHANNEL, "You have the perms you want.");
else
else
     llSay(PUBLIC_CHANNEL, "You don't have the perms you want.");
     llSay(PUBLIC_CHANNEL, "You don't have the perms you want.");
</lsl>
</source>
<lsl>
<source lang="lsl2">
integer ownerPerms = llGetInventoryPermMask("inventory item name goes here", MASK_OWNER);
integer ownerPerms = llGetInventoryPermMask("inventory item name goes here", MASK_OWNER);
integer copyAndModPerms = PERM_COPY | PERM_MODIFY;
integer copyAndModPerms = PERM_COPY | PERM_MODIFY;
Line 26: Line 26:
else
else
     llSay(PUBLIC_CHANNEL, "Owner does not have copy & modify perms.");
     llSay(PUBLIC_CHANNEL, "Owner does not have copy & modify perms.");
</lsl>
</source>
<lsl>
<source lang="lsl2">
string getPermsAsReadableString(integer perm)
string getPermsAsReadableString(integer perm)
{
{
Line 49: Line 49:
     else if ((perm & PERM_TRANSFER) == PERM_TRANSFER)
     else if ((perm & PERM_TRANSFER) == PERM_TRANSFER)
         output += "transfer";
         output += "transfer";
    else
        output += "none";


     //  Remember, items in Second Life must have either
     //  Remember, items in Second Life must have either
Line 54: Line 56:
     //  owner perms or perms for next owner.
     //  owner perms or perms for next owner.


     return
     return output;
        output;
}
}


Line 64: Line 65:
         string inventoryItemName = "inventory item name goes here";
         string inventoryItemName = "inventory item name goes here";


         integer basePerms = llGetInventoryPermMask(inventoryItemName MASK_BASE);
         integer basePerms     = llGetInventoryPermMask(inventoryItemName, MASK_BASE);
         integer ownerPerms = llGetInventoryPermMask(inventoryItemName MASK_OWNER);
         integer ownerPerms     = llGetInventoryPermMask(inventoryItemName, MASK_OWNER);
         integer nextOwnerPerms = llGetInventoryPermMask(inventoryItemName MASK_NEXT);
         integer nextOwnerPerms = llGetInventoryPermMask(inventoryItemName, MASK_NEXT);
         integer groupPerms = llGetInventoryPermMask(inventoryItemName MASK_GROUP);
         integer groupPerms     = llGetInventoryPermMask(inventoryItemName, MASK_GROUP);
         integer everyonePerms = llGetInventoryPermMask(inventoryItemName MASK_EVERYONE);
         integer everyonePerms = llGetInventoryPermMask(inventoryItemName, MASK_EVERYONE);


    //  PUBLIC_CHANNEL has the integer value 0
         llSay(0, "/me [" + inventoryItemName
 
         llSay(PUBLIC_CHANNEL, "/me [" + inventoryItemName
             + "]: base" + getPermsAsReadableString(basePerms));
             + "]: base" + getPermsAsReadableString(basePerms));
         llSay(PUBLIC_CHANNEL, "/me [" + inventoryItemName
         llSay(0, "/me [" + inventoryItemName
             + "]: owner" + getPermsAsReadableString(ownerPerms));
             + "]: owner" + getPermsAsReadableString(ownerPerms));
         llSay(PUBLIC_CHANNEL, "/me [" + inventoryItemName
         llSay(0, "/me [" + inventoryItemName
             + "]: next owner" + getPermsAsReadableString(nextOwnerPerms));
             + "]: next owner" + getPermsAsReadableString(nextOwnerPerms));
         llSay(PUBLIC_CHANNEL, "/me [" + inventoryItemName
         llSay(0, "/me [" + inventoryItemName
             + "]: group" + getPermsAsReadableString(groupPerms));
             + "]: group" + getPermsAsReadableString(groupPerms));
         llSay(PUBLIC_CHANNEL, "/me [" + inventoryItemName
         llSay(0, "/me [" + inventoryItemName
             + "]: everyone" + getPermsAsReadableString(everyonePerms));
             + "]: everyone" + getPermsAsReadableString(everyonePerms));
     }
     }
}
}
</lsl>
</source>
To test for the opposite (e.g. to see if something is NOT copy):
To test for the opposite (e.g. to see if something is NOT copy):
<lsl>
<source lang="lsl2">
     if (!(PERM_COPY & llGetInventoryPermMask(myitem, MASK_OWNER)))
     if (!(PERM_COPY & llGetInventoryPermMask(myitem, MASK_OWNER)))
         llSay(PUBLIC_CHANNEL, "/me [" + myitem + "]: owner doesn't have copy perms.");
         llSay(PUBLIC_CHANNEL, "/me [" + myitem + "]: owner doesn't have copy perms.");
</lsl>
</source>


To remind the next owner what permissions to set before selling on
To remind the next owner what permissions to set before selling on
choose which need to be set;
choose which need to be set;


<lsl>
<source lang="lsl2">
CheckPerms()
CheckPerms()
{         
{         
Line 123: Line 122:
     }
     }
}
}
</lsl>
</source>


One way to determine if any of several selected permissions are NOT set, is to work with inverted permissions (using ~):
<lsl>
default
{
    touch_start(integer num)
    {
string myitem;
integer ownerNonPerms;
integer CountObjects = llGetInventoryNumber(INVENTORY_OBJECT);
integer i;
while (i < CountObjects)
{
    myitem = llGetInventoryName(INVENTORY_OBJECT,i);
    ownerNonPerms = ~llGetInventoryPermMask(myitem, MASK_OWNER);  // get inverted permissions
    if ( ownerNonPerms & (PERM_COPY  | PERM_TRANSFER)  )  // if either is Non-Perm  ...
    {
        if (ownerNonPerms & PERM_COPY)
    llSay(0, myitem + " is no copy");
        if (ownerNonPerms & PERM_TRANSFER)
    llSay(0, myitem + " is no transfer");
    }
    ++i;
}
    }
}
</lsl>
|helpers
|helpers
|also_functions=
|also_functions=
{{LSL DefineRow||[[llGetObjectPermMask]]|}}
{{LSL DefineRow||[[llGetObjectPermMask]]|}}
{{LSL DefineRow||[[llGetInventoryAcquireTime]]|Returns the time the item was added to the prim's inventory}}
{{LSL DefineRow||[[llGetInventoryName]]|Returns the inventory item's name}}
{{LSL DefineRow||[[llGetInventoryName]]|Returns the inventory item's name}}
{{LSL DefineRow||[[llGetInventoryType]]|Tests to see if an inventory item exists and returns its type}}
{{LSL DefineRow||[[llGetInventoryType]]|Tests to see if an inventory item exists and returns its type}}
Line 169: Line 140:
|notes=
|notes=
* In effect, the perms for articles published on this Wiki are [[PERM_COPY]] and [[PERM_TRANSFER]] until you log in, then [[PERM_MODIFY]], [[PERM_MOVE]], [[PERM_COPY]] and [[PERM_TRANSFER]].
* In effect, the perms for articles published on this Wiki are [[PERM_COPY]] and [[PERM_TRANSFER]] until you log in, then [[PERM_MODIFY]], [[PERM_MOVE]], [[PERM_COPY]] and [[PERM_TRANSFER]].
* The perms of a newly created script are: Base = [[PERM_ALL]], Owner = [[PERM_ALL]], Next = [[PERM_MOVE]] or [[PERM_TRANSFER]], Group = 0 (none), Everyone = 0 (none). These perms are the same, no matter if the script is created in user inventory or in an object.
* The default perms of a newly created script are: Base = [[PERM_ALL]], Owner = [[PERM_ALL]], Next = [[PERM_MOVE]] or [[PERM_TRANSFER]], Group = 0 (none), Everyone = 0 (none). These perms are the same, no matter if the script is created in user inventory or in an object.
** However, an option in the ''[[Preferences window|Preferences]] > Advanced'' menu allows to set the '''Default Creation Permissions''' of all items that can be created or uploaded in-world.
|cat1=Inventory
|cat1=Inventory
|cat2=Permissions/Asset
|cat2=Permissions/Asset

Latest revision as of 09:17, 28 May 2021

Summary

Function: integer llGetInventoryPermMask( string item, integer category );

Returns a bit field (an integer) of the requested permission category for the inventory item

• string item – an item in the inventory of the prim this script is in
• 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

Caveats

  • If item is missing from the prim's inventory then an error is shouted on DEBUG_CHANNEL.
All Issues ~ Search JIRA for related Bugs

Examples

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

integer ownerPerms = llGetInventoryPermMask("inventory item name goes here", MASK_OWNER);
integer copyAndModPerms = PERM_COPY | PERM_MODIFY;

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

string getPermsAsReadableString(integer perm)
{
    integer fullPerms = PERM_COPY | PERM_MODIFY | PERM_TRANSFER;
    integer copyModPerms = PERM_COPY | PERM_MODIFY;
    integer copyTransPerms = PERM_COPY | PERM_TRANSFER;
    integer modTransPerms = PERM_MODIFY | PERM_TRANSFER;
 
    string output = " perms: ";

    if ((perm & fullPerms) == fullPerms)
        output += "full";
    else if ((perm & copyModPerms) == copyModPerms)
        output += "copy & modify";
    else if ((perm & copyTransPerms) == copyTransPerms)
        output += "copy & transfer";
    else if ((perm & modTransPerms) == modTransPerms)
        output += "modify & transfer";
    else if ((perm & PERM_COPY) == PERM_COPY)
        output += "copy";
    else if ((perm & PERM_TRANSFER) == PERM_TRANSFER)
        output += "transfer";
    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()
    {
        string inventoryItemName = "inventory item name goes here";

        integer basePerms      = llGetInventoryPermMask(inventoryItemName, MASK_BASE);
        integer ownerPerms     = llGetInventoryPermMask(inventoryItemName, MASK_OWNER);
        integer nextOwnerPerms = llGetInventoryPermMask(inventoryItemName, MASK_NEXT);
        integer groupPerms     = llGetInventoryPermMask(inventoryItemName, MASK_GROUP);
        integer everyonePerms  = llGetInventoryPermMask(inventoryItemName, MASK_EVERYONE);

        llSay(0, "/me [" + inventoryItemName
            + "]: base" + getPermsAsReadableString(basePerms));
        llSay(0, "/me [" + inventoryItemName
            + "]: owner" + getPermsAsReadableString(ownerPerms));
        llSay(0, "/me [" + inventoryItemName
            + "]: next owner" + getPermsAsReadableString(nextOwnerPerms));
        llSay(0, "/me [" + inventoryItemName
            + "]: group" + getPermsAsReadableString(groupPerms));
        llSay(0, "/me [" + inventoryItemName
            + "]: everyone" + getPermsAsReadableString(everyonePerms));
    }
}

To test for the opposite (e.g. to see if something is NOT copy): 

    if (!(PERM_COPY & llGetInventoryPermMask(myitem, MASK_OWNER)))
        llSay(PUBLIC_CHANNEL, "/me [" + myitem + "]: owner doesn't have copy perms.");

To remind the next owner what permissions to set before selling on choose which need to be set; 

CheckPerms()
{        
    string item = llGetScriptName();
    integer nextOwnerPerms = llGetInventoryPermMask(item, MASK_NEXT);

    if(PERM_COPY & nextOwnerPerms)
        llOwnerSay("Set no copy");

    if(PERM_MODIFY & nextOwnerPerms)
        llOwnerSay("Set no mod");

    if(PERM_TRANSFER & nextOwnerPerms)
        llOwnerSay("Set no transfer");
}
 
default
{
    on_rez(integer start_param)
    {
        llResetScript();
    }

    state_entry()
    {
        if(llGetOwner() != llGetInventoryCreator(llGetScriptName()))
            CheckPerms();
    }
}

Notes

  • In effect, the perms for articles published on this Wiki are PERM_COPY and PERM_TRANSFER until you log in, then PERM_MODIFY, PERM_MOVE, PERM_COPY and PERM_TRANSFER.
  • The default perms of a newly created script are: Base = PERM_ALL, Owner = PERM_ALL, Next = PERM_MOVE or PERM_TRANSFER, Group = 0 (none), Everyone = 0 (none). These perms are the same, no matter if the script is created in user inventory or in an object.
    • However, an option in the Preferences > Advanced menu allows to set the Default Creation Permissions of all items that can be created or uploaded in-world.

See Also

Functions

•  llGetObjectPermMask
•  llGetInventoryAcquireTime – Returns the time the item was added to the prim's inventory
•  llGetInventoryName – Returns the inventory item's name
•  llGetInventoryType – Tests to see if an inventory item exists and returns its type
•  llGetInventoryNumber – Returns the number of items of a specific type in inventory
•  llGetInventoryKey – Returns the inventory item's UUID (if full perm)
•  llGetInventoryCreator – Returns the inventory item's creator

Articles

•  hex

Deep Notes

Search JIRA for related Issues

Tests

•  llGetInventoryPermMask Test

Signature

function integer llGetInventoryPermMask( string item, integer category );
Retrieved from "https://wiki.secondlife.com/w/index.php?title=LlGetInventoryPermMask&oldid=1210072"