IsObjectInACLGroup - Revision history

Citizen: Updated both examples to look nicer (didn't change what they do) and not display bad practices (like global variables) so new devs can learn with good code

2024-05-13T20:48:49Z

Updated both examples to look nicer (didn't change what they do) and not display bad practices (like global variables) so new devs can learn with good code

← Older revision		Revision as of 20:48, 13 May 2024
Line 19:		Line 19:
	''' Example 1:''' This example adds a ''jetpack'' command that is only available to admins. When entering the command, it will toggle the player's jetpack.		''' Example 1:''' This example adds a ''jetpack'' command that is only available to admins. When entering the command, it will toggle the player's jetpack.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addCommandHandler ( "jetpack",		addCommandHandler ( "jetpack", function ( thePlayer )
	function ( thePlayer )		if doesPedHaveJetPack ( thePlayer ) then -- If the player have a jetpack already, remove it
	if doesPedHaveJetPack ( thePlayer ) then -- If the player have a jetpack already, remove it		removePedJetPack ( thePlayer ) -- Remove the jetpack
	removePedJetPack ( thePlayer ) -- Remove the jetpack		return -- And stop the function here
	return -- And stop the function here		end

			-- Otherwise, give him one if he has access

			local accName = getAccountName ( getPlayerAccount ( thePlayer ) ) -- get his account name
			if isObjectInACLGroup ("user."..accName, aclGetGroup ( "Admin" ) ) then -- Does he have access to Admin functions?
			if not doesPedHaveJetPack ( thePlayer ) then -- If the player doesn't have a jetpack give it.
			givePedJetPack ( thePlayer ) -- Give the jetpack
	end		end
			end
	~~-- Otherwise, give him one if he has access~~		end)

	~~local accName = getAccountName ( getPlayerAccount ( thePlayer ) ) -- get his account name~~
	~~if isObjectInACLGroup ("user."..accName, aclGetGroup ( "Admin" ) ) then -- Does he have access to Admin functions?~~
	~~if not doesPedHaveJetPack ( thePlayer ) then -- If the player doesn't have a jetpack give it.~~
	~~givePedJetPack ( thePlayer ) -- Give the jetpack~~
	end
	end
	~~end~~
	)
	</syntaxhighlight>		</syntaxhighlight>

	'''Example 2:''' This example displays a list of all the online admins in the chat box (assuming your administrator's group in your ACL is called '~~admin~~'):		'''Example 2:''' This example displays a list of all the online admins in the chat box (assuming your administrator's group in your ACL is called 'Admin'):
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	players = getElementsByType ( "player" )		local admins = ""
	~~admins = ""~~		local players = getElementsByType("player")
	for k,v in ipairs(players) do		for k, v in ipairs(players) do
	~~local accountname = ""~~		if not isGuestAccount(getPlayerAccount(v)) then
	if (isGuestAccount(getPlayerAccount(v)~~) == false~~) then		local accountName = getAccountName(getPlayerAccount(v))
	~~accountname~~ = getAccountName (getPlayerAccount(v))		if isObjectInACLGroup("user." .. accountName, aclGetGroup("Admin")) then
	if isObjectInACLGroup ( "user." .. ~~accountname~~, aclGetGroup ( "~~admin~~" ) ) then		if admins == "" then
	if (admins == "") then
	admins = getPlayerName(v)		admins = getPlayerName(v)
	else		else
Line 55:		Line 52:
	end		end
	end		end
	outputChatBox( "Online Admins:", getRootElement(), 255, 255, 0)		outputChatBox("Online Admins:", getRootElement(), 255, 255, 0)
	outputChatBox( " " .. ~~tostring (~~ admins ), getRootElement(), 255, 255, 0)		outputChatBox(" " .. admins, getRootElement(), 255, 255, 0)
	</syntaxhighlight>		</syntaxhighlight>

LordHenry: /* Required Arguments */

2023-09-21T16:49:08Z

Required Arguments

← Older revision		Revision as of 16:49, 21 September 2023
Line 11:		Line 11:
	===Required Arguments===		===Required Arguments===
	*'''theObjectName:''' the name of the object to check. Examples: "resource.ctf", "user.Jim".		*'''theObjectName:''' the name of the object to check. Examples: "resource.ctf", "user.Jim".
	*'''theGroup:''' the [[ACL group]] pointer of the group from which the object should be found.		*'''theGroup:''' the [[AclGroup\|ACL group]] pointer of the group from which the object should be found.

	===Returns===		===Returns===

Toliak: Yes, my fault. What about to rename the argument to "theObjectName". It is more readable, isn't it?

2021-09-03T07:31:16Z

Yes, my fault. What about to rename the argument to "theObjectName". It is more readable, isn't it?

← Older revision		Revision as of 07:31, 3 September 2021
Line 6:		Line 6:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool isObjectInACLGroup ( string ~~theObject~~, aclgroup theGroup )		bool isObjectInACLGroup ( string theObjectName, aclgroup theGroup )
	</syntaxhighlight>		</syntaxhighlight>
	{{New feature/item\|3.0141\|1.4.0\|6994\|{{OOP\|\|[[aclgroup]]:doesContainObject\|\|}}}}		{{New feature/item\|3.0141\|1.4.0\|6994\|{{OOP\|\|[[aclgroup]]:doesContainObject\|\|}}}}
	===Required Arguments===		===Required Arguments===
	*'''~~theObject~~:''' the name of the object to check. Examples: "resource.ctf", "user.Jim".		*'''theObjectName:''' the name of the object to check. Examples: "resource.ctf", "user.Jim".
	*'''theGroup:''' the [[ACL group]] pointer of the group from which the object should be found.		*'''theGroup:''' the [[ACL group]] pointer of the group from which the object should be found.

Lettify: Undo revision 72005 by Toliak (talk) Object is actually a string containing "user.accountName" or "resource.resourceName"

2021-09-03T00:52:27Z

Undo revision 72005 by Toliak (talk) Object is actually a string containing "user.accountName" or "resource.resourceName"

← Older revision		Revision as of 00:52, 3 September 2021
Line 6:		Line 6:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool isObjectInACLGroup ( ~~object~~ theObject, aclgroup theGroup )		bool isObjectInACLGroup ( string theObject, aclgroup theGroup )
	</syntaxhighlight>		</syntaxhighlight>
	{{New feature/item\|3.0141\|1.4.0\|6994\|{{OOP\|\|[[aclgroup]]:doesContainObject\|\|}}}}		{{New feature/item\|3.0141\|1.4.0\|6994\|{{OOP\|\|[[aclgroup]]:doesContainObject\|\|}}}}

Toliak: I believe that argument `theObject` has the `object` type instead of `string`

2021-09-01T19:46:37Z

I believe that argument `theObject` has the `object` type instead of `string`

← Older revision		Revision as of 19:46, 1 September 2021
Line 6:		Line 6:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool isObjectInACLGroup ( ~~string~~ theObject, aclgroup theGroup )		bool isObjectInACLGroup ( object theObject, aclgroup theGroup )
	</syntaxhighlight>		</syntaxhighlight>
	{{New feature/item\|3.0141\|1.4.0\|6994\|{{OOP\|\|[[aclgroup]]:doesContainObject\|\|}}}}		{{New feature/item\|3.0141\|1.4.0\|6994\|{{OOP\|\|[[aclgroup]]:doesContainObject\|\|}}}}

Qwe7769611 at 08:38, 5 February 2021

2021-02-05T08:38:33Z

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

Qaisjp: important note

2019-09-07T08:38:26Z

important note

← Older revision		Revision as of 08:38, 7 September 2019
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server function}}		{{Server function}}
	{{Note\|You must '''NOT''' to use this function to limit features to users that belong to specific groups. Instead you '''MUST''' use [[hasObjectPermissionTo]]. Using this function forces the server owner to name their group a certain way, whereas using hasObjectPermissionTo allows the owner to give permission for whatever features you restrict to whatever groups they have set up in their ACL.}}		{{Important Note\|You must '''NOT''' to use this function to limit features to users that belong to specific groups. Instead you '''MUST''' use [[hasObjectPermissionTo]]. Using this function forces the server owner to name their group a certain way, whereas using hasObjectPermissionTo allows the owner to give permission for whatever features you restrict to whatever groups they have set up in their ACL.}}
	This function is used to determine if an object is in a group.		This function is used to determine if an object is in a group.

Qaisjp: prefer normal note

2019-09-07T08:38:13Z

prefer normal note

← Older revision		Revision as of 08:38, 7 September 2019
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server function}}		{{Server function}}
	{{~~Note_box~~\|It'~~s recommended~~ ''~~not~~'' to use this function to limit features to users that belong to specific groups. Instead use [[hasObjectPermissionTo]]. Using this function forces the server owner to name their group a certain way, whereas using hasObjectPermissionTo allows the owner to give permission for whatever features you restrict to whatever groups they have set up in their ACL.}}		{{Note\|You must '''NOT''' to use this function to limit features to users that belong to specific groups. Instead you '''MUST''' use [[hasObjectPermissionTo]]. Using this function forces the server owner to name their group a certain way, whereas using hasObjectPermissionTo allows the owner to give permission for whatever features you restrict to whatever groups they have set up in their ACL.}}
	This function is used to determine if an object is in a group.		This function is used to determine if an object is in a group.

Fabervox: Undo revision 50123 by Marcin778 (talk)

2017-01-01T18:39:03Z

Undo revision 50123 by Marcin778 (talk)

← Older revision		Revision as of 18:39, 1 January 2017
Line 1:		Line 1:
	~~Extrem liże hazowi dupsko~~ a ~~Barcioo liże cipsko Trinowi~~		__NOTOC__
	~~Extrem liże hazowi dupsko~~ a ~~Barcioo liże cipsko Trinowi~~		{{Server function}}
	~~Extrem liże hazowi dupsko~~ a ~~Barcioo liże cipsko Trinowi~~		{{Note_box\|It's recommended ''not'' to use this function to limit features to users that belong to specific groups. Instead use [[hasObjectPermissionTo]]. Using this function forces the server owner to name their group a certain way, whereas using hasObjectPermissionTo allows the owner to give permission for whatever features you restrict to whatever groups they have set up in their ACL.}}
	~~Extrem liże hazowi dupsko~~ a ~~Barcioo liże cipsko Trinowi~~		This function is used to determine if an object is in a group.
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~		==Syntax==
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~		<syntaxhighlight lang="lua">
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~		bool isObjectInACLGroup ( string theObject, aclgroup theGroup )
	~~Extrem liże hazowi dupsko~~ a ~~Barcioo liże cipsko Trinowi~~		</syntaxhighlight>
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~		{{New feature/item\|3.0141\|1.4.0\|6994\|{{OOP\|\|[[aclgroup]]:doesContainObject\|\|}}}}
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~		===Required Arguments===
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~		*'''theObject:''' the name of the object to check. Examples: "resource.ctf", "user.Jim".
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~		*'''theGroup:''' the [[ACL group]] pointer of the group from which the object should be found.
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~		===Returns===
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~		Returns ''true'' if the object is in the specified group, ''false'' otherwise.
	~~Extrem liże hazowi dupsko~~ a ~~Barcioo liże cipsko Trinowi~~
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~		==Example==
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~		''' Example 1:''' This example adds a ''jetpack'' command that is only available to admins. When entering the command, it will toggle the player's jetpack.
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~		<syntaxhighlight lang="lua">
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~		addCommandHandler ( "jetpack",
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~		function ( thePlayer )
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~		if doesPedHaveJetPack ( thePlayer ) then -- If the player have a jetpack already, remove it
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~		removePedJetPack ( thePlayer ) -- Remove the jetpack
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~		return -- And stop the function here
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~		end
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~		-- Otherwise, give him one if he has access
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~		local accName = getAccountName ( getPlayerAccount ( thePlayer ) ) -- get his account name
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~		if isObjectInACLGroup ("user."..accName, aclGetGroup ( "Admin" ) ) then -- Does he have access to Admin functions?
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~		if not doesPedHaveJetPack ( thePlayer ) then -- If the player doesn't have a jetpack give it.
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~		givePedJetPack ( thePlayer ) -- Give the jetpack
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~		end
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~		end
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~		end
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~		)
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~		</syntaxhighlight>
	~~Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi~~
			'''Example 2:''' This example displays a list of all the online admins in the chat box (assuming your administrator's group in your ACL is called 'admin'):
			<syntaxhighlight lang="lua">
			players = getElementsByType ( "player" )
			admins = ""
			for k,v in ipairs(players) do
			local accountname = ""
			if (isGuestAccount(getPlayerAccount(v)) == false) then
			accountname = getAccountName (getPlayerAccount(v))
			if isObjectInACLGroup ( "user." .. accountname, aclGetGroup ( "admin" ) ) then
			if (admins == "") then
			admins = getPlayerName(v)
			else
			admins = admins .. ", " .. getPlayerName(v)
			end
			end
			end
			end
			outputChatBox( "Online Admins:", getRootElement(), 255, 255, 0)
			outputChatBox( " " .. tostring ( admins ), getRootElement(), 255, 255, 0)
			</syntaxhighlight>

			==See Also==
			{{ACL_functions}}

Marcin778 at 18:17, 1 January 2017

2017-01-01T18:17:28Z

← Older revision		Revision as of 18:17, 1 January 2017
Line 1:		Line 1:
	~~__NOTOC__~~		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	~~{{Server function}}~~		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	{{Note_box\|It's recommended ''not'' to use this function to limit features to users that belong to specific groups. Instead use [[hasObjectPermissionTo]]. Using this function forces the server owner to name their group a ~~certain way, whereas using hasObjectPermissionTo allows the owner to give permission for whatever features you restrict to whatever groups they have set up in their ACL.}}~~		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	~~This function is used to determine if an object is in~~ a ~~group.~~		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
			Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	~~==Syntax==~~		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	~~<syntaxhighlight lang="lua">~~		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	~~bool isObjectInACLGroup ( string theObject, aclgroup theGroup )~~		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	~~</syntaxhighlight>~~		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	~~{{New feature/item\|3.0141\|1.4.0\|6994\|{{OOP\|\|[[aclgroup]]:doesContainObject\|\|}}}}~~		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	~~===Required Arguments===~~		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	*'''theObject:''' the name of the object to check. Examples: "resource.ctf", "user.Jim".		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	*'''theGroup:''' the [[ACL group]] pointer of the group from which the object should be found.		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
			Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	~~===Returns===~~		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	~~Returns ''true'' if the object is in the specified group, ''false'' otherwise.~~		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
			Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	~~==Example==~~		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	~~''' Example 1:''' This example adds~~ a ~~''jetpack'' command that is only available to admins. When entering the command, it will toggle the player's jetpack.~~		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	~~<syntaxhighlight lang="lua">~~		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	~~addCommandHandler ( "jetpack",~~		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	~~function ( thePlayer )~~		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	~~if doesPedHaveJetPack ( thePlayer ) then -- If the player have~~ a ~~jetpack already, remove it~~		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	~~removePedJetPack ( thePlayer ) -- Remove the jetpack~~		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	~~return -- And stop the function here~~		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	~~end~~		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
			Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	~~-- Otherwise, give him one if he has access~~		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
			Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	~~local accName = getAccountName ( getPlayerAccount ( thePlayer ) ) -- get his account name~~		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	~~if isObjectInACLGroup ("user."..accName, aclGetGroup ( "Admin" ) ) then -- Does he have access to Admin functions?~~		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	~~if not doesPedHaveJetPack ( thePlayer ) then -- If the player doesn't have~~ a ~~jetpack give it.~~		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	~~givePedJetPack ( thePlayer ) -- Give the jetpack~~		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	~~end~~		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	~~end~~		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	~~end~~		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	)		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	~~</syntaxhighlight>~~		Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
			Extrem liże hazowi dupsko a Barcioo liże cipsko Trinowi
	~~'''Example 2:''' This example displays~~ a ~~list of all the online admins in the chat box (assuming your administrator's group in your ACL is called 'admin'):~~
	~~<syntaxhighlight lang="lua">~~
	~~players = getElementsByType ( "player" )~~
	~~admins = ""~~
	~~for k,v in ipairs(players) do~~
	~~local accountname = ""~~
	~~if (isGuestAccount(getPlayerAccount(v)) == false) then~~
	~~accountname = getAccountName (getPlayerAccount(v))~~
	~~if isObjectInACLGroup ( "user." .. accountname, aclGetGroup ( "admin" ) ) then~~
	~~if (admins == "") then~~
	~~admins = getPlayerName(v)~~
	~~else~~
	~~admins = admins .. ", " .. getPlayerName(v)~~
	~~end~~
	~~end~~
	~~end~~
	~~end~~
	~~outputChatBox( "Online Admins:", getRootElement(), 255, 255, 0)~~
	~~outputChatBox( " " .. tostring ( admins ), getRootElement(), 255, 255, 0)~~
	~~</syntaxhighlight>~~

	~~==See Also==~~
	~~{{ACL_functions}}~~