AclGetName - Revision history

Myonlake at 18:23, 21 February 2021

2021-02-21T18:23:54Z

← Older revision		Revision as of 18:23, 21 February 2021
Line 38:		Line 38:
	==See Also==		==See Also==
	{{ACL_functions}}		{{ACL_functions}}

			[[ar:aclGetName]]
			[[en:AclGetName]]
	[[zh-cn:AclGetName]]		[[zh-cn:AclGetName]]

Qwe7769611 at 08:28, 5 February 2021

2021-02-05T08:28:48Z

← Older revision		Revision as of 08:28, 5 February 2021
Line 38:		Line 38:
	==See Also==		==See Also==
	{{ACL_functions}}		{{ACL_functions}}
			[[zh-cn:AclGetName]]

Qaisjp: fix oop syntax

2015-01-01T22:58:53Z

fix oop syntax

← Older revision		Revision as of 22:58, 1 January 2015
Line 7:		Line 7:
	string aclGetName ( acl theAcl )		string aclGetName ( acl theAcl )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|~~This function is also a static function underneath the ACL class.~~\|[[acl]]:getName\|name\|}}		{{OOP\|\|[[acl]]:getName\|name\|}}
	===Required Arguments===		===Required Arguments===
	*'''theACL:''' The ACL to get the name of		*'''theACL:''' The ACL to get the name of

Jaysds: /* Syntax */ OOP

2014-08-22T14:27:35Z

Syntax: OOP

← Older revision		Revision as of 14:27, 22 August 2014
Line 7:		Line 7:
	string aclGetName ( acl theAcl )		string aclGetName ( acl theAcl )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[acl]]:getName\|name\|}}		{{OOP\|This function is also a static function underneath the ACL class.\|[[acl]]:getName\|name\|}}
	===Required Arguments===		===Required Arguments===
	*'''theACL:''' The ACL to get the name of		*'''theACL:''' The ACL to get the name of

MarioKart: OOP syntax added

2014-07-12T18:06:52Z

OOP syntax added

← Older revision		Revision as of 18:06, 12 July 2014
Line 7:		Line 7:
	string aclGetName ( acl theAcl )		string aclGetName ( acl theAcl )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[acl]]:getName\|name\|}}
	===Required Arguments===		===Required Arguments===
	*'''theACL:''' The ACL to get the name of		*'''theACL:''' The ACL to get the name of

Sebassje at 22:17, 22 June 2009

2009-06-22T22:17:35Z

← Older revision		Revision as of 22:17, 22 June 2009
Line 23:		Line 23:
	if #allACLs == 0 then		if #allACLs == 0 then
	-- print out a message to console and exit function		-- print out a message to console and exit function
	outputConsole ( "There are no ACLs!", thePlayer )		return outputConsole ( "There are no ACLs!", thePlayer )
	~~return~~
	else		else
	-- print out a list of the names		-- print out a list of the names

Awwu at 18:42, 22 June 2009

2009-06-22T18:42:31Z

← Older revision		Revision as of 18:42, 22 June 2009
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server function}}		{{Server function}}
	~~<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->~~
	Get the name of given ACL.		Get the name of given ACL.

	==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">
	string aclGetName ( acl theAcl )		string aclGetName ( acl theAcl )
Line 11:		Line 9:

	===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 -->~~
	*'''theACL:''' The ACL to get the name of		*'''theACL:''' The ACL to get the name of

	===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 the name of the given ACL as a string if successful. Returns ''false''/''nil'' if unsuccessful, ie the ACL is invalid.		Returns the name of the given ACL as a string if successful. Returns ''false''/''nil'' if unsuccessful, ie the ACL is invalid.

	==Example==		==Example==
	~~<!-- Explain what the~~ example ~~is in~~ a ~~single sentance -->~~		This example adds a command ''listacls'' which prints out a name list of all ACLs to the console.
	~~This example does...~~
	~~<!-- 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 printOutAllACLs ( thePlayer )
			-- get a table over all the ACLs
			local allACLs = aclList()
			-- if the table is empty (there are no ACLs)
			if #allACLs == 0 then
			-- print out a message to console and exit function
			outputConsole ( "There are no ACLs!", thePlayer )
			return
			else
			-- print out a list of the names
			outputConsole ( "List of all ACLs:", thePlayer )
			for key, singleACL in ipairs ( allACLs ) do
			local ACLName = aclGetName ( singleACL )
			outputConsole ( "- " .. tostring ( ACLName ), thePlayer )
			end
			end
			end
			addCommandHandler ( "listacls", printOutAllACLs )
	</syntaxhighlight>		</syntaxhighlight>

	==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}}
	~~[[Category:Needs_Example]]~~

ChrML at 13:20, 26 November 2007

2007-11-26T13:20:10Z

← Older revision		Revision as of 13:20, 26 November 2007
Line 29:		Line 29:
	<!-- 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:~~Incomplete~~]]		[[Category:Needs_Example]]

ChrML at 10:04, 26 November 2007

2007-11-26T10:04:16Z

← Older revision		Revision as of 10:04, 26 November 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
			{{Server function}}
	<!-- 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 -->
	Get the name of given ACL.		Get the name of given ACL.

ChrML at 08:56, 26 November 2007

2007-11-26T08:56:59Z

← Older revision		Revision as of 08:56, 26 November 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	<!-- 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 fake function is for use with blah & blah and does blahblahblabhalbhl~~		Get the name of given ACL.

	==Syntax==		==Syntax==
Line 11:		Line 11:
	===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 -->
	*'''~~argumentName~~:''' ~~description~~		*'''theACL:''' The ACL to get the name of

	~~<!-- Only include this section below if there are optional arguments -->~~
	~~===Optional Arguments===~~
	~~{{OptionalArg}}~~
	*'''argumentName2:''' description
	*'''argumentName3:''' description

	===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 ''~~true~~'' ~~if blah,~~ ''~~false~~'' ~~otherwise~~.		Returns the name of the given ACL as a string if successful. Returns ''false''/''nil'' if unsuccessful, ie the ACL is invalid.

	==Example==		==Example==
Line 28:		Line 22:
	<!-- 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">
	--~~This line does...~~		--TODO
	~~blabhalbalhb --abababa~~
	~~--This line does this...~~
	~~mooo~~
	</syntaxhighlight>		</syntaxhighlight>