ZH-CN/AclGetGroup - Revision history

Myonlake at 18:23, 21 February 2021

2021-02-21T18:23:06Z

← Older revision		Revision as of 18:23, 21 February 2021
Line 59:		Line 59:
	<!-- 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}}

			[[ar:aclGetGroup]]
	[[en:AclGetGroup]]		[[en:AclGetGroup]]
			[[zh-cn:AclGetGroup]]

Qwe7769611 at 03:35, 6 February 2021

2021-02-06T03:35:19Z

← Older revision		Revision as of 03:35, 6 February 2021
Line 2:		Line 2:
	{{Server function}}		{{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 -->
	~~This function is used to get the ACL group with the given name~~. ~~If you need most of the groups you should consider using~~ [[aclGroupList]] ~~instead to get a table containing them all~~.		此函数用于获取具有给定名称的ACL组.如果需要大多数组，应该考虑使用[[aclGroupList]]来获得包含所有组的表.

	==~~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 -->		<!-- 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">
	aclgroup aclGetGroup ( string groupName )		aclgroup aclGetGroup ( string groupName )
	</syntaxhighlight>		</syntaxhighlight>
	{{~~OOP~~\|This function is a static function underneath the ACL Group class.\|[[aclgroup\|ACLGroup]].get\|\|}}		{{OOP_ZH-CN\|This function is a static function underneath the ACL Group class.\|[[aclgroup\|ACLGroup]].get\|\|}}
	===~~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 -->
	*'''groupName:''' ~~The name to get the ACL group from~~		*'''groupName:''' 从中获取ACL组的名称

	===~~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 the ACL group if it could be found~~. ~~Returns false~~/nil ~~if it did not exist or failed for some reason~~.		返回ACL组（如果可以找到）.如果它不存在或由于某种原因失败，则返回false/nil.

	==~~Example~~==		==示例==

	'''~~Example~~ 1:''' ~~This example makes every player able to use a command named "giveAccountAdminRights" that will add a specific accountname as an ACL object to the "Admin" group~~.		'''例子 1:''' 这个例子使每个玩家都能使用一个名为“giveAccountAdminRights”的命令，该命令会将一个特定的账户名作为ACL对象添加到“Admin”组中.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function giveAdminRights (playerSource, commandName, accountName) --~~add the function giveAdminRights and specify its arguments~~		function giveAdminRights (playerSource, commandName, accountName) --添加函数giveAdminRights并指定其参数
	if accountName then --if there was an accountName entered then		if accountName then --if there was an accountName entered then
	aclGroupAddObject (aclGetGroup("Admin"), "user."..accountName)) --~~add an ACL object using the form "user~~.[accountName]~~" to the ACL group "Admin"~~		aclGroupAddObject (aclGetGroup("Admin"), "user."..accountName)) --使用“user.[accountName]”格式将ACL对象添加到ACL组“Admin”
	outputChatBox ("Account '"..accountName.."' succesfully added to the admin group", playerSource) --~~output a notification to the player who entered the command that the acocunt was successfully added~~		outputChatBox ("Account '"..accountName.."' succesfully added to the admin group", playerSource) --向输入命令的玩家输出一个通知，通知其acocunt已成功添加
	else --~~else output an error message and the correct syntax of the command to the player who entered it~~		else --否则，将错误消息和命令的正确语法输出给输入它的玩家
	outputChatBox ("No account name specified.", playerSource)		outputChatBox ("No account name specified.", playerSource)
	outputChatBox ("Correct syntax: /giveAccountAdminRights [accountName]", playerSource)		outputChatBox ("Correct syntax: /giveAccountAdminRights [accountName]", playerSource)
Line 32:		Line 32:
	end		end

	addCommandHandler ("giveAccountAdminRights", giveAdminRights) --~~add a command "giveAccountAdminRights" and attch the function "giveAdminRights" to it~~		addCommandHandler ("giveAccountAdminRights", giveAdminRights) --添加一个命令“giveAccountAdminRights”并将函数“giveAdminRights”添加到其中
	</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')~~:		'''例子 2:''' 此示例显示聊天框中所有在线管理员的列表（假设ACL中的管理员组名为“admin”）:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	players = getElementsByType ( "player" )		players = getElementsByType ( "player" )

Qwe7769611 at 09:03, 5 February 2021

2021-02-05T09:03:52Z

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

Qwe7769611: Created page with "NOTOC {{Server function}} This function is used to get the ACL g..."

2021-02-05T08:44:46Z

Created page with "__NOTOC__ {{Server function}}  This function is used to get the ACL g..."

New page

__NOTOC__
{{Server function}}

This function is used to get the ACL group with the given name. If you need most of the groups you should consider using [[aclGroupList]] instead to get a table containing them all.

==Syntax==

<syntaxhighlight lang="lua">
aclgroup aclGetGroup ( string groupName )
</syntaxhighlight>
{{OOP|This function is a static function underneath the ACL Group class.|[[aclgroup|ACLGroup]].get||}}
===Required Arguments===

*'''groupName:''' The name to get the ACL group from

===Returns===

Returns the ACL group if it could be found. Returns false/nil if it did not exist or failed for some reason.

==Example==

'''Example 1:''' This example makes every player able to use a command named "giveAccountAdminRights" that will add a specific accountname as an ACL object to the "Admin" group.
<syntaxhighlight lang="lua">
function giveAdminRights (playerSource, commandName, accountName) --add the function giveAdminRights and specify its arguments
if accountName then --if there was an accountName entered then
aclGroupAddObject (aclGetGroup("Admin"), "user."..accountName)) --add an ACL object using the form "user.[accountName]" to the ACL group "Admin"
outputChatBox ("Account '"..accountName.."' succesfully added to the admin group", playerSource) --output a notification to the player who entered the command that the acocunt was successfully added
else --else output an error message and the correct syntax of the command to the player who entered it
outputChatBox ("No account name specified.", playerSource)
outputChatBox ("Correct syntax: /giveAccountAdminRights [accountName]", playerSource)
end
end

addCommandHandler ("giveAccountAdminRights", giveAdminRights) --add a command "giveAccountAdminRights" and attch the function "giveAdminRights" to it
</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'):
<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}}
[[zh-cn:AclGetGroup]]

ZH-CN/AclGetGroup - Revision history

Myonlake at 18:23, 21 February 2021

Qwe7769611 at 03:35, 6 February 2021

Qwe7769611 at 09:03, 5 February 2021

Qwe7769611: Created page with "__NOTOC__ {{Server function}} This function is used to get the ACL g..."

Qwe7769611: Created page with "NOTOC {{Server function}} This function is used to get the ACL g..."