ShowPlayerHudComponent: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__
{{Server client function}}
This function will show or hide a part of the player's HUD.  
This function will show or hide a part of the player's HUD.  


Line 27: Line 28:
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">
-- Make our hudChanger function called when the player joins
addEventHandler ( "onPlayerJoin", getRootElement(), "hudChanger" )
function hudChanger ()
function hudChanger ()
     showPlayerHudComponent ( source, "ammo", false ) -- Hide the ammo displays for the newly joined player
     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
     showPlayerHudComponent ( source, "weapon", false ) -- Hide the weapon displays for the newly joined player
end
end
-- Make our hudChanger function called when the player joins
addEventHandler ( "onPlayerJoin", getRootElement(), hudChanger )
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Player_functions}}
{{Player_functions}}

Revision as of 18:26, 15 August 2007

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

Syntax

bool showPlayerHudComponent ( player thePlayer, string component, bool show )

Required Arguments

  • thePlayer: description
  • 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
  • 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
  • show: Specify if the componenet 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

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=10362"