shownHUD: Difference between revisions

Latest revision as of 06:54, 4 April 2026

1.52

Hover & click on the images for description

Description

Description:: Returns array of Booleans corresponding to the visibility of various HUD elements (see extended showHUD).
Groups:: Interaction

Syntax

Syntax:

shownHUD

Return Value:

Array with [hud, info, radar, compass, direction, menu, group, cursors, panels, kills, icon3d]

hud: Boolean - show scripted HUD such as weapon crosshair, action menu and overlays created with cutRsc and titleRsc
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
kills: Boolean - (Optional, default true) show "x killed by y" systemChat messages
icon3d: Boolean - (Optional, default false) show icons drawn with drawIcon3D even when the HUD is hidden

Examples

Example 1:: _hudStatus = shownHUD;
Example 2:: shownHUD params ["_hud", "_info", "_radar", "_compass", "_direction", "_menu", "_group", "_cursors", "_panels", "_kills", "_icon3d"];

Additional Information

See also:: showHUD shownMap visibleMap forceMap shownGPS shownWatch shownCompass shownUAVFeed

Notes

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

@@ Line 1: / Line 1: @@
-{{Command|= Comments
+{{RV|type=command
-____________________________________________________________________________________________
-| arma3 |= Game name
+|game1= arma3
-|1.52|= Game version
+|version1= 1.52
-____________________________________________________________________________________________
-| Returns array of [[Boolean]]s corresponding to the visibility of various HUD elements (see extended [[showHUD]]). |= Description
+|gr1= Interaction
-____________________________________________________________________________________________
-| '''shownHUD''' |= Syntax
+|descr= Returns array of [[Boolean]]s corresponding to the visibility of various HUD elements (see extended [[showHUD]]).
-| [[Array]] in format [hud, info, radar, compass, direction, menu, group, cursors, panels] |= Return value
+|s1= [[shownHUD]]
-____________________________________________________________________________________________
-|x1= <code>_hudStatus = [[shownHUD]];</code> |= Example 1
-____________________________________________________________________________________________
-| [[showHUD]], [[shownMap]], [[visibleMap]], [[forceMap]], [[shownGPS]], [[shownWatch]], [[shownCompass]], [[shownUAVFeed]] |= See also
+|r1= [[Array]] with [hud, info, radar, compass, direction, menu, group, cursors, panels, kills, icon3d]
+* hud: [[Boolean]] - show scripted HUD such as weapon crosshair, action menu and overlays created with [[cutRsc]] and [[titleRsc]]
+* 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 {{arma3}}
+* 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]]
+* kills: [[Boolean]] - (Optional, default [[true]]) show "x killed by y" [[systemChat]] messages
+* icon3d: [[Boolean]] - (Optional, default [[false]]) show icons drawn with [[drawIcon3D]] even when the HUD is hidden
-}}
-<h3 style="display:none">Notes</h3>
+|x1= <sqf>_hudStatus = shownHUD;</sqf>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
+|x2= <sqf>shownHUD params ["_hud", "_info", "_radar", "_compass", "_direction", "_menu", "_group", "_cursors", "_panels", "_kills", "_icon3d"];</sqf>
-</dl>
-<h3 style="display:none">Bottom Section</h3>
+|seealso= [[showHUD]] [[shownMap]] [[visibleMap]] [[forceMap]] [[shownGPS]] [[shownWatch]] [[shownCompass]] [[shownUAVFeed]]
-[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
+}}
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
-[[Category:Arma 3: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]