showHUD: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Game name" to "|Game name=")
m (style fix)
 
(49 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma2 |Game name=
|game1= arma2
|version1= 1.00


|1.00|= Game version
|game2= arma2oa
|version2= 1.50


|eff = local|=
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| 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]].
|game4= arma3
<br><br>Appearance of HUD can also be controlled with [[Description.ext#showHUD|showHUD param in description.ext]]. '''NOTE:''' As of Arma 3 v1.49.131879 there is a ''showHUD[]'' array param, that is identical in format to the extended [[showHUD]] command. When ''showHUD[]'' array param is present in ''description.ext'', it will disable [[showHUD]] command entirely, allowing mission makers to permanently alter visibility of some HUD elements. |DESCRIPTION=
|version4= 0.50
____________________________________________________________________________________________


| '''showHUD''' enable |SYNTAX=
|eff= local


|p1= enable: [[Boolean]] |PARAMETER1=  
|gr1= Interaction


|p2= |PARAMETER2=  
|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|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>
'''Since {{arma3}} 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]].
}}
 
|s1= [[showHUD]] enable
 
|p1= enable: [[Boolean]]
 
|r1= [[Nothing]]


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


| [[Nothing]] |RETURNVALUE=
|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


| s2='''showHUD''' [hud, info, radar, compass, direction, menu, group, cursors, panels]|SYNTAX=
|p22= info: [[Boolean]] - (Optional, default [[true]]) show vehicle, soldier and weapon info


|p21= [hud, info, radar, compass, direction, menu, group, cursors, panels]: [[Array]] |PARAMETER1=
|p23= radar: [[Boolean]] - (Optional, default [[true]]) show vehicle radar


|p22= hud: [[Boolean]] - show scripted HUD (same as normal [[showHUD]] true/false)|PARAMETER2=
|p24= compass: [[Boolean]] - (Optional, default [[true]]) show vehicle compass
|p23= info: [[Boolean]] - show vehicle + soldier info (hides weapon info from the HUD as well)|PARAMETER3=
|p24= radar: [[Boolean]] - show vehicle radar|PARAMETER3=
|p25= compass: [[Boolean]] - show vehicle compass|PARAMETER3=
|p26= direction: [[Boolean]] - show tank direction indicator (not present in vanilla Arma 3)|PARAMETER3=
|p27= menu: [[Boolean]] - show commanding menu (hides HC related menus)|PARAMETER3=
|p28= group: [[Boolean]] - show group info bar (hides squad leader info bar)|PARAMETER3=
|p29= cursors: [[Boolean]] - show HUD weapon cursors (connected with scripted HUD)|PARAMETER3=
|p30= panels: [[Boolean]] - show vehicle panels|PARAMETER3=


| r2= [[Nothing]] |RETURNVALUE=
|p25= direction: [[Boolean]] - (Optional, default [[true]]) show tank direction indicator. Not present in vanilla {{arma3}}


|x1= <code>[[showHUD]] [[false]];</code>|EXAMPLE1=
|p26= menu: [[Boolean]] - (Optional, default [[true]]) show commanding menu (HC related menus)
|x2= Hide vehicle radar and compass:<code>[[showHUD]] <nowiki>[</nowiki>[[true]],[[true]],[[false]],[[false]],[[true]],[[true]],[[true]],[[true]]];</code>|EXAMPLE1=
|x3= Check if HUD visibility is hardcoded in mission config and [[showHUD]] command is overriden:<code>_disabledShowHUD = [[isArray]] ([[missionConfigFile]] >> "showHUD");</code>|EXAMPLE3=


|p27= group: [[Boolean]] - (Optional, default [[true]]) show group info bar (Squad leader info bar)


____________________________________________________________________________________________
|p28= cursors: [[Boolean]] - (Optional, default [[true]]) show HUD weapon cursors (connected with scripted HUD)


| [[shownHUD]], [[showCinemaBorder]], [[showSubtitles]], [[showWatch]], [[showRadio]], [[showMap]], [[showGPS]], [[showCompass]], [[showPad]],  [[actionIDs]], [[actionParams]], [[addAction]], [[setUserActionText]], [[inGameUISetEventHandler]], [[inputAction]], [[removeAction]], [[removeAllActions]], [[action]] |SEEALSO=  
|p29= panels: [[Boolean]] - (Optional, default [[true]]) show [[Arma 3: Custom Info]]
|p29since= arma3 1.70


| |MPBEHAVIOUR=  
|p30= kills: [[Boolean]] - (Optional, default [[true]]) show "x killed by y" [[systemChat]] messages
<!--
|p30= ?
-->


____________________________________________________________________________________________
|p31= showIcon3D: [[Boolean]] - (Optional, default [[false]]) - show icons drawn with [[drawIcon3D]] even when the HUD is hidden
}}
|p31since= arma3 2.04
 
|r2= [[Nothing]]
 
|x1= <sqf>showHUD false;</sqf>


<h3 style="display:none">Notes</h3>
|x2= Hide vehicle radar and compass:
<dl class="command_description">
<sqf>
<!-- Note Section BEGIN -->
showHUD [
true, // scriptedHUD
true, // info
true, // radar
true, // compass
true, // direction
true, // menu
true, // group
true, // cursors
true, // panels
true, // kills
true  // showIcon3D
];
</sqf>


<!-- Note Section END -->
|x3= Check if HUD visibility is hardcoded in mission config and [[showHUD]] command is overridden:
</dl>
<sqf>private _disabledShowHUD = isArray (missionConfigFile >> "showHUD");</sqf>


<h3 style='display:none'>Bottom Section</h3>
|seealso= [[shownHUD]] [[showCinemaBorder]] [[showSubtitles]] [[showWatch]] [[showRadio]] [[showMap]] [[showGPS]] [[showCompass]] [[showPad]]
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
}}
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]


<!-- CONTINUE Notes -->
{{Note
<dl class="command_description">
|user= Killzone_Kid
<dd class="notedate">Posted on August 17, 2015 - 17:08 (UTC)</dd>
|timestamp= 20150817190800
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
|text= The "cursors" parameter controls visibility of the action menu as well as weapon cursors.
<dd class="note">
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.
Last param, "cursors" controls visibility of the action menu as well as weapon cursors. However if 1st param "hud" hides and disables action menu, last 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]].
[[inGameUISetEventHandler]] will still fire on interaction, giving the information about selected item on the action menu even if you cannot see it.
</dd>
Unfortunately it also hides icons drawn with [[drawIcon3D]].
</dl>
}}
<!-- DISCONTINUE Notes -->
 
{{Note
|user= POLPOX
|timestamp= 20200301143300
|text= <sqf>showHUD false;</sqf> removes [[Arma 3 Contact|Contact]]'s compass that is shown at the top of the screen.
}}

Latest revision as of 09:26, 4 October 2024

Logo A2.png1.00A2 OA Logo.png1.50tkoh 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, showIcon3D]
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)
since Arma 3 logo black.png1.70
panels: Boolean - (Optional, default true) show Arma 3: Custom Info
kills: Boolean - (Optional, default true) show "x killed by y" systemChat messages
since Arma 3 logo black.png2.04
showIcon3D: Boolean - (Optional, default false) - show icons drawn with drawIcon3D even when the HUD is hidden
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 overridden:
private _disabledShowHUD = isArray (missionConfigFile >> "showHUD");

Additional Information

See also:
shownHUD showCinemaBorder showSubtitles showWatch showRadio showMap showGPS showCompass showPad

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
Killzone_Kid - c
Posted on Aug 17, 2015 - 19:08 (UTC)
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.
POLPOX - c
Posted on Mar 01, 2020 - 14:33 (UTC)
showHUD false;
removes Contact's compass that is shown at the top of the screen.
Retrieved from "https://community.bistudio.com/wiki?title=showHUD&oldid=369704"