HasObjectPermissionTo - Revision history

Srslyyyy at 11:54, 25 August 2025

2025-08-25T11:54:19Z

← Older revision		Revision as of 11:54, 25 August 2025
Line 4:		Line 4:
	{{Note\|Only certain action names work. This function seems to return ''nil'' and output a bad argument error when checking if an object has rights for an action which doesn't start with ''function.'', ''command.'' or ''resource.'' keywords.}}		{{Note\|Only certain action names work. This function seems to return ''nil'' and output a bad argument error when checking if an object has rights for an action which doesn't start with ''function.'', ''command.'' or ''resource.'' keywords.}}

	Scripts frequently wish to limit access to features to particular users. The ~~naïve~~ way to do this would be to check if the player who is attempting to perform an action is in a particular group (usually the Admin group). The main issue with doing this is that the Admin group is not guaranteed to exist. It also doesn't give the server admin any flexibility. He might want to allow his 'moderators' access to the function you're limiting access to, or he may want it disabled entirely.		Scripts frequently wish to limit access to features to particular users. The naive way to do this would be to check if the player who is attempting to perform an action is in a particular group (usually the Admin group). The main issue with doing this is that the Admin group is not guaranteed to exist. It also doesn't give the server admin any flexibility. He might want to allow his 'moderators' access to the function you're limiting access to, or he may want it disabled entirely.

	This is where using the ACL properly comes in, and luckily this is very easy. It all comes down to using this function. This, somewhat confusingly named function lets you check if an ACL object (a player or a resource) has a particular ACL right. In this case, we just care about players.		This is where using the ACL properly comes in, and luckily this is very easy. It all comes down to using this function. This, somewhat confusingly named function lets you check if an ACL object (a player or a resource) has a particular ACL right. In this case, we just care about players.
Line 22:		Line 22:
	==Syntax==		==Syntax==
	{{New feature/item\|3.0162\|1.7.0\|25445\|		{{New feature/item\|3.0162\|1.7.0\|25445\|
	'''~~In 1.7.0~~ defaultPermission ~~will~~ now ~~default~~ to false. May affect the normal operation of existing scripts.~~'''~~		'''defaultPermission''' argument now defaults to '''false'''. If third argument is '''nil'''/'''false''' (or not specified), then action (unless explicitly allowed in '''ACL''') won't be processed due to missing rights. May affect the normal operation of existing scripts.
	}}		}}
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool hasObjectPermissionTo ( string / element theObject, string theAction [, bool defaultPermission = true ] )		bool hasObjectPermissionTo ( string / element theObject, string theAction [, bool defaultPermission = true/false ] )
	</syntaxhighlight>		</syntaxhighlight>
	<!-- Yes! This is actually correct this time ^^ notice theObject can be a string! -->		<!-- Yes! This is actually correct this time ^^ notice theObject can be a string! -->

Arran Fortuna: Added note about defaultPermission defaulting to false in 1.7

2025-08-25T08:22:58Z

Added note about defaultPermission defaulting to false in 1.7

← Older revision		Revision as of 08:22, 25 August 2025
Line 20:		Line 20:
	The only downside of using this method is that the admin has to modify his config. The upsides are that the admin has much more control and your script will work for any server, however the admin has configured it.		The only downside of using this method is that the admin has to modify his config. The upsides are that the admin has much more control and your script will work for any server, however the admin has configured it.

	==Syntax==		==Syntax==
			{{New feature/item\|3.0162\|1.7.0\|25445\|
			'''In 1.7.0 defaultPermission will now default to false. May affect the normal operation of existing scripts.'''
			}}
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool hasObjectPermissionTo ( string / element theObject, string theAction [, bool defaultPermission = true ] )		bool hasObjectPermissionTo ( string / element theObject, string theAction [, bool defaultPermission = true ] )

Srslyyyy: Replace to predefined variables.

2023-06-10T04:22:18Z

Replace to predefined variables.

← Older revision		Revision as of 04:22, 10 June 2023
Line 49:		Line 49:
	-- Do we have permission to kick the player? We do this so we can fail		-- Do we have permission to kick the player? We do this so we can fail
	-- nicely if this resource doesn't have access to call that function.		-- nicely if this resource doesn't have access to call that function.
	if ( hasObjectPermissionTo ( ~~getThisResource ()~~, "function.kickPlayer", true ) ) then		if ( hasObjectPermissionTo ( resource, "function.kickPlayer", true ) ) then
	-- Kick him		-- Kick him
	kickPlayer ( playerToKick, playerSource, stringReason )		kickPlayer ( playerToKick, playerSource, stringReason )

Alex7202: add russian language

2021-11-07T13:18:51Z

add russian language

← Older revision		Revision as of 13:18, 7 November 2021
Line 69:		Line 69:
	[[zh-cn:hasObjectPermissionTo]]		[[zh-cn:hasObjectPermissionTo]]
	[[pt-br:hasObjectPermissionTo]]		[[pt-br:hasObjectPermissionTo]]
			[[ru:hasObjectPermissionTo]]

Lettify: Portuguese version indexed

2021-11-06T19:41:56Z

Portuguese version indexed

← Older revision		Revision as of 19:41, 6 November 2021
Line 68:		Line 68:
	{{ACL_functions}}		{{ACL_functions}}
	[[zh-cn:hasObjectPermissionTo]]		[[zh-cn:hasObjectPermissionTo]]
			[[pt-br:hasObjectPermissionTo]]

Qwe7769611 at 09:10, 5 February 2021

2021-02-05T09:10:20Z

← Older revision		Revision as of 09:10, 5 February 2021
Line 67:		Line 67:
	<!-- 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}}
	[[en:hasObjectPermissionTo]]		[[zh-cn:hasObjectPermissionTo]]

Qwe7769611 at 09:10, 5 February 2021

2021-02-05T09:10:01Z

← Older revision		Revision as of 09:10, 5 February 2021
Line 67:		Line 67:
	<!-- 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~~:hasObjectPermissionTo]]		[[en:hasObjectPermissionTo]]

Qwe7769611 at 08:38, 5 February 2021

2021-02-05T08:38:19Z

← Older revision		Revision as of 08:38, 5 February 2021
Line 67:		Line 67:
	<!-- 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:hasObjectPermissionTo]]

NOki: /* Syntax */

2015-12-20T23:06:47Z

Syntax

← Older revision		Revision as of 23:06, 20 December 2015
Line 25:		Line 25:
	</syntaxhighlight>		</syntaxhighlight>
	<!-- Yes! This is actually correct this time ^^ notice theObject can be a string! -->		<!-- Yes! This is actually correct this time ^^ notice theObject can be a string! -->
	{{OOP\|This function is also a static function underneath the ACL class.\|[[~~acl~~]]:hasObjectPermissionTo\|\|}}		{{OOP\|This function is also a static function underneath the ACL class.\|[[ACL]].hasObjectPermissionTo\|\|}}
	===Required Arguments===		===Required Arguments===
	*'''theObject:''' The object to test if has permission to. This can be a client element (ie. a player), a resource or a string in the form "user.<name>" or "resource.<name>".		*'''theObject:''' The object to test if has permission to. This can be a client element (ie. a player), a resource or a string in the form "user.<name>" or "resource.<name>".

Qaisjp: add oop note

2015-01-01T22:54:58Z

add oop note

← Older revision		Revision as of 22:54, 1 January 2015
Line 24:		Line 24:
	bool hasObjectPermissionTo ( string / element theObject, string theAction [, bool defaultPermission = true ] )		bool hasObjectPermissionTo ( string / element theObject, string theAction [, bool defaultPermission = true ] )
	</syntaxhighlight>		</syntaxhighlight>
			<!-- Yes! This is actually correct this time ^^ notice theObject can be a string! -->
	{{OOP\|This function is also a static function underneath the ACL class.\|[[acl]]:hasObjectPermissionTo\|\|}}		{{OOP\|This function is also a static function underneath the ACL class.\|[[acl]]:hasObjectPermissionTo\|\|}}
	===Required Arguments===		===Required Arguments===