BIS_fnc_3DENControlsHint

From Bohemia Interactive Community
Revision as of 04:34, 23 July 2017 by Larrow (talk | contribs)
Jump to navigation Jump to search
Introduced with Arma 3 version 1.00
  

Click on the images for descriptions

Introduced in

Game:
Arma 3
Version:
1.00

Description

Description:
Used by Eden to display control hints for the current Eden operation. As seen in the bottom right corner of the Editor display. Mostly non consumable for the end user except for three modes..
  • "show" - Shows controls hints
  • "hide" - Hides controls hints
  • "toggle" - Toggles controls hints

Syntax

Syntax:
[ mode ] call BIS_fnc_3DENControlsHint;
Parameters:
mode : String - Mode to use, is case sensitive
Return Value:
Nothing

Examples

Example 1:
Toggle Eden controls hints [ "toggle" ] call BIS_fnc_3DENControlsHint;

Additional Information

Execution:
call
Multiplayer:
-
See also:
See also needed

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Bottom Section

Posted on July 23, 2017 - 02:34 (UTC)
Larrow
Although a lot of this function may be of no use to the end user there are a number of UINamespace variables a designer may find helpful

uiNamespace getVariable "bis_fnc_3DENControlsHint_selected"
default - [0,[0,0,0,0,0,0],[[],[],[],[],[],[]]]
0 - total number of selected Eden entities
1 - count of selected Eden entities by type
0 - units
1 - groups
2 - triggers
3 - waypoints
4 - logics/systems/modules
5 - markers
2 - same results as get3DENSelected "" . Which is the same order as above for counts

uiNamespace getVariable "bis_fnc_3DENControlsHint_place"
default - [ "", false ]
0 - Class name of current Eden entity being placed
1 - true if class simulation type is a kind of vehicle
["car","carx","tank","tankx","helicopter","helicopterx",
"helicopterrtd","airplane","airplanex","ship","shipx",
"submarinex","hovercraftx","motorcycle","parachute","paraglide"]

uiNamespace getVariable "bis_fnc_3DENControlsHint_mouseButtons"
default - [false,false]
0 - left mouse button is down in Asset tree
1 - right mouse button is down in Asset tree

uiNamespace getVariable "bis_fnc_3DENControlsHint_connect"
default - [ "", "" ]
0 - text description of current connection being made eg "Sync to"
1 - config path to CfgWrapperUI cursor texture

uiNamespace getVariable "bis_fnc_3DENControlsHint_pos"
default - [1.40902,1.37676,0.309598,0.401606] - may vary between different setups
default position and size of Eden controls hint - ctrlPosition