IsPlayerHudComponentVisible - Revision history

Fernando187: Remove obsolete Requirements section

2024-11-07T17:08:24Z

Remove obsolete Requirements section

← Older revision		Revision as of 17:08, 7 November 2024
Line 42:		Line 42:
	end		end
	end)</syntaxhighlight>		end)</syntaxhighlight>

	~~==Requirements==~~
	~~{{Requirements\|n/a\|1.3.1-9.04689\|}}~~

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

Ccw at 20:46, 6 October 2013

2013-10-06T20:46:20Z

← Older revision		Revision as of 20:46, 6 October 2013
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{~~Server client~~ function}}		{{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">~~
	~~<syntaxhighlight lang="lua">~~
	~~bool isPlayerHudComponentVisible( player thePlayer, string component )~~
	~~</syntaxhighlight>~~

	~~===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~~
	~~{{New feature\|3.0110\|1.1\|~~
	~~:*'''radio:''' The display showing the radio label~~
	~~:*'''wanted:''' The display showing the player's wanted level~~
	~~:*'''crosshair:''' The weapon crosshair and sniper scope~~
	}}
	~~</section>~~
	~~<section name="Client" class="client" show="true">~~
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	bool isPlayerHudComponentVisible( string component )		bool isPlayerHudComponentVisible( string component )
Line 34:		Line 9:

	===Required Arguments===		===Required Arguments===
	*'''component:''' The component you wish to ~~show or hide~~. Valid values are:		*'''component:''' The component you wish to check. Valid values are:
	:*'''ammo:''' The display showing how much ammo the player has in their weapon		:*'''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		:*'''area_name:''' The text that appears containing the name of the area a player has entered
Line 50:		Line 25:
	:*'''crosshair:''' The weapon crosshair and sniper scope		:*'''crosshair:''' The weapon crosshair and sniper scope
	}}		}}
	~~</section>~~

	===Returns===		===Returns===
Line 56:		Line 30:

	==Example==		==Example==
	~~<section name="Client" class="client" show="true">~~
	<syntaxhighlight lang="lua">addEventHandler("onClientResourceStart",resourceRoot,function()		<syntaxhighlight lang="lua">addEventHandler("onClientResourceStart",resourceRoot,function()
	local components = {"ammo","area_name","armour","breath","clock","health","money",		local components = {"ammo","area_name","armour","breath","clock","health","money",
Line 69:		Line 42:
	end		end
	end)</syntaxhighlight>		end)</syntaxhighlight>
	~~</section>~~

	==Requirements==		==Requirements==

X86dev at 12:50, 5 June 2013

2013-06-05T12:50:25Z

← Older revision		Revision as of 12:50, 5 June 2013
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	~~{{New feature/item\|4.0132\|1.3.1\|4689\|~~
	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">

Jaysds1: /* Example */

2013-05-05T21:50:17Z

Example

← Older revision		Revision as of 21:50, 5 May 2013
Line 57:		Line 57:
	Returns ''true'' if the component is visable, ''false'' if not.		Returns ''true'' if the component is visable, ''false'' if not.

	==Example==		==Example==
	<syntaxhighlight lang="lua">		<section name="Client" class="client" show="true">
	-- ~~Todo~~		<syntaxhighlight lang="lua">addEventHandler("onClientResourceStart",resourceRoot,function()
	</syntaxhighlight>		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)</syntaxhighlight>
			</section>

	==Requirements==		==Requirements==

Danilo at 09:25, 12 March 2013

2013-03-12T09:25:08Z

← Older revision		Revision as of 09:25, 12 March 2013
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
			{{New feature/item\|4.0132\|1.3.1\|4689\|
	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==

Line 60:		Line 61:
	-- Todo		-- Todo
	</syntaxhighlight>		</syntaxhighlight>

			==Requirements==
			{{Requirements\|n/a\|1.3.1-9.04689\|}}

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

Jaysds1 at 05:07, 24 February 2013

2013-02-24T05:07:44Z

← Older revision		Revision as of 05:07, 24 February 2013
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}
	This function can be used to check ~~wether~~ an hud component is visable or not.		This function can be used to check whether an hud component is visable or not.

	==Syntax==		==Syntax==

UniOnDennis at 18:17, 18 February 2013

2013-02-18T18:17:05Z

← Older revision	Revision as of 18:17, 18 February 2013
Line 1:	Line 1:
		__NOTOC__
		{{Server client function}}
		This function can be used to check wether an hud component is visable or not.

		==Syntax==

		<section name="Server" class="server" show="true">
		<syntaxhighlight lang="lua">
		bool isPlayerHudComponentVisible( player thePlayer, string component )
		</syntaxhighlight>

		===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
		{{New feature\|3.0110\|1.1\|
		:*'''radio:''' The display showing the radio label
		:*'''wanted:''' The display showing the player's wanted level
		:*'''crosshair:''' The weapon crosshair and sniper scope
		}}
		</section>
		<section name="Client" class="client" show="true">
		<syntaxhighlight lang="lua">
		bool isPlayerHudComponentVisible( string component )
		</syntaxhighlight>

		===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
		{{New feature/item\|3.0110\|1.1\|\|
		:*'''radio:''' The display showing the radio label
		:*'''wanted:''' The display showing the player's wanted level
		:*'''crosshair:''' The weapon crosshair and sniper scope
		}}
		</section>

		===Returns===
		Returns ''true'' if the component is visable, ''false'' if not.

		==Example==
		<syntaxhighlight lang="lua">
		-- Todo
		</syntaxhighlight>

		==See Also==
		{{Player_functions}}

X86dev: /* http://wiki.multitheftauto.com/wiki/MTA_Wiki:Editing_Guidelines */

2012-09-26T10:59:05Z

http://wiki.multitheftauto.com/wiki/MTA_Wiki:Editing_Guidelines

← Older revision		Revision as of 10:59, 26 September 2012
Line 1:		Line 1:
	~~{{client function}}~~
	~~__NOTOC__~~

	~~This function checks if the component is visible.~~

	~~==Syntax==~~
	~~<syntaxhighlight lang="lua"> bool isPlayerHudComponentVisible ( string component ) </syntaxhighlight>~~

	~~===Required===~~
	~~''' component: ''' The component to check.~~

	~~===Return===~~
	~~Returns true if the component is visible, else false.~~

	~~===Example===~~
	~~<syntaxhighlight lang="lua">addCommandHandler("isComponent",function(_,theComponent)~~
	~~if isPlayerHudComponentVisible(theComponent) then~~
	~~outputChatBox("Yes, the component "..theComponent.." is visible.")~~
	~~else~~
	~~outputChatBox("No, the component "..theComponent.." is not visible or might not exist.")~~
	~~end~~
	~~end)</syntaxhighlight>~~

	~~==See Also==~~
	~~{{Client_player_functions}}~~

Jaysds1: Created page with "{{client function}} NOTOC This function checks if the component is visible. ==Syntax== bool isPlayerHudComponentVisible ( string component ) ===Require..."

2012-09-26T03:20:00Z

Created page with "{{client function}} __NOTOC__ This function checks if the component is visible. ==Syntax== <syntaxhighlight lang="lua"> bool isPlayerHudComponentVisible ( string component ) </syntaxhighlight> ===Require..."

New page

{{client function}}
__NOTOC__

This function checks if the component is visible.

==Syntax==
<syntaxhighlight lang="lua"> bool isPlayerHudComponentVisible ( string component ) </syntaxhighlight>

===Required===
''' component: ''' The component to check.

===Return===
Returns true if the component is visible, else false.

===Example===
<syntaxhighlight lang="lua">addCommandHandler("isComponent",function(_,theComponent)
if isPlayerHudComponentVisible(theComponent) then
outputChatBox("Yes, the component "..theComponent.." is visible.")
else
outputChatBox("No, the component "..theComponent.." is not visible or might not exist.")
end
end)</syntaxhighlight>

==See Also==
{{Client_player_functions}}