AclGroupListACL: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Server function}}<!-- Change this to "Client function" or "Server function" appropriately-->
{{Server function}}<!-- Change this to "Client function" or "Server function" appropriately-->
{{Needs Example}}
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
This function returns a table over all the ACL's that exist in a given ACL group.
This function returns a table over all the ACL's that exist in a given ACL group.
Line 20: Line 19:


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This example outputs the list of ACL's if the aclGroup name is given.
This example does...
<syntaxhighlight lang="lua">addCommandHandler("aclList",function(player,command,aclGroup)
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
if(aclGroup~="")then
<syntaxhighlight lang="lua">
table = aclGroupListACL(aclGetGroup(tostring(aclGroup)))
--TODO
for list,name in ipairs(#table)do
count = 0
outputChatBox("ACL LIST: "..aclGroup.."Line: "..count.." ACL: "..name..".",player)
count = count + 1
end
else
outputChatBox("Please add the aclGroup you want the list of.",player)
outputChatBox("Syntax: /aclList aclGroup",player)
end
end)
</syntaxhighlight>
</syntaxhighlight>



Revision as of 22:04, 26 April 2012

This function returns a table over all the ACL's that exist in a given ACL group.

Syntax

table of acl aclGroupListACL ( aclgroup theGroup )

Required Arguments

  • theGroup: The ACL group to get the ACL elements from

Returns

Returns a table over the ACL elements 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.

Example

This example outputs the list of ACL's if the aclGroup name is given.

addCommandHandler("aclList",function(player,command,aclGroup)
	if(aclGroup~="")then
		table = aclGroupListACL(aclGetGroup(tostring(aclGroup)))
		for list,name in ipairs(#table)do
			count = 0
			outputChatBox("ACL LIST: "..aclGroup.."Line: "..count.." ACL: "..name..".",player)
			count = count + 1
		end
	else
		outputChatBox("Please add the aclGroup you want the list of.",player)
		outputChatBox("Syntax: /aclList aclGroup",player)
	end
end)

See Also