This function is used to determine if an object is in a group.

Tip

If you want to restrict access to certain things, instead of limiting it to specific groups using this function, consider using hasObjectPermissionTo. That way, you can restrict access to features regardless of group membership.

OOP Syntax Help! I don't understand this!

• Method: aclgroup:doesContainObject(...)

Syntax

bool isObjectInACLGroup ( string theObject, aclgroup theGroup )

Required Arguments

• theObject: The name of the object to check. Examples: "resource.ctf", "user.Jim".
• theGroup: The ACL group pointer of the group from which the object should be found.

Returns

• bool: result

Returns true if the object is in the specified group, false otherwise.

Code Examples

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

server

This example adds a jetpack command that is only available to admins. When entering the command, it will toggle the player's jetpack.

addCommandHandler("jetpack", function(thePlayer)
    if (doesPedHaveJetPack(thePlayer)) then -- If the player have a jetpack already, remove it
        removePedJetPack(thePlayer) -- Remove the jetpack
        return -- And stop the function here
    end

    -- Otherwise, give him one if he has access

    local accName = getAccountName(getPlayerAccount(thePlayer)) -- get his account name
    if (isObjectInACLGroup("user."..accName, aclGetGroup("Admin"))) then -- Does he have access to Admin functions?
        if (not doesPedHaveJetPack(thePlayer)) then -- If the player doesn't have a jetpack give it.
            givePedJetPack(thePlayer)  -- Give the jetpack
        end
    end
end)

server

OOP Required

This example adds a jetpack command that is only available to admins. When entering the command, it will toggle the player's jetpack.

addCommandHandler("jetpack", function(thePlayer)
    if (thePlayer.jetpack) then -- If the player have a jetpack already, remove it
        thePlayer.jetpack = false -- Remove the jetpack
        return -- And stop the function here
    end

    -- Otherwise, give him one if he has access

    local accName = thePlayer.account.name -- get his account name
    if (ACLGroup.get("Admin"):doesContainObject("user."..accName)) then -- Does he have access to Admin functions?
        if (not thePlayer.jetpack) then -- If the player doesn't have a jetpack give it.
            thePlayer.jetpack = true -- Give the jetpack
        end
    end
end)

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
• aclDestroy
• aclCreateGroup
• aclDestroyGroup
• aclGet
• aclGetGroup
• aclGetName
• aclGetRight
• aclGroupAddACL
• aclGroupAddObject
• aclGroupGetName
• aclGroupList
• aclGroupListACL
• aclGroupRemoveACL
• aclGroupListObjects
• aclGroupRemoveObject
• aclReload
• aclListRights
• aclObjectGetGroups
• aclList
• aclRemoveRight
• aclSetRight
• aclSave
• hasObjectPermissionTo
• isObjectInACLGroup

ACL Elements

• acl
• aclgroup

Reference

• Scripting Functions