ShowPlayerHudComponent

From Multi Theft Auto: Wiki
Jump to navigation Jump to search

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

Syntax

Click to collapse [-]
Server
bool showPlayerHudComponent ( player thePlayer, string component, bool show )

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:
  • 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
  • all: All of the above at the same time
  • show: Specify if the component should be shown (true) or hidden (false)
Click to collapse [-]
Client
bool showPlayerHudComponent ( string component, bool show )

Required Arguments

  • component: The component you wish to show or hide. Valid values are:
  • 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
  • all: All of the above at the same time
  • 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.

Example

Click to collapse [-]
Server

This example hides the ammo and weapon displays for players when they join. 

function hudChanger ()
    showPlayerHudComponent ( source, "ammo", false )    -- Hide the ammo displays for the newly joined player
    showPlayerHudComponent ( source, "weapon", false )  -- Hide the weapon displays for the newly joined player
end
-- Make our hudChanger function called when the player joins
addEventHandler ( "onPlayerJoin", getRootElement(), hudChanger )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/ShowPlayerHudComponent?oldid=25670"