AclGet - Revision history

Myonlake at 18:21, 21 February 2021

2021-02-21T18:21:49Z

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

			[[ar:aclGet]]
			[[en:AclGet]]
	[[zh-cn:AclGet]]		[[zh-cn:AclGet]]

Qwe7769611 at 08:28, 5 February 2021

2021-02-05T08:28:04Z

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

Qaisjp: fix oop syntax

2015-01-01T14:52:35Z

fix oop syntax

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

Strix at 16:56, 27 December 2014

2014-12-27T16:56:42Z

← Older revision		Revision as of 16:56, 27 December 2014
Line 7:		Line 7:
	acl aclGet ( string aclName )		acl aclGet ( string aclName )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|This function is also a static function underneath the ACL class.\|[[~~acl~~]]:get\|\|}}		{{OOP\|This function is also a static function underneath the ACL class.\|[[ACL]].get\|\|}}
	===Required Arguments===		===Required Arguments===
	*'''aclName:''' The name to get the ACL belonging to		*'''aclName:''' The name to get the ACL belonging to

Jaysds: /* Syntax */ OOP

2014-08-22T14:26:35Z

Syntax: OOP

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

MarioKart: OOP syntax added

2014-07-12T17:34:48Z

OOP syntax added

← Older revision		Revision as of 17:34, 12 July 2014
Line 7:		Line 7:
	acl aclGet ( string aclName )		acl aclGet ( string aclName )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|ACL.get\|}}
	===Required Arguments===		===Required Arguments===
	*'''aclName:''' The name to get the ACL belonging to		*'''aclName:''' The name to get the ACL belonging to

Sebassje at 22:20, 22 June 2009

2009-06-22T22:20:27Z

← Older revision		Revision as of 22:20, 22 June 2009
Line 29:		Line 29:
	if not (access == "true" or access == "false") then		if not (access == "true" or access == "false") then
	-- print out error message to debug window		-- print out error message to debug window
	outputDebugString ( "Invalid access; true and false are only accepted", 1 )		return outputDebugString ( "Invalid access; true and false are only accepted", 1 )
	~~-- exit function~~
	~~return~~
	end		end

Line 39:		Line 37:
	else		else
	access = false		access = false
			end

	-- and finally let's set the right		-- and finally let's set the right

Awwu at 18:33, 22 June 2009

2009-06-22T18:33:13Z

← Older revision		Revision as of 18:33, 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 ACL with the given name. If need to get most of the ACL's, you should consider using [[aclList]] to get a table of them all.		Get the ACL with the given name. If need to get most of the ACL's, you should consider using [[aclList]] to get a table of them all.

	==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">
	acl aclGet ( string aclName )		acl aclGet ( string aclName )
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 -->~~
	*'''aclName:''' The name to get the ACL belonging to		*'''aclName:''' The name to get the ACL belonging to

	===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 ACL with that name if it could be retrieved, ''false''/''nil'' if the ACL does not exist or it fails for some other reason.		Returns the ACL with that name if it could be retrieved, ''false''/''nil'' if the ACL does not exist or it fails for some other reason.

	==Example==		==Example==
	~~<!-- Explain what the~~ example ~~is in~~ a ~~single sentance -->~~		This example adds a command ''setaclright'' with which you can easily add new rights to specified access control lists.
	~~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 setACLRight ( thePlayer, commandName, aclName, rightName, access )
			local ourACL = aclGet ( aclName )
			-- if there is no previous ACL with this name, we need to create one
			if not ourACL then
			ourACL = aclCreate ( aclName )
			end

			-- turn the boolean string to lower case
			access = string.lower ( access )
			-- access has to be either true or false (booleans)
			if not (access == "true" or access == "false") then
			-- print out error message to debug window
			outputDebugString ( "Invalid access; true and false are only accepted", 1 )
			-- exit function
			return
			end

			-- change the access to boolean
			if access == "true" then
			access = true
			else
			access = false

			-- and finally let's set the right
			aclSetRight ( ourACL, rightName, access )
			-- don't forget to save the ACL after it has been modified
			aclSave ()
			end
			addCommandHandler ( "setaclright", setACLRight )
	</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:19, 26 November 2007

2007-11-26T13:19:50Z

← Older revision		Revision as of 13:19, 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:03, 26 November 2007

2007-11-26T10:03:59Z

← Older revision		Revision as of 10:03, 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 ACL with the given name. If need to get most of the ACL's, you should consider using [[aclList]] to get a table of them all.		Get the ACL with the given name. If need to get most of the ACL's, you should consider using [[aclList]] to get a table of them all.