SetPlayerHudComponentVisible: Difference between revisions
Jump to navigation
Jump to search
Tag: Reverted |
Tag: Rollback |
||
Line 66: | Line 66: | ||
==Example== | ==Example== | ||
<section name="Server" class="server" show="true"> | <section name="Server" class="server" show="true"> | ||
This example hides the ammo and weapon displays for players when they join | This example hides the ammo and weapon displays for players when they join. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- Hide some of the hud components when a player joins the server | -- Hide some of the hud components when a player joins the server | ||
addEventHandler ( "onPlayerJoin", root, | addEventHandler ( "onPlayerJoin", root, | ||
function () | function () | ||
setPlayerHudComponentVisible ( source, "ammo", false ) -- Hide the ammo displays for the newly joined player | 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 | setPlayerHudComponentVisible ( source, "weapon", false ) -- Hide the weapon displays for the newly joined player | ||
end | end | ||
) | ) | ||
Line 79: | Line 79: | ||
<section name="Client" class="client" show="true"> | <section name="Client" class="client" show="true"> | ||
This example hides the weapon icon, weapon ammo, health bar, clock, money, breath bar, armor bar & wanted level stars displays for players when they join | This example hides the weapon icon, weapon ammo, health bar, clock, money, breath bar, armor bar & wanted level stars displays for players when they join. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- Hide the hud when the resource is started | -- Hide the hud when the resource is started | ||
local components = { "weapon", "ammo", "health", "clock", "money", "breath", "armour", "wanted" } | local components = { "weapon", "ammo", "health", "clock", "money", "breath", "armour", "wanted" } | ||
Revision as of 08:25, 27 July 2021
This function will show or hide a part of the player's HUD.
Syntax
Click to collapse [-]
Serverbool setPlayerHudComponentVisible ( player thePlayer, string component, bool show )
OOP Syntax Help! I don't understand this!
- Method: 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
- 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)
Click to collapse [-]
Clientbool setPlayerHudComponentVisible ( string component, bool show )
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
- 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)
Returns
Returns true if the component was shown or hidden succesfully, false if an invalid argument was specified.
Requirements
This template will be deleted.
Example
Click to collapse [-]
ServerThis example hides the ammo and weapon displays for players when they join.
-- 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 )
Click to collapse [-]
ClientThis example hides the weapon icon, weapon ammo, health bar, clock, money, breath bar, armor bar & wanted level stars displays for players when they join.
-- Hide the hud when the resource is started local components = { "weapon", "ammo", "health", "clock", "money", "breath", "armour", "wanted" } addEventHandler("onClientResourceStart", getResourceRootElement(getThisResource()), function () for _, component in ipairs( components ) do setPlayerHudComponentVisible( component, false ) end end)
See Also
- getPlayerTeam
- getPlayerBlurLevel
- setPlayerBlurLevel
- getPlayerSerial
- forcePlayerMap
- getPlayerScriptDebugLevel
- getPlayerFromName
- getPlayerMoney
- getPlayerName
- getPlayerNametagColor
- getPlayerNametagText
- getPlayerPing
- getPlayerWantedLevel
- givePlayerMoney
- isPlayerMapForced
- isPlayerNametagShowing
- setPlayerHudComponentVisible
- setPlayerMoney
- setPlayerNametagColor
- setPlayerNametagShowing
- setPlayerNametagText
- takePlayerMoney
- countPlayersInTeam
- getPlayersInTeam
- isVoiceEnabled
- setControlState
- getControlState