BIS fnc 3DENControlsHint: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Filled out consumable info)
No edit summary
Line 40: Line 40:
[[Category:Functions|{{uc:3DENControlsHint}}]]
[[Category:Functions|{{uc:3DENControlsHint}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:3DENControlsHint}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:3DENControlsHint}}]]
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on July 23, 2017 - 02:34 (UTC)</dd>
<dt class="note">[[User:Larrow|Larrow]]</dt>
<dd class="note">
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<br/>
<br/>
'''uiNamespace getVariable "bis_fnc_3DENControlsHint_selected"'''<br/>
:default - [0,[0,0,0,0,0,0],[[],[],[],[],[],[]]]<br/>
:0 - total number of selected Eden entities<br/>
:1 - count of selected Eden entities by type<br/>
::0 - units<br/>
::1 - groups<br/>
::2 - triggers<br/>
::3 - waypoints<br/>
::4 - logics/systems/modules<br/>
::5 - markers<br/>
:2 - same results as [[get3DENSelected]] "" . Which is the same order as above for counts<br/>
<br/>
'''uiNamespace getVariable "bis_fnc_3DENControlsHint_place"'''<br/>
:default - [ "", false ]<br/>
:0 - Class name of current Eden entity being placed<br/>
:1 - true if class simulation type is a kind of vehicle<br/>
::["car","carx","tank","tankx","helicopter","helicopterx",<br/>
::"helicopterrtd","airplane","airplanex","ship","shipx",<br/>
::"submarinex","hovercraftx","motorcycle","parachute","paraglide"]<br/>
<br/>
'''uiNamespace getVariable "bis_fnc_3DENControlsHint_mouseButtons"'''<br/>
:default - [false,false]<br/>
:0 - left mouse button is down in Asset tree<br/>
:1 - right mouse button is down in Asset tree<br/>
<br/>
'''uiNamespace getVariable "bis_fnc_3DENControlsHint_connect"'''<br/>
:default - [ "", "" ]<br/>
:0 - text description of current connection being made eg "Sync to"<br/>
:1 - config path to CfgWrapperUI cursor texture<br/>
<br/>
'''uiNamespace getVariable "bis_fnc_3DENControlsHint_pos"'''<br/>
:default - [1.40902,1.37676,0.309598,0.401606] - may vary between different setups<br/>
:default position and size of Eden controls hint - ctrlPosition<br/>
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Revision as of 03:34, 23 July 2017


Hover & click on the images for description

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
Execution:
call
Groups:
Uncategorised

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

See also:
See also needed

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

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