This function creates an ACL entry in the Access Control List system with the specified name.

OOP Syntax Help! I don't understand this!

• Constructor: ACL(...)

Syntax

acl|false aclCreate ( string aclName )

Required Arguments

• aclName: The name of the ACL entry to add.

Returns

• acl|false: acl object

Returns the created ACL object if successful. Returns false if an ACL of the given name could not be created.

Code Examples

Example 1 Example 2 (OOP)

server

This example adds a command setaclright with which you can easily add new rights to specified access control lists.

local function setACLRight(thePlayer, commandName, aclName, rightName, access)
    -- turn the boolean string to lower case
    access = string.lower ( access )
    -- access has to be either true or false (booleans)
    if (access ~= "true" and access ~= "false") then
        -- print out error message to debug window
        return outputDebugString("Invalid access; true and false are only accepted", 1)
    end

    -- change the access to boolean
    access = access == "true"

    local ourACL = aclGet(aclName)
    -- if there is no previous ACL with this name, we need to create one
    if (not ourACL) then
        ourACL = aclCreate(aclName)
    end

    -- and finally let's set the right
    aclSetRight(ourACL, rightName, access)
    -- don't forget to save the ACL after it has been modified
    aclSave()
end
addCommandHandler("setaclright", setACLRight)

server

OOP Required

This example adds a command setaclright with which you can easily add new rights to specified access control lists.

local function setACLRight(thePlayer, commandName, aclName, rightName, access)
    -- turn the boolean string to lower case
    access = string.lower ( access )
    -- access has to be either true or false (booleans)
    if (access ~= "true" and access ~= "false") then
        -- print out error message to debug window
        return outputDebugString("Invalid access; true and false are only accepted", 1)
    end

    -- change the access to boolean
    access = access == "true"

    local ourACL = ACL.get(aclName)
    -- if there is no previous ACL with this name, we need to create one
    if (not ourACL) then
        ourACL = ACL(aclName)
    end

    -- and finally let's set the right
    ourACL:setRight(rightName, access)
    -- don't forget to save the ACL after it has been modified
    ACL.save()
end
addCommandHandler("setaclright", setACLRight)

See Also

ACL Functions

• aclCreate
• aclDestroy
• aclCreateGroup
• aclGet
• aclGetRight
• aclGetName
• aclGroupAddACL
• aclGroupAddObject
• aclDestroyGroup
• aclGetGroup
• aclGroupGetName
• aclGroupList
• aclGroupRemoveACL
• aclGroupListACL
• aclList
• aclListRights
• aclGroupListObjects
• aclGroupRemoveObject
• aclObjectGetGroups
• aclReload
• aclRemoveRight
• aclSave
• hasObjectPermissionTo
• isObjectInACLGroup
• aclSetRight

ACL Elements

• aclgroup
• acl

Reference

• Scripting Functions