This function returns a table over all the objects that exist in a given ACL group. These are objects like players and resources.

OOP Syntax Help! I don't understand this!

• Method:aclgroup:listObjects(...)
• Variable: .objects

Syntax

​table|false aclGroupListObjects ( ​aclgroup theGroup )

Required arguments

• theGroup: The ACL group to get the objects from.

Returns

Returns a table of strings in the given ACL group. This table might be empty. Returns false or nil if theGroup is invalid or it fails for some other reason.

• table|false: acl group objects list

Code Examples

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

server

This example outputs a list of objects if the ACL Group is given.

addCommandHandler("aclObjectList",function(player,command,aclGroup)
  if (not aclGroup) then -- Was the group name provided?
    outputChatBox("You must provide the group name!", player, 255, 255, 255)
    return
  end

  local group = aclGetGroup(aclGroup)
  if (group) then
    local objects = aclGroupListObjects(group)
    outputChatBox("List of objects in group "..aclGroup.." (#"..#objects..")", player, 255, 255, 255)

    for k,v in ipairs(objects) do
      outputChatBox("- "..v, player)
    end
  else
    outputChatBox("Group with the name "..aclGroup.." does not exist.", player, 255, 255, 255)
  end
end)

server

OOP Required

This example outputs a list of objects if the ACL Group is given.

addCommandHandler("aclObjectList", function(player, command, aclGroup)
  if (not aclGroup) then -- Was the group name provided?
    player:outputChat("You must provide the group name!", 255, 255, 255)
    return
  end

  local group = ACLGroup.get(aclGroup)
  if (group) then
    local objects = group.objects -- or group:listObjects()
    player:outputChat("List of objects in group "..aclGroup.." (#"..#objects..")", 255, 255, 255)

    for k, v in ipairs(objects) do
      player:outputChat("- "..v)
    end
  else
    player:outputChat("Group with the name "..aclGroup.." does not exist.", 255, 255, 255)
  end
end)

server

This example outputs through the command getAdminAccounts all accounts added to the Admin group.

local function outputAdminGroupAccounts(player)
    local group = aclGetGroup("Admin")
    if (group) then -- Does the group exist?
        local admins = {}
        local objects = aclGroupListObjects(group) or {}
        for k, v in ipairs(objects) do
            local objectType = gettok(v, 1, string.byte("."))
            -- objectType: gets the object type only, which can be either "user" or "resource"
            if (objectType == "user") then -- checks if it's a player account
                local name = gettok(object, 2, string.byte(".")) -- ignores "user." by separating that from the account name
                table.insert(admins, name) -- adds the account name to the "admins" table
            end
        end

        outputChatBox(table.concat(admins, ", "), player, 255, 255, 255) -- output: John, Bob, Ghost
    else
        outputChatBox("The group named Admin does not exist.", player, 255, 255, 255)
    end
end
addCommandHandler("getAdminAccounts", outputAdminGroupAccounts)
-- adds the command "getAdminAccounts" and attaches it to the function "outputAdminGroupAccounts"

server

OOP Required

This example outputs through the command getAdminAccounts all accounts added to the Admin group.

local function outputAdminGroupAccounts(player)
    local group = ACLGroup.get("Admin")
    if (group) then -- Does the group exist?
        local admins = {}
        local objects = group.objects or {}
        for k, v in ipairs(objects) do
            local objectType = gettok(v, 1, string.byte("."))
            -- objectType: gets the object type only, which can be either "user" or "resource"
            if (objectType == "user") then -- checks if it's a player account
                local name = gettok(object, 2, string.byte(".")) -- ignores "user." by separating that from the account name
                table.insert(admins, name) -- adds the account name to the "admins" table
            end
        end

        player:outputChat(table.concat(admins, ", "), 255, 255, 255) -- output: John, Wind, Ghost
    else
        player:outputChat("The group named Admin does not exist.", player, 255, 255, 255)
    end
end
addCommandHandler("getAdminAccounts", outputAdminGroupAccounts)
-- adds the command "getAdminAccounts" and attaches it to the function "outputAdminGroupAccounts"

See Also

ACL Functions

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

ACL Elements

• acl
• aclgroup

Reference

• Scripting Functions