This function is used to get the ACL group with the given name. If you need most of the groups you should consider using aclGroupList instead to get a table containing them all.

OOP Syntax Help! I don't understand this!

• Method:ACLGroup.get(...)

Syntax

aclgroup|false aclGetGroup ( string groupName )

Required Arguments

• groupName: The name to get the ACL group from.

Returns

• aclgroup|false: acl group

Returns the aclgroup if it could be found. Returns false/nil if it did not exist or failed for some reason.

Code Examples

Example 1 Example 2 (OOP) Example 3 Example 4 (OOP)

server

This example makes every player able to use a command named giveAccountAdminRights that will add a specific accountname as an ACL object to the Admin group.

local function giveAdminRights(playerSource, commandName, accountName) -- add the function giveAdminRights and specify its arguments
    if (accountName) then -- if there was an accountName entered then
        aclGroupAddObject(aclGetGroup("Admin"), "user." .. accountName) -- add an ACL object using the form "user.[accountName]" to the ACL group "Admin"
        outputChatBox("Account '" .. accountName .."' succesfully added to the admin group", playerSource) -- output a notification to the player who entered the command that the acocunt was successfully added
    else -- else output an error message and the correct syntax of the command to the player who entered it
        outputChatBox("No account name specified.", playerSource)
        outputChatBox("Correct syntax: /giveAccountAdminRights [accountName]", playerSource)
    end
end
addCommandHandler("giveAccountAdminRights", giveAdminRights) -- add a command "giveAccountAdminRights" and attch the function "giveAdminRights" to it

server

OOP Required

This example makes every player able to use a command named giveAccountAdminRights that will add a specific accountname as an ACL object to the Admin group.

local function giveAdminRights(playerSource, commandName, accountName) -- add the function giveAdminRights and specify its arguments
    if (accountName) then -- if there was an accountName entered then
        local adminGroup = ACLGroup.get("Admin")
        if (adminGroup) then
            adminGroup:addObject("user." .. accountName)
            playerSource:outputChat("Account '" .. accountName .."' succesfully added to the admin group") -- output a notification to the player who entered the command that the acocunt was successfully added
        end
    else -- else output an error message and the correct syntax of the command to the player who entered it
        playerSource:outputChat("No account name specified.")
        playerSource:outputChat("Correct syntax: /giveAccountAdminRights [accountName]")
    end
end
addCommandHandler("giveAccountAdminRights", giveAdminRights) -- add a command "giveAccountAdminRights" and attch the function "giveAdminRights" to it

server

This example displays a list of all the online admins in the chat box (assuming your administrator's group in your ACL is called 'Admin').

addCommandHandler("admins", function(plr, cmd)
    local admins = ""
    for k, v in ipairs(getElementsByType("player")) do
        local account = getPlayerAccount(v)
        if (account and not isGuestAccount(account)) then
            if (isObjectInACLGroup("user." .. getAccountName(account), aclGetGroup("Admin"))) then
                if (admins == "") then
                    admins = getPlayerName(v)
                else
                    admins = admins .. ", " .. getPlayerName(v)
                end
            end
        end
    end

    outputChatBox("Online admins: ", plr, 255, 255, 0)
    outputChatBox(admins, plr, 255, 255, 0)
end)

server

OOP Required

This example displays a list of all the online admins in the chat box (assuming your administrator's group in your ACL is called 'Admin').

addCommandHandler("admins", function(plr, cmd)
    local admins = ""
    for k, v in ipairs(Element.getAllByType("player")) do
        local account = v.account
        if (account and not account.guest) then
            local adminGroup = ACLGroup.get("Admin")
            if (adminGroup and adminGroup:doesContainObject("user." .. account.name)) then
                if (admins == "") then
                    admins = v.name
                else
                    admins = admins .. ", " .. v.name
                end
            end
        end
    end

    plr:outputChat("Online admins: ", 255, 255, 0)
    plr:outputChat(admins, 255, 255, 0)
end)

See Also

ACL Functions

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

ACL Elements

• acl
• aclgroup

Reference

• Scripting Functions