AclGroupListObjects - Revision history

Tracer: Removed comments, improved examples

2023-10-18T12:09:34Z

Removed comments, improved examples

← Older revision		Revision as of 12:09, 18 October 2023
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server function}}		{{Server function}}
	~~<!-- Change this to "Client function" or "Server function" appropriately-->~~
	~~<!-- 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 objects that exist in a given ACL group. These are objects like players and resources.		This function returns a table over all the objects that exist in a given ACL group. These are objects like players and resources.

	==Syntax==		==Syntax==
	<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	table aclGroupListObjects ( aclgroup theGroup )		table aclGroupListObjects ( aclgroup theGroup )
Line 12:		Line 9:
	{{OOP\|\|[[aclgroup]]:listObjects\|objects\|}}		{{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 -->~~
	*'''theGroup:''' The ACL group to get the objects from		*'''theGroup:''' The ACL group to get the objects from

	===Returns===		===Returns===
	~~<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->~~
	Returns a table of strings 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.		Returns a table of strings 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.

	==Examples==		==Examples==
	This example outputs a list of Objects if the ACL Group is given~~. (TESTED!)~~		This example outputs a list of Objects if the ACL Group is given
	<section name="Example 1: Server" class="server" show="true">		<section name="Example 1: Server" class="server" show="true">
	<syntaxhighlight lang="lua">addCommandHandler("aclObjectList",function(player,command,aclGroup)		<syntaxhighlight lang="lua">
	if(aclGroup~="")~~then~~		addCommandHandler("aclObjectList",function(player,command,aclGroup)
	~~table~~ = aclGroupListObjects(aclGetGroup(aclGroup))		if aclGroup == '' then
	~~count = 0~~		outputChatBox("Please add the aclGroup you want the list of.", player)
	for ~~objects~~,~~name~~ in ~~pairs~~(~~table~~)do		outputChatBox("Syntax: /aclObjectList aclGroup", player)
	outputChatBox("ACL LIST: "..aclGroup.." #"..~~tostring(count)~~.." Object: "..~~name..".",player)~~		return
	~~count = count + 1~~		end
	~~end~~		local objects = aclGroupListObjects(aclGetGroup(aclGroup))
	~~else~~		for k,v in ipairs(objects) do
	~~outputChatBox("Please add the aclGroup you want the list of.",player)~~		outputChatBox("ACL LIST: "..aclGroup.." #"..k.." Object: "..v,player)
	~~outputChatBox("Syntax: /aclObjectList aclGroup"~~,player)
	end		end
	end)		end)
Line 41:		Line 35:
	This example outputs through the command "getAdminAccounts" all accounts added to the "Admin" group.		This example outputs through the command "getAdminAccounts" all accounts added to the "Admin" group.
	<section name="Example 2: Server" class="server" show="true">		<section name="Example 2: Server" class="server" show="true">
	<syntaxhighlight lang="lua" >function outputAdminGroupAccounts( player )		<syntaxhighlight lang="lua">
	local admins = {} -- creates the table in which will be added the accounts of "Admin" group		function outputAdminGroupAccounts(player)
	local group = aclGetGroup( "Admin" )		local admins = {} -- creates the table in which will be added the accounts of "Admin" group
	-- should return the "aclgroup" if the "Admin" group be found in ACL		local group = aclGetGroup("Admin")
	if (group) then		-- should return the "aclgroup" if the "Admin" group be found in ACL
	for _, object in ipairs(aclGroupListObjects(group) or {}) do		if not group then return end
	local objType = gettok( object, 1, string.byte('.') )		for _, object in ipairs(aclGroupListObjects(group) or {}) do
	-- objType: gets the object type only, which can be either "user" or "resource"		local objType = gettok( object, 1, string.byte('.') )
	if (objType == "user") then -- checks if it's a player account		-- objType: gets the object type only, which can be either "user" or "resource"
	local _name = gettok( object, 2, string.byte('.') ) -- ignores "user." by separating that from the account name		if objType == "user" then -- checks if it's a player account
	table.insert( admins, _name ) -- adds the account name to the "admins" table		local _name = gettok( object, 2, string.byte('.') ) -- ignores "user." by separating that from the account name
	~~end~~		table.insert( admins, _name ) -- adds the account name to the "admins" table
	end		end
	end		end
	for i, name in ipairs(admins) do -- loop through the table "admins"		for i, name in ipairs(admins) do -- loop through the table "admins"
	outputChatBox(tostring(i).." : "..tostring(name), player, 140, 220, 140)		outputChatBox(tostring(i).." : "..tostring(name), player, 140, 220, 140)
Line 67:		Line 61:

	==See Also==		==See Also==
	~~<!-- 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}}

	[[zh-cn:aclGroupListObjects]]		[[zh-cn:aclGroupListObjects]]

Qwe7769611 at 08:35, 5 February 2021

2021-02-05T08:35:32Z

← Older revision		Revision as of 08:35, 5 February 2021
Line 69:		Line 69:
	<!-- 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}}
			[[zh-cn:aclGroupListObjects]]

Danilo at 10:23, 25 February 2018

2018-02-25T10:23:06Z

← Older revision		Revision as of 10:23, 25 February 2018
Line 56:		Line 56:
	end		end
	for i, name in ipairs(admins) do -- loop through the table "admins"		for i, name in ipairs(admins) do -- loop through the table "admins"
	outputChatBox(tostring(i).." : "..tostring(name), p, 140, 220, 140)		outputChatBox(tostring(i).." : "..tostring(name), player, 140, 220, 140)
	-- output will look like this: "1 : John"		-- output will look like this: "1 : John"
	end		end

Danilo: Added 2nd example

2018-02-25T10:21:06Z

Added 2nd example

@@ Line 19: / Line 19: @@
 Returns a table of strings 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==
+==Examples==
 This example outputs a list of Objects if the ACL Group is given. (TESTED!)
 <syntaxhighlight lang="lua">addCommandHandler("aclObjectList",function(player,command,aclGroup)
 	if(aclGroup~="")then
@@ Line 35: / Line 36: @@
 end)
 </syntaxhighlight>
 ==See Also==
 <!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
 {{ACL_functions}}

Qaisjp: fix oop syntax

2015-01-01T14:49:16Z

fix oop syntax

← Older revision		Revision as of 14:49, 1 January 2015
Line 8:		Line 8:
	<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->		<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	table ~~of string~~ aclGroupListObjects ( aclgroup theGroup )		table aclGroupListObjects ( aclgroup theGroup )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|~~This function is also a static function underneath the ACL Group class.~~\|[[aclgroup]]:listObjects\|objects\|}}		{{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 -->
Line 17:		Line 17:
	===Returns===		===Returns===
	<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->		<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
	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.		Returns a table of strings 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==		==Example==

Jaysds: /* Syntax */ OOP

2014-08-22T15:46:14Z

Syntax: OOP

← Older revision		Revision as of 15:46, 22 August 2014
Line 10:		Line 10:
	table of string aclGroupListObjects ( aclgroup theGroup )		table of string aclGroupListObjects ( aclgroup theGroup )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[aclgroup]]:listObjects\|objects\|}}		{{OOP\|This function is also a static function underneath the ACL Group class.\|[[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 -->

MarioKart: /* Syntax */ OOP syntax added

2014-07-12T19:07:12Z

Syntax: OOP syntax added

← Older revision		Revision as of 19:07, 12 July 2014
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 -->

Jaysds: /* Example */

2012-04-27T21:04:11Z

Example

← Older revision		Revision as of 21:04, 27 April 2012
Line 20:		Line 20:

	==Example==		==Example==
	This example outputs a list of Objects if the ACL Group is given.		This example outputs a list of Objects if the ACL Group is given. (TESTED!)
	<syntaxhighlight lang="lua">addCommandHandler("aclObjectList",function(player,command,aclGroup)		<syntaxhighlight lang="lua">addCommandHandler("aclObjectList",function(player,command,aclGroup)
	if(aclGroup~="")then		if(aclGroup~="")then
	table = aclGroupListObjects(aclGetGroup~~(tostring~~(aclGroup)))		table = aclGroupListObjects(aclGetGroup(aclGroup))
	count = 0		count = 0
	for objects,name in ~~ipairs~~(#table)do		for objects,name in pairs(table)do
	outputChatBox("ACL LIST: "..aclGroup.."~~Line:~~ "..tostring(count).." Object: "..name..".",player)		outputChatBox("ACL LIST: "..aclGroup.." #"..tostring(count).." Object: "..name..".",player)
	count = count + 1		count = count + 1
	end		end

Jaysds at 03:58, 27 April 2012

2012-04-27T03:58:29Z

← Older revision		Revision as of 03:58, 27 April 2012
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-->
	<!-- 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 objects that exist in a given ACL group. These are objects like players and resources.		This function returns a table over all the objects that exist in a given ACL group. These are objects like players and resources.

Jaysds at 03:56, 27 April 2012

2012-04-27T03:56:23Z

← Older revision		Revision as of 03:56, 27 April 2012
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 objects that exist in a given ACL group. These are objects like players and resources.		This function returns a table over all the objects that exist in a given ACL group. These are objects like players and resources.
Line 20:		Line 19:

	==Example==		==Example==
	~~<!-- Explain what~~ the ~~example~~ is in ~~a single sentance -->~~		This example outputs a list of Objects if the ACL Group is given.
	~~This example does~~...		<syntaxhighlight lang="lua">addCommandHandler("aclObjectList",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 = aclGroupListObjects(aclGetGroup(tostring(aclGroup)))
	~~--TODO~~		count = 0
			for objects,name in ipairs(#table)do
			outputChatBox("ACL LIST: "..aclGroup.."Line: "..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)
	</syntaxhighlight>		</syntaxhighlight>