AclGroupList: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(6 intermediate revisions by 6 users not shown)
Line 7: Line 7:
table aclGroupList ()
table aclGroupList ()
</syntaxhighlight>  
</syntaxhighlight>  
 
{{OOP|This function is a static function underneath the ACL Group class.|[[aclgroup|ACLGroup]].list||}}
===Returns===
===Returns===
Returns a table of all the ACL groups if successful, returns an empty table if no ACL groups exist. ''false''/''nil'' can be returned if this function fails for some other reason.
Returns a table of all the ACL groups if successful, returns an empty table if no ACL groups exist. ''false''/''nil'' can be returned if this function fails for some other reason.
Line 13: Line 13:
==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
<!-- Explain what the example is in a single sentance -->
This example does...
This example shows, how to output all ACL Group Names by ''showAclGroups''
<!-- 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 -->
<!-- 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 -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--TODO
function showGroups(player)
local groups = {}
groups = aclGroupList()
for i,v in ipairs(groups) do
local name = aclGroupGetName(v)
outputChatBox(tostring(name),player)
end
end
addCommandHandler("showAclGroups",showGroups)
</syntaxhighlight>
</syntaxhighlight>


Line 22: Line 30:
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
{{ACL_functions}}
{{ACL_functions}}
[[Category:Needs_Example]]
 
[[ar:aclGroupList]]
[[en:AclGroupList]]
[[zh-cn:AclGroupList]]

Latest revision as of 18:30, 21 February 2021

This function returns a table of all the ACL groups.

Syntax

table aclGroupList ()

OOP Syntax Help! I don't understand this!

Note: This function is a static function underneath the ACL Group class.
Method: ACLGroup.list(...)


Returns

Returns a table of all the ACL groups if successful, returns an empty table if no ACL groups exist. false/nil can be returned if this function fails for some other reason.

Example

This example shows, how to output all ACL Group Names by showAclGroups 

function showGroups(player)
	local groups = {}
	groups = aclGroupList()
	for i,v in ipairs(groups) do
		local name = aclGroupGetName(v)
		outputChatBox(tostring(name),player)
	end
end
addCommandHandler("showAclGroups",showGroups)

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/AclGroupList?oldid=69176"