showHUD

From Bohemia Interactive Community
Revision as of 01:54, 6 April 2021 by Lou Montana (talk | contribs) (Text replacement - " <!-- (DIS)?CONTINUE Notes -->" to "")
Jump to navigation Jump to search
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.
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.03.147265 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 [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). System default: true
info: Boolean - show vehicle + soldier info (hides weapon info from the HUD as well). System default: true
radar: Boolean - show vehicle radar. System default: true
compass: Boolean - show vehicle compass. System default: true
direction: Boolean - show tank direction indicator (not present in vanilla Arma 3). System default: true
menu: Boolean - show commanding menu (hides HC related menus). System default: true
group: Boolean - show group info bar (hides squad leader info bar). System default: true
cursors: Boolean - show HUD weapon cursors (connected with scripted HUD). System default: true
panels: Boolean - show vehicle panels. System default: true
kills: Boolean - show "x killed by y" systemChat messages. System default: true
showIcon3D: Boolean - (Since Arma 3 v2.03.147265) show icons drawn with drawIcon3D even when the HUD is hidden. System default: false
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
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.