__NOTOC__
{{Server client function}}
{{Note|This function is identical to [[showPlayerHudComponent]]}}
This function will show or hide a part of the player's HUD.

==Syntax==

<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
bool setPlayerHudComponentVisible ( player thePlayer, string component, bool show )
</syntaxhighlight>
{{OOP|This function is also a static function underneath the Player class.|[[player]]:setHudComponentVisible||}}
===Required Arguments===
*'''thePlayer:''' The player element for which you wish to show/hide a HUD component
*'''component:''' The component you wish to show or hide. Valid values are:
:*'''all:''' All of the following at the same time
:*'''ammo:''' The display showing how much ammo the player has in their weapon
:*'''area_name:''' The text that appears containing the name of the area a player has entered
:*'''armour:''' The display showing the player's armor
:*'''breath:''' The display showing the player's breath
:*'''clock:''' The display showing the in-game time
:*'''health:''' The display showing the player's health
:*'''money:''' The display showing how much money the player has
:*'''radar:''' The bottom-left corner miniradar
:*'''vehicle_name:''' The text that appears containing the player's vehicle name when the player enters a vehicle
:*'''weapon:''' The display showing the player's weapon
{{New feature|3.0110|1.1|
:*'''radio:''' The display showing the radio label
:*'''wanted:''' The display showing the player's wanted level
:*'''crosshair:''' The weapon crosshair and sniper scope
}}
*'''show:''' Specify if the component should be shown (''true'') or hidden (''false'')
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
bool setPlayerHudComponentVisible ( string component, bool show )
</syntaxhighlight>

===Required Arguments===
*'''component:''' The component you wish to show or hide. Valid values are:
:*'''all:''' All of the following at the same time
:*'''ammo:''' The display showing how much ammo the player has in their weapon
:*'''area_name:''' The text that appears containing the name of the area a player has entered
:*'''armour:''' The display showing the player's armor
:*'''breath:''' The display showing the player's breath
:*'''clock:''' The display showing the in-game time
:*'''health:''' The display showing the player's health
:*'''money:''' The display showing how much money the player has
:*'''radar:''' The bottom-left corner miniradar
:*'''vehicle_name:''' The text that appears containing the player's vehicle name when the player enters a vehicle
:*'''weapon:''' The display showing the player's weapon
{{New feature/item|3.0110|1.1||
:*'''radio:''' The display showing the radio label
:*'''wanted:''' The display showing the player's wanted level
:*'''crosshair:''' The weapon crosshair and sniper scope
}}
*'''show:''' Specify if the component should be shown (''true'') or hidden (''false'')
</section>

===Returns===
Returns ''true'' if the component was shown or hidden succesfully, ''false'' if an invalid argument was specified.

==Requirements==
{{Requirements|1.3.2|1.3.2}}

==Example==
<section name="Server" class="server" show="true">
This example hides the ammo and weapon displays for players when they join.
<syntaxhighlight lang="lua">
-- Hide some of the hud components when a player joins the server
addEventHandler ( "onPlayerJoin", root,
function ()
setPlayerHudComponentVisible ( source, "ammo", false ) -- Hide the ammo displays for the newly joined player
setPlayerHudComponentVisible ( source, "weapon", false ) -- Hide the weapon displays for the newly joined player
end
)
</syntaxhighlight>
</section>

==See Also==
{{Player_functions}}

2014-08-22T15:34:59Z

Jaysds: /* Syntax */ OOP

__NOTOC__
{{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.}}
This function is used to determine if an object is in a group.

==Syntax==
<syntaxhighlight lang="lua">
bool isObjectInACLGroup ( string theObject, aclgroup theGroup )
</syntaxhighlight>
{{OOP|This function is also a static function underneath the ACL Group class.|[[aclgroup]]:doesContainObject||}}
===Required Arguments===
*'''theObject:''' 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.

===Returns===
Returns ''true'' if the object is in the specified group, ''false'' otherwise.

==Example==
''' 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">
addCommandHandler ( "jetpack",
function ( thePlayer )
if doesPedHaveJetPack ( thePlayer ) then -- If the player have a jetpack already, remove it
removePedJetPack ( thePlayer ) -- Remove the jetpack
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
)
</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}}

AclDestroyGroup

2014-08-22T15:31:43Z

Jaysds: /* Syntax */ OOP

__NOTOC__
{{Server function}}

This function destroys the given ACL group. The destroyed ACL group will no longer be valid.

==Syntax==

<syntaxhighlight lang="lua">
bool aclDestroyGroup ( aclgroup aclGroup )
</syntaxhighlight>
{{OOP|This function is also a static function underneath the ACL Group class.|[[aclgroup]]:destroy||}}
===Required Arguments===

*'''aclGroup:''' The [[aclgroup]] element to destroy

===Returns===

Returns ''true'' if the ACL group was successfully deleted, ''false'' if it could not be deleted for some reason (ie. invalid argument).

==Example==

This example allows admins to remove an ACL group they specify.

<syntaxhighlight lang="lua">
function removeACLGroup ( source, command, groupName )
-- Check if they're an admin...
if ( isObjectInACLGroup ( "user." .. getAccountName ( getPlayerAccount ( source )), aclGetGroup ( "Admin" ) ) ) then
if ( groupName ) then -- Check if they specified the group name
local group = aclGetGroup ( groupName ) -- Return any groups matching the name
if ( group ) then -- If any were returned then...
aclDestroyGroup ( group ) -- Destroy that group
else
-- Tell them if no groups with that name were found...
outputChatBox ( "No group with that name was found.", source, 255, 0, 0 )
end

else -- If they didn't specify the group
outputChatBox ( "Please specify the group name.", source, 255, 0, 0 ) -- Tell them that they must
end
else -- If they're not an admin....
outputChatBox ( "You must be an admin to use this command", source, 255, 0, 0 ) -- Tell them it's restricted
end
end
addCommandHandler ( "removeACL", removeACLGroup ) -- Make it happen when somebody types "/removeACL"
</syntaxhighlight>

==See Also==

{{ACL_functions}}