This function destroys the given ACL group. The destroyed ACL group will no longer be valid.

OOP Syntax Help! I don't understand this!

• Method: aclgroup:destroy(...)

Syntax

bool aclDestroyGroup ( aclgroup aclGroup )

Required Arguments

• aclGroup: The aclgroup element to destroy.

Returns

• bool: result

Returns true if the ACL group was successfully deleted, false if it could not be deleted for some reason (ie. invalid argument).

Code Examples

Example 1 Example 2 (OOP)

server

This example allows admins to remove an ACL group they specify.

local function removeACLGroup ( source, command, groupName )
  -- Check if they're an admin...
  if (isObjectInACLGroup("user."..getAccountName(getPlayerAccount(source)), aclGetGroup( "Admin"))) then
    if (groupName) then -- Check if they specified the group name
      local group = aclGetGroup(groupName) -- Return any groups matching the name
      if (group) then -- If any were returned then...
        aclDestroyGroup(group) -- Destroy that group
      else
        -- Tell them if no groups with that name were found...
        outputChatBox("No group with that name was found.", source, 255, 0, 0)
      end
    else -- If they didn't specify the group
      outputChatBox("Please specify the group name.", source, 255, 0, 0) -- Tell them that they must
    end
  else -- If they're not an admin....
    outputChatBox("You must be an admin to use this command", source, 255, 0, 0) -- Tell them it's restricted
  end
end
addCommandHandler("removeACL", removeACLGroup) -- Make it happen when somebody types "/removeACL"

server

OOP Required

This example allows admins to remove an ACL group they specify.

local function removeACLGroup ( source, command, groupName )
  -- Check if they're an admin...
    local adminGroup = ACLGroup.get("Admin")
    if (adminGroup and adminGroup:doesContainObject('user.'..source.account.name)) then
    if (groupName) then -- Check if they specified the group name
      local group = ACLGroup.get(groupName) -- Return any groups matching the name
      if (group) then -- If any were returned then...
        group:destroy() -- Destroy that group
      else
        -- Tell them if no groups with that name were found...
        source:outputChat("No group with that name was found.", 255, 0, 0)
      end
    else -- If they didn't specify the group
      source:outputChat("Please specify the group name.", 255, 0, 0) -- Tell them that they must
    end
  else -- If they're not an admin....
    source:outputChat("You must be an admin to use this command", 255, 0, 0) -- Tell them it's restricted
  end
end
addCommandHandler("removeACL", removeACLGroup) -- Make it happen when somebody types "/removeACL"

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