AclSetRight - Revision history

Tracer: Added "resource" as the ACL rights type

2023-03-01T16:21:28Z

Added "resource" as the ACL rights type

← Older revision		Revision as of 16:21, 1 March 2023
Line 10:		Line 10:
	===Required Arguments===		===Required Arguments===
	*'''theAcl:''' The ACL to change the right of		*'''theAcl:''' The ACL to change the right of
	*'''rightName:''' The right to add/change the access property of. It '''must''' be prefixed with "'''function.'''" or "'''command.'''" or "'''general.'''"		*'''rightName:''' The right to add/change the access property of. It '''must''' be prefixed with "'''function.'''" or "'''command.'''" or "'''general.'''" or "'''resource.'''"
	*'''hasAccess:''' Whether the access should be set to true or false		*'''hasAccess:''' Whether the access should be set to true or false

Tracer: Added an important note regarding ACL rights

2023-03-01T16:20:52Z

Added an important note regarding ACL rights

← Older revision		Revision as of 16:20, 1 March 2023
Line 10:		Line 10:
	===Required Arguments===		===Required Arguments===
	*'''theAcl:''' The ACL to change the right of		*'''theAcl:''' The ACL to change the right of
	*'''rightName:''' The right to add/change the access property of		*'''rightName:''' The right to add/change the access property of. It '''must''' be prefixed with "'''function.'''" or "'''command.'''" or "'''general.'''"
	*'''hasAccess:''' Whether the access should be set to true or false		*'''hasAccess:''' Whether the access should be set to true or false

Qwe7769611 at 08:38, 5 February 2021

2021-02-05T08:38:05Z

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

Walid: Fix oop syntax

2016-08-06T14:14:32Z

Fix oop syntax

← Older revision		Revision as of 14:14, 6 August 2016
Line 7:		Line 7:
	bool aclSetRight ( acl theAcl, string rightName, bool hasAccess )		bool aclSetRight ( acl theAcl, string rightName, bool hasAccess )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[acl]]:setRight\|\|}}		{{OOP\|\|[[acl]]:setRight\|\|aclGetRight}}
	===Required Arguments===		===Required Arguments===
	*'''theAcl:''' The ACL to change the right of		*'''theAcl:''' The ACL to change the right of

MarioKart: OOP syntax added

2014-07-12T18:10:41Z

OOP syntax added

← Older revision		Revision as of 18:10, 12 July 2014
Line 7:		Line 7:
	bool aclSetRight ( acl theAcl, string rightName, bool hasAccess )		bool aclSetRight ( acl theAcl, string rightName, bool hasAccess )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[acl]]:setRight\|\|}}
	===Required Arguments===		===Required Arguments===
	*'''theAcl:''' The ACL to change the right of		*'''theAcl:''' The ACL to change the right of

X86dev at 11:26, 25 September 2012

2012-09-25T11:26:30Z

← Older revision		Revision as of 11:26, 25 September 2012
Line 48:		Line 48:
	addCommandHandler ( "setaclright", setACLRight )		addCommandHandler ( "setaclright", setACLRight )
	</syntaxhighlight>		</syntaxhighlight>

			==See Also==
			{{ACL_functions}}

MR.S3D: /* See Also */

2012-09-25T09:22:19Z

MR.S3D: /* Example */

2012-09-25T09:21:59Z

Example

@@ Line 15: / Line 15: @@
 ===Returns===
 Returns ''true'' if the access was successfully changed, ''false'' or ''nil'' if it failed for some reason, ie. invalid ACL or the rightname is invalid.
 ==See Also==
 {{ACL_functions}}

Sebassje at 22:21, 22 June 2009

2009-06-22T22:21:17Z

← Older revision		Revision as of 22:21, 22 June 2009
Line 31:		Line 31:
	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 41:		Line 39:
	else		else
	access = false		access = false
			end

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

Awwu at 18:22, 22 June 2009

2009-06-22T18:22:39Z

← Older revision		Revision as of 18:22, 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 -->~~
	This functions changes or adds the given right in the given ACL. The access can be ''true'' or ''false'' and specifies whether the ACL gives access to the right or not.		This functions changes or adds the given right in the given ACL. The access can be ''true'' or ''false'' and specifies whether the ACL gives access to the right or not.

	==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">
	bool aclSetRight ( acl theAcl, string rightName, bool hasAccess )		bool aclSetRight ( acl theAcl, string rightName, bool hasAccess )
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 change the right of		*'''theAcl:''' The ACL to change the right of
	*'''rightName:''' The right to add/change the access property of		*'''rightName:''' The right to add/change the access property of
Line 17:		Line 14:

	===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 ''true'' if the access was successfully changed, ''false'' or ''nil'' if it failed for some reason, ie. invalid ACL or the rightname is invalid.		Returns ''true'' if the access was successfully changed, ''false'' or ''nil'' if it failed for some reason, ie. invalid ACL or the rightname is invalid.

	==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]]~~