Difference between revisions of "cmf menu fnc toggleHUDAction"

Latest revision as of 22:02, 17 December 2022

Hover & click on the images for description

Description

Description:: This is an internal function of menu. It will allow for toggling the HUD so players can take in-mission screenshots without any HUD elements.
⚠
This is an internal function. This means that the function is called by another function and should not be called manually.
Execution:: Call
Groups:: CMF3: menu

Syntax

Examples

Example 1:

[] call cmf_menu_fnc_toggleHUDAction;

Additional Information

See also:: cmf_menu_fnc_delayedSafestartAction cmf_menu_fnc_displayRolesAction cmf_menu_fnc_fixLoadingBug cmf_menu_fnc_fixMapAction cmf_menu_fnc_init cmf_menu_fnc_viewDistanceAction

Internal Variables

Locality	Namespace	Name	Description
LOCAL	Mission	cmf_menu_hud_default	A variable that contains the default showHUD parameters
LOCAL	Mission	cmf_menu_hud_show	A Boolean variable that tracks whether the HUD is shown or not.

Events

Locality	Name	Variables	Description
LOCAL	cmf_menu_onHUDHidden	[ ]	Is fired locally for player when the HUD gets hidden.
LOCAL	cmf_menu_onHUDShown	[ ]	Is fired locally for player when the HUD gets shown.

Notes

: Posted on December 17, 2022 - 18:17 (UTC+1)
Eric: This function can also be activated with configurable keybinds found in CBA: "Addon Keybinds" >> "CMF: Common". By default it's bound to CTRL + TAB

@@ Line 20: / Line 20: @@
 |x1= {{code|lang=scilab|[] call cmf_menu_fnc_toggleHUDAction;}}
-|var1= {{!}} GLOBAL {{!}}{{!}} Unit {{!}}{{!}} cmf_menu_hud_default {{!}}{{!}} A variable that contains the default [https://community.bistudio.com/wiki/showHUD showHUD] parameters
+|seealso= [[cmf_menu_fnc_delayedSafestartAction]] [[cmf_menu_fnc_displayRolesAction]] [[cmf_menu_fnc_fixLoadingBug]]
-|var2= {{!}} GLOBAL {{!}}{{!}} Unit {{!}}{{!}} cmf_menu_hud_show {{!}}{{!}} A [https://community.bistudio.com/wiki/Boolean Boolean] variable that tracks whether the HUD is shown or not.
+[[cmf_menu_fnc_fixMapAction]] [[cmf_menu_fnc_init]] [[cmf_menu_fnc_viewDistanceAction]]
+|var1= {{!}} LOCAL {{!}}{{!}} Mission {{!}}{{!}} cmf_menu_hud_default {{!}}{{!}} A variable that contains the default [https://community.bistudio.com/wiki/showHUD showHUD] parameters
+|var2= {{!}} LOCAL {{!}}{{!}} Mission {{!}}{{!}} cmf_menu_hud_show {{!}}{{!}} A [https://community.bistudio.com/wiki/Boolean Boolean] variable that tracks whether the HUD is shown or not.
 |event1= {{!}} LOCAL {{!}}{{!}} cmf_menu_onHUDHidden {{!}}{{!}} [ ] {{!}}{{!}} Is fired locally for player when the HUD gets hidden.