showHUD

From Bohemia Interactive Community
Revision as of 19:27, 25 September 2020 by R3vo (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Introduced with Arma 2 version 1.001.00Effects of this scripting command are not broadcasted over the network and remain local to the client the command is executed on
Hover & click on the images for descriptions

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.
Arma 3 logo black.png
Since Arma 3 v1.49.131879 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.

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
Groups:
Interaction

Notes

i
Only post proven facts here. Report bugs on the Feedback Tracker and discuss on the Arma Discord or on the Forums.

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.