IsPlayerHudComponentVisible: Difference between revisions
Jump to navigation
Jump to search
m (→Example) |
No edit summary |
||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server client function}} | {{Server client function}} | ||
This function can be used to check whether an hud component is visable or not. | This function can be used to check whether an hud component is visable or not. | ||
==Syntax== | ==Syntax== | ||
<section name="Server" class="server" show="true"> | <section name="Server" class="server" show="true"> | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> |
Revision as of 12:50, 5 June 2013
This function can be used to check whether an hud component is visable or not.
Syntax
Click to collapse [-]
Serverbool isPlayerHudComponentVisible( player thePlayer, string component )
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
- crosshair: The weapon crosshair and sniper scope
Click to collapse [-]
Clientbool isPlayerHudComponentVisible( string component )
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
- crosshair: The weapon crosshair and sniper scope
Returns
Returns true if the component is visable, false if not.
Example
Click to collapse [-]
ClientaddEventHandler("onClientResourceStart",resourceRoot,function() local components = {"ammo","area_name","armour","breath","clock","health","money", "radar","vehicle_name","weapon","radio","wanted","crosshair" } --Table filled with all the available components to check for _,component in ipairs(components)do if isPlayerHudComponentVisible(component)then --check if the component is visible outputChatBox("Hud Component: "..component.." is visible!") --if it is then tell the client that else outputChatBox("Hud Component: "..component.." is not visible!") --if it is not then tell the client that it isn't end end end)
Requirements
This template will be deleted.
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