llGetObjectPermMask

From Second Life Wiki
Revision as of 07:48, 4 October 2007 by Ppaatt Lynagh (talk | contribs) (clarify to "an object permissions mask" from "a permissions mask")
Jump to navigation Jump to search

Summary

Function: integer llGetObjectPermMask( integer mask );
0.0 Forced Delay
10.0 Energy

Returns an integer that is the requested permission mask for the root object the task is attached to.

• integer mask

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.
MASK_COMBINED 16 Include object inventory contents when calculating perms.

Combine with other mask flags, for instance MASK_OWNER|MASK_COMBINED

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

Picking apart an object permissions mask can produce such labels as "Open/ Yes Mod/ Yes Copy/ Yes Transfer", for example:

// Float a label over an object: its name, description, and permissions.

string perms2String(integer everyonePerms, integer nextPerms)
{        
    integer PERMS_OPEN = (PERM_MODIFY | PERM_COPY | PERM_TRANSFER);

    string line = "Closed";
    if ((nextPerms & PERMS_OPEN) == PERMS_OPEN)
    {
        if (everyonePerms & PERM_COPY)
        {
            line = "Open";
        }
    }
    
    if (nextPerms & PERM_MODIFY)
    {
        line += "/ Yes Mod";
    }
    if (nextPerms & PERM_COPY)
    {
        line += "/ Yes Copy";
    }
    if (nextPerms & PERM_TRANSFER)
    {
        line += "/ Yes Transfer";
    }
    
    return line;
}

default
{
    on_rez(integer start_param)
    {
        llResetScript();
    }
    state_entry()
    {
        string name = llGetObjectName();

        string description = llGetObjectDesc();
        
        integer everyonePerms = llGetObjectPermMask(MASK_EVERYONE);
        integer nextPerms = llGetObjectPermMask(MASK_NEXT);
        string permissions = perms2String(everyonePerms, nextPerms);

        string between = "\n---\n";
        vector color = <1.0, 1.0, 1.0>; // color = <R, G, B>
        float opacity = 1.0; // opacity = alpha = 1.0 - transparency
        string lines = name + between + description + between + permissions;
                
        llSetText(lines, color, opacity);
    }
}

See Also

Functions

•  llGetInventoryPermMask

Deep Notes

Signature

function integer llGetObjectPermMask( integer mask );