showHUD: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|EXAMPLE1= |x3=" to "|EXAMPLE2= |x3=")
mNo edit summary
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{Command
____________________________________________________________________________________________


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


|1.00|Game version=
|gr1= Interaction |GROUP1=


|eff = local|=
|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]].
____________________________________________________________________________________________
{{Informative | Appearance of HUD can also be controlled with [[Description.ext#showHUD|showHUD[]<nowiki/>]] param in Description.ext.}}
{{Feature arma3| Since {{arma3}} v1.49.131879 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.}}


| 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]].
|s1= [[showHUD]] enable
<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=
____________________________________________________________________________________________


| '''showHUD''' enable |SYNTAX=
|p1= enable: [[Boolean]]


|p1= enable: [[Boolean]] |PARAMETER1=
|r1= [[Nothing]]


|p2= |PARAMETER2=


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


| [[Nothing]] |RETURNVALUE=
|p21= [hud, info, radar, compass, direction, menu, group, cursors, panels, kills]: [[Array]]


| s2='''showHUD''' [hud, info, radar, compass, direction, menu, group, cursors, panels]|SYNTAX2=
|p22= hud: [[Boolean]] - show scripted HUD (same as normal [[showHUD]] true/false)


|p21= [hud, info, radar, compass, direction, menu, group, cursors, panels]: [[Array]] |PARAMETER21=
|p23= info: [[Boolean]] - show vehicle + soldier info (hides weapon info from the HUD as well)


|p22= hud: [[Boolean]] - show scripted HUD (same as normal [[showHUD]] true/false)|PARAMETER2=
|p24= radar: [[Boolean]] - show vehicle radar
|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= compass: [[Boolean]] - show vehicle compass


|x1= <code>[[showHUD]] [[false]];</code>|EXAMPLE1=
|p26= direction: [[Boolean]] - show tank direction indicator (not present in vanilla Arma 3)
|x2= Hide vehicle radar and compass:<code>[[showHUD]] <nowiki>[</nowiki>[[true]],[[true]],[[false]],[[false]],[[true]],[[true]],[[true]],[[true]]];</code>|EXAMPLE2=


|x3= Check if HUD visibility is hardcoded in mission config and [[showHUD]] command is overriden:<code>_disabledShowHUD = [[isArray]] ([[missionConfigFile]] >> "showHUD");</code>|EXAMPLE3=
|p27= menu: [[Boolean]] - show commanding menu (hides HC related menus)


|p28= group: [[Boolean]] - show group info bar (hides squad leader info bar)


____________________________________________________________________________________________
|p29= cursors: [[Boolean]] - 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=
|p30= panels: [[Boolean]] - show vehicle panels


| |MPBEHAVIOUR=  
|p31= kills: [[Boolean]] - show "x killed by y" [[systemChat]] messages


____________________________________________________________________________________________
|r2= [[Nothing]]
 
 
|x1= <code>[[showHUD]] [[false]];</code>
 
|x2= Hide vehicle radar and compass:<code>[[showHUD]] [<nowiki/>[[true]], [[true]], [[false]], [[false]], [[true]], [[true]], [[true]], [[true]], [[true]]];</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]]
}}
}}


Line 63: Line 63:
<h3 style='display:none'>Bottom Section</h3>
<h3 style='display:none'>Bottom Section</h3>


[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]


<!-- CONTINUE Notes -->
<!-- CONTINUE Notes -->
Line 73: Line 73:
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
<dd class="note">
<dd class="note">
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]].
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]].
</dd>
 
<dd class="notedate">Posted on March 1, 2020 - 14:33 (UTC)</dd>
<dt class="note">[[User:POLPOX|POLPOX]]</dt>
<dd class="note">
<code>[[showHUD]] [[false]]</code>removes [[Arma 3 Contact|Contact]]'s compass that shown in the top of the screen.
</dd>
</dd>
</dl>
</dl>
<!-- DISCONTINUE Notes -->
<!-- DISCONTINUE Notes -->

Revision as of 20:27, 25 September 2020

Logo A2.png1.00
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.
ⓘ
Appearance of HUD can also be controlled with showHUD[] param in Description.ext.
Template:Feature arma3
Groups:
Interaction

Syntax

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

Alternative Syntax

Syntax:
showHUD [hud, info, radar, compass, direction, menu, group, cursors, panels, kills]
Parameters:
[hud, info, radar, compass, direction, menu, group, cursors, panels, kills]: Array
hud: Boolean - show scripted HUD (same as normal showHUD true/false)
info: Boolean - show vehicle + soldier info (hides weapon info from the HUD as well)
radar: Boolean - show vehicle radar
compass: Boolean - show vehicle compass
direction: Boolean - show tank direction indicator (not present in vanilla Arma 3)
menu: Boolean - show commanding menu (hides HC related menus)
group: Boolean - show group info bar (hides squad leader info bar)
cursors: Boolean - show HUD weapon cursors (connected with scripted HUD)
panels: Boolean - show vehicle panels
kills: Boolean - show "x killed by y" systemChat messages
Return Value:
Nothing

Examples

Example 1:
showHUD false;
Example 2:
Hide vehicle radar and compass:showHUD [true, true, false, false, true, true, true, true, true];
Example 3:
Check if HUD visibility is hardcoded in mission config and showHUD command is overriden:_disabledShowHUD = isArray (missionConfigFile >> "showHUD");

Additional Information

See also:
shownHUDshowCinemaBordershowSubtitlesshowWatchshowRadioshowMapshowGPSshowCompassshowPadactionIDsactionParamsaddActionsetUserActionTextinGameUISetEventHandlerinputActionremoveActionremoveAllActionsaction

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

Notes

Bottom Section

Posted on August 17, 2015 - 17:08 (UTC)
Killzone Kid
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.
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=162355"