Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

---

This function will show or hide a part of the player's HUD.

OOP Syntax Help! I don't understand this!

• Method:player:setHudComponentVisible(...)

Syntax

bool setPlayerHudComponentVisible ( string component, bool show )

Required Arguments

• component: The component you wish to show or hide. Valid values are:
• show: MISSING_PARAM_DESC

Returns

• bool: value

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

Code Examples

Example 1 Example 2 Example 3

client

This example lets players hide or bring up their bottom-left radar with a command

function toggleRadar()
  state = not state
  setPlayerHudComponentVisible("radar", state)
end
addCommandHandler( "toggleradar", toggleRadar)

client

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.

-- 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)

server

This 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
)

See Also

Player Functions

• countPlayersInTeam
• forcePlayerMap
• getAlivePlayers
• getControlState
• getDeadPlayers
• getLocalPlayer
• getPlayerAnnounceValue
• getPlayerBlurLevel
• getPlayerCount
• getPlayerFromName
• getPlayerHudComponentProperty
• getPlayerIdleTime
• getPlayerIP
• getPlayerMapBoundingBox
• getPlayerMapOpacity
• getPlayerMoney
• getPlayerName
• getPlayerNametagColor
• getPlayerNametagText
• getPlayerPing
• getPlayerScriptDebugLevel
• getPlayerSerial
• getPlayersInTeam
• getPlayerTeam
• getPlayerVersion
• getPlayerWantedLevel
• getRandomPlayer
• givePlayerMoney
• isPlayerCrosshairVisible
• isPlayerHudComponentVisible
• isPlayerMapForced
• isPlayerMapVisible
• isPlayerMuted
• isPlayerNametagShowing
• isVoiceEnabled
• redirectPlayer
• resendPlayerACInfo
• resendPlayerModInfo
• resetPlayerHudComponentProperty
• setControlState
• setPlayerAnnounceValue
• setPlayerBlurLevel
• setPlayerHudComponentProperty
• setPlayerHudComponentVisible
• setPlayerMoney
• setPlayerMuted
• setPlayerName
• setPlayerNametagColor
• setPlayerNametagShowing
• setPlayerNametagText
• setPlayerScriptDebugLevel
• setPlayerTeam
• setPlayerVoiceBroadcastTo
• setPlayerVoiceIgnoreFrom
• setPlayerWantedLevel
• spawnPlayer
• takePlayerMoney
• takePlayerScreenShot

Player Events

• onClientPlayerChangeNick
• onClientPlayerChoke
• onClientPlayerDamage
• onClientPlayerHeliKilled
• onClientPlayerHitByWaterCannon
• onClientPlayerJoin
• onClientPlayerPickupHit
• onClientPlayerPickupLeave
• onClientPlayerQuit
• onClientPlayerRadioSwitch
• onClientPlayerSpawn
• onClientPlayerStealthKill
• onClientPlayerStuntFinish
• onClientPlayerStuntStart
• onClientPlayerTarget
• onClientPlayerVehicleEnter
• onClientPlayerVehicleExit
• onClientPlayerVoicePause
• onClientPlayerVoiceResumed
• onClientPlayerVoiceStart
• onClientPlayerVoiceStop
• onClientPlayerWasted
• onClientPlayerWeaponFire
• onClientPlayerWeaponSwitch
• onPlayerACInfo
• onPlayerBan
• onPlayerChangeNick
• onPlayerChangesProtectedData
• onPlayerChangesWorldSpecialProperty
• onPlayerChat
• onPlayerClick
• onPlayerCommand
• onPlayerConnect
• onPlayerContact
• onPlayerDamage
• onPlayerDetonateSatchels
• onPlayerDiscordJoin
• onPlayerJoin
• onPlayerLogin
• onPlayerLogout
• onPlayerMarkerHit
• onPlayerMarkerLeave
• onPlayerModInfo
• onPlayerMute
• onPlayerNetworkStatus
• onPlayerPickupHit
• onPlayerPickupLeave
• onPlayerPickupUse
• onPlayerPrivateMessage
• onPlayerProjectileCreation
• onPlayerQuit
• onPlayerScreenShot
• onPlayerSpawn
• onPlayerStealthKill
• onPlayerTarget
• onPlayerTeamChange
• onPlayerTeleport
• onPlayerTriggerEventThreshold
• onPlayerTriggerInvalidEvent
• onPlayerUnmute
• onPlayerVehicleEnter
• onPlayerVehicleExit
• onPlayerVoiceStart
• onPlayerVoiceStop
• onPlayerWasted
• onPlayerWeaponFire
• onPlayerWeaponReload
• onPlayerWeaponSwitch

Reference

• Scripting Functions