This function creates a group in the ACL. An ACL group can contain objects like players and resources. They specify who has access to the ACL's in this group.

OOP Syntax Help! I don't understand this!

• Constructor: ACLGroup(...)

Syntax

aclgroup|false aclCreateGroup ( string groupName )

Required Arguments

• groupName: The name of the group to create.

Returns

• aclgroup|false: acl group

Returns the pointer to the created aclgroup if successful. Returns false if failed.

Code Examples

Example 1 Example 2 (OOP)

server

This example adds a command addobjecttogroup with which you can easily add new objects to specified access control list groups.

local function addACLGroupObject(thePlayer, commandName, groupName, objectName)
    local ourGroup = aclGetGroup(groupName)
    -- if there is no previous group with this name, we need to create one
    if (not ourGroup) then
        ourGroup = aclCreateGroup(groupName)
    end

    -- if object name wasn't given
    if (not objectName) then
        -- print out message to chatbox
        return outputChatBox("You need to specify the object!", thePlayer)
    end

    -- and finally let's add the object to it's group
    aclGroupAddObject(ourGroup, objectName)
    -- don't forget to save the ACL after it has been modified
    aclSave()
end
addCommandHandler("addobjecttogroup", addACLGroupObject)

server

OOP Required

This example adds a command addobjecttogroup with which you can easily add new objects to specified access control list groups.

local function addACLGroupObject(thePlayer, commandName, groupName, objectName)
    local ourGroup = ACLGroup.get(groupName)
    -- if there is no previous group with this name, we need to create one
    if (not ourGroup) then
        ourGroup = ACLGroup(groupName)
    end

    -- if object name wasn't given
    if (not objectName) then
        -- print out message to chatbox
        return thePlayer:outputChat("You need to specify the object!")
    end

    -- and finally let's add the object to it's group
    ourGroup:addObject(objectName)
    -- don't forget to save the ACL after it has been modified
    ACL.save()
end
addCommandHandler("addobjecttogroup", addACLGroupObject)

See Also

ACL Functions

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

ACL Elements

• acl
• aclgroup

Reference

• Scripting Functions