showHUD: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <!-- (DIS)?CONTINUE Notes -->" to "")
m (formatting)
Line 2: Line 2:


|game1= arma2
|game1= arma2
|version1= 1.00
|version1= 1.00
|game2= arma2oa
|version2= 1.51
|game3= tkoh
|version3= 1.00
|game4= arma3
|version4= 0.50
|eff= local
|eff= local


Line 8: Line 22:


|descr= Enable / disable showing of HUD. Defines visibility of weapon crosshair and any informational tags that appear when pointing the weapon at an object as well as availability of the default action menu. Unfortunately, it also hides icons drawn with [[drawIcon3D]].
|descr= Enable / disable showing of HUD. Defines visibility of weapon crosshair and any informational tags that appear when pointing the weapon at an object as well as availability of the default action menu. Unfortunately, it also hides icons drawn with [[drawIcon3D]].
{{Feature | Informative | Appearance of HUD can also be controlled with [[Description.ext#showHUD|showHUD[]<nowiki/>]] param in Description.ext.}}
{{Feature|arma3| '''Since {{arma3}} v1.50''' there is a Description.ext's [[Description.ext#showHUD|showHUD[]<nowiki/>]] array param that is identical in format to the extended [[showHUD]] command. When present, it will disable [[showHUD]] command entirely, allowing mission makers to permanently alter visibility of some HUD elements.<br>
{{Feature|arma3| <u>Since {{arma3}} v1.50</u> there is a Description.ext's [[Description.ext#showHUD|showHUD[]<nowiki/>]] array param that is identical in format to the extended [[showHUD]] command. When present, it will disable [[showHUD]] command entirely, allowing mission makers to permanently alter visibility of some HUD elements.<br>
'''Since Arma 3 v2.04''' it is possible to force drawing of [[drawIcon3D]] icons when HUD is hidden. The icons will also show when custom camera is [[camCreate | created]] and the view is switched to it via [[switchCamera]] or [[cameraEffect]] provided [[cameraEffectEnableHUD]] is enabled. For more information see [[drawIcon3D]].}}
<u>Since Arma 3 v2.03.147265</u> it is possible to force drawing of [[drawIcon3D]] icons when HUD is hidden. The icons will also show when custom camera is [[camCreate | created]] and the view is switched to it via [[switchCamera]] or [[cameraEffect]] provided [[cameraEffectEnableHUD]] is enabled. For more information see [[drawIcon3D]].}}


|s1= [[showHUD]] enable
|s1= [[showHUD]] enable
Line 18: Line 31:
|r1= [[Nothing]]
|r1= [[Nothing]]


|s2= [[showHUD]] [hud, info, radar, compass, direction, menu, group, cursors, panels, kills]
|s2= [[showHUD]] [scriptedHUD, info radar, compass, direction, menu, group, cursors, panels, kills]


|p21= [hud, info, radar, compass, direction, menu, group, cursors, panels, kills]: [[Array]]
|p21= scriptedHUD: [[Boolean]] - Show scripted HUD such as weapon crosshair, action menu and overlays created with [[cutRsc]] and [[titleRsc]]. Same as [[showHUD]]'s first syntax


|p22= hud: [[Boolean]] - show scripted HUD (same as normal [[showHUD]] true/false). System default: [[true]]
|p22= info: [[Boolean]] (optional, default [[true]]) - Show vehicle, soldier and weapon info


|p23= info: [[Boolean]] - show vehicle + soldier info (hides weapon info from the HUD as well). System default: [[true]]
|p23= radar: [[Boolean]] (optional, default [[true]]) - Show vehicle radar


|p24= radar: [[Boolean]] - show vehicle radar. System default: [[true]]
|p24= compass: [[Boolean]] (optional, default [[true]]) - Show vehicle compass


|p25= compass: [[Boolean]] - show vehicle compass. System default: [[true]]
|p25= direction: [[Boolean]] (optional, default [[true]]) - Show tank direction indicator. Not present in vanilla {{arma3}}


|p26= direction: [[Boolean]] - show tank direction indicator (not present in vanilla Arma 3). System default: [[true]]
|p26= menu: [[Boolean]] (optional, default [[true]]) - Show commanding menu (HC related menus)


|p27= menu: [[Boolean]] - show commanding menu (hides HC related menus). System default: [[true]]
|p27= group: [[Boolean]] (optional, default [[true]]) - Show group info bar (Squad leader info bar)


|p28= group: [[Boolean]] - show group info bar (hides squad leader info bar). System default: [[true]]
|p28= cursors: [[Boolean]] (optional, default [[true]]) - Show HUD weapon cursors (connected with scripted HUD)


|p29= cursors: [[Boolean]] - show HUD weapon cursors (connected with scripted HUD). System default: [[true]]
|p29= panels: [[Boolean]] (optional, default [[true]]) - Show [[Arma 3: Custom Info]] {{Since|arma3|1.70|}}


|p30= panels: [[Boolean]] - show vehicle panels. System default: [[true]]
|p30= kills: [[Boolean]] (optional, default [[true]]) - Show "x killed by y" [[systemChat]] messages


|p31= kills: [[Boolean]] - show "x killed by y" [[systemChat]] messages. System default: [[true]]
|p31= showIcon3D: [[Boolean]] (optional, default [[false]]) - Show icons drawn with [[drawIcon3D]] even when the HUD is hidden {{Since|arma3|2.04|}}
 
|p32= showIcon3D: [[Boolean]] - (Since Arma 3 v2.03.147265) show icons drawn with [[drawIcon3D]] even when the HUD is hidden. System default: [[false]]


|r2= [[Nothing]]
|r2= [[Nothing]]
Line 48: Line 59:
|x1= <code>[[showHUD]] [[false]];</code>
|x1= <code>[[showHUD]] [[false]];</code>


|x2= Hide vehicle radar and compass:<code>[[showHUD]] [<nowiki/>[[true]], [[true]], [[false]], [[false]], [[true]], [[true]], [[true]], [[true]], [[true]]];</code>
|x2= Hide vehicle radar and compass:<code>[[showHUD]] [
  true, {{cc|scriptedHUD}}
  true, {{cc|info}}
  true, {{cc|radar}}
  true, {{cc|compass}}
  true, {{cc|direction}}
  true, {{cc|menu}}
  true, {{cc|group}}
  true, {{cc|cursors}}
  true, {{cc|panels}}
  true, {{cc|kills}}
  true {{cc|showIcon3D}}
];</code>


|x3= Check if HUD visibility is hardcoded in mission config and [[showHUD]] command is overriden:<code>_disabledShowHUD = [[isArray]] ([[missionConfigFile]] >> "showHUD");</code>
|x3= Check if HUD visibility is hardcoded in mission config and [[showHUD]] command is overriden:<code>_disabledShowHUD = [[isArray]] ([[missionConfigFile]] >> "showHUD");</code>


|seealso= [[shownHUD]], [[showCinemaBorder]], [[showSubtitles]], [[showWatch]], [[showRadio]], [[showMap]], [[showGPS]], [[showCompass]], [[showPad]], [[actionIDs]], [[actionParams]], [[addAction]], [[setUserActionText]], [[inGameUISetEventHandler]], [[inputAction]], [[removeAction]], [[removeAllActions]], [[action]]
|seealso= [[shownHUD]], [[showCinemaBorder]], [[showSubtitles]], [[showWatch]], [[showRadio]], [[showMap]], [[showGPS]], [[showCompass]], [[showPad]]
}}
}}


[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}


<dl class="command_description">
<dl class="command_description">
Line 66: Line 84:
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
<dd class="note">
<dd class="note">
param "cursors" controls visibility of the action menu as well as weapon cursors. However if 1st param "hud" hides and disables action menu, param "cursors" only hides it. So you get invisible action menu that is fully operational. [[inGameUISetEventHandler]] will still fire on interaction, giving the information about selected item on the action menu even if you cannot see it. Unfortunately it also hides icons drawn with [[drawIcon3D]].
The "cursors" parameter controls visibility of the action menu as well as weapon cursors. However if 1st param "hud" hides and disables action menu, param "cursors" only hides it. So you get invisible action menu that is fully operational. [[inGameUISetEventHandler]] will still fire on interaction, giving the information about selected item on the action menu even if you cannot see it. Unfortunately it also hides icons drawn with [[drawIcon3D]].
</dd>
</dd>
<dt><dt>
<dt><dt>

Revision as of 08:24, 14 April 2021

Logo A2.png1.00A2 OA Logo.png1.51tkoh logo small.png1.00Arma 3 logo black.png0.50
LELocal
Hover & click on the images for description

Description

Description:
Enable / disable showing of HUD. Defines visibility of weapon crosshair and any informational tags that appear when pointing the weapon at an object as well as availability of the default action menu. Unfortunately, it also hides icons drawn with drawIcon3D.
Arma 3
Since Arma 3 v1.50 there is a Description.ext's showHUD[] array param that is identical in format to the extended showHUD command. When present, it will disable showHUD command entirely, allowing mission makers to permanently alter visibility of some HUD elements.
Since Arma 3 v2.04 it is possible to force drawing of drawIcon3D icons when HUD is hidden. The icons will also show when custom camera is created and the view is switched to it via switchCamera or cameraEffect provided cameraEffectEnableHUD is enabled. For more information see drawIcon3D.
Groups:
Interaction

Syntax

Syntax:
showHUD enable
Parameters:
enable: Boolean
Return Value:
Nothing

Alternative Syntax

Syntax:
showHUD [scriptedHUD, info radar, compass, direction, menu, group, cursors, panels, kills]
Parameters:
scriptedHUD: Boolean - Show scripted HUD such as weapon crosshair, action menu and overlays created with cutRsc and titleRsc. Same as showHUD's first syntax
info: Boolean (optional, default true) - Show vehicle, soldier and weapon info
radar: Boolean (optional, default true) - Show vehicle radar
compass: Boolean (optional, default true) - Show vehicle compass
direction: Boolean (optional, default true) - Show tank direction indicator. Not present in vanilla Arma 3
menu: Boolean (optional, default true) - Show commanding menu (HC related menus)
group: Boolean (optional, default true) - Show group info bar (Squad leader info bar)
cursors: Boolean (optional, default true) - Show HUD weapon cursors (connected with scripted HUD)
panels: Boolean (optional, default true) - Show Arma 3: Custom Info Template:Since
kills: Boolean (optional, default true) - Show "x killed by y" systemChat messages
showIcon3D: Boolean (optional, default false) - Show icons drawn with drawIcon3D even when the HUD is hidden Template:Since
Return Value:
Nothing

Examples

Example 1:
showHUD false;
Example 2:
Hide vehicle radar and compass:showHUD [ true, // scriptedHUD true, // info true, // radar true, // compass true, // direction true, // menu true, // group true, // cursors true, // panels true, // kills true // showIcon3D ];
Example 3:
Check if HUD visibility is hardcoded in mission config and showHUD command is overriden:_disabledShowHUD = isArray (missionConfigFile >> "showHUD");

Additional Information

See also:
shownHUDshowCinemaBordershowSubtitlesshowWatchshowRadioshowMapshowGPSshowCompassshowPad

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note


Posted on August 17, 2015 - 17:08 (UTC)
Killzone Kid
The "cursors" parameter controls visibility of the action menu as well as weapon cursors. However if 1st param "hud" hides and disables action menu, param "cursors" only hides it. So you get invisible action menu that is fully operational. inGameUISetEventHandler will still fire on interaction, giving the information about selected item on the action menu even if you cannot see it. Unfortunately it also hides icons drawn with drawIcon3D.
Posted on March 1, 2020 - 14:33 (UTC)
POLPOX
showHUD falseremoves Contact's compass that shown in the top of the screen.
Retrieved from "https://community.bistudio.com/wiki?title=showHUD&oldid=255431"