AclGroupListObjects: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(→‎Syntax: OOP syntax added)
Line 10: Line 10:
table of string aclGroupListObjects ( aclgroup theGroup )
table of string aclGroupListObjects ( aclgroup theGroup )
</syntaxhighlight>  
</syntaxhighlight>  
 
{{OOP||[[aclgroup]]:listObjects|objects|}}
===Required Arguments===  
===Required Arguments===  
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->

Revision as of 19:07, 12 July 2014

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

Syntax

table of string aclGroupListObjects ( aclgroup theGroup )

OOP Syntax Help! I don't understand this!

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


Required Arguments

  • theGroup: The ACL group to get the objects from

Returns

Returns a table over the objects 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 a list of Objects if the ACL Group is given. (TESTED!)

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

See Also