BIS fnc 3DENControlsHint: Difference between revisions

Latest revision as of 17:04, 23 April 2024

1.00

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.
Execution:: call
Groups:: Eden Editor

Syntax

Syntax:

[mode] call BIS_fnc_3DENControlsHint

Parameters:

mode: String - case-sensitive, can be one of:

"show" - Shows controls hints
"hide" - Hides controls hints
"toggle" - Toggles controls hints

Return Value:

Nothing

Examples

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

Additional Information

See also:: Eden Editor BIS_fnc_3DENCamera BIS_fnc_3DENDiagCreateList BIS_fnc_3DENDiagFonts BIS_fnc_3DENDiagMouseControl BIS_fnc_3DENDrawLocations BIS_fnc_3DENEntityMenu BIS_fnc_3DENExportAttributes BIS_fnc_3DENExportOldSQM BIS_fnc_3DENExportTerrainBuilder BIS_fnc_3DENFlashlight BIS_fnc_3DENGrid BIS_fnc_3DENIntel BIS_fnc_3DENInterface BIS_fnc_3DENListLocations BIS_fnc_3DENMissionPreview BIS_fnc_3DENModuleDescription BIS_fnc_3DENShowMessage BIS_fnc_3DENStatusBar BIS_fnc_3DENToolbar BIS_fnc_3DENTutorial BIS_fnc_3DENVisionMode

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 2017-07-23 - 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

@@ Line 1: / Line 1: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= arma3
-____________________________________________________________________________________________
+|version1= 1.00
-| arma3 |= Game name
+|gr1= Eden Editor
-|1.00|= Game version
+|descr= Used by Eden to display control hints for the current Eden operation as seen in the bottom right corner of the Editor display.
-____________________________________________________________________________________________
-| Used by Eden to display control hints for the current Eden operation.
+|s1= [mode] call [[BIS_fnc_3DENControlsHint]]
-As seen in the bottom right corner of the Editor display.
-Mostly non consumable for the end user except for three modes..
+|p1= mode: [[String]] - '''case-sensitive''', can be one of:
 * "show" - Shows controls hints
 * "hide" - Hides controls hints
-*"toggle" - Toggles controls hints |= Description
+* "toggle" - Toggles controls hints
-____________________________________________________________________________________________
-| [ '''mode''' ] call [[BIS_fnc_3DENControlsHint]]; |= Syntax
+|r1= [[Nothing]]
-|p1= '''mode''' : [[String]] - Mode to use, is case sensitive  |= Parameter 1
-| [[Nothing]] |= Return value
+|x1= <sqf>["toggle"] call BIS_fnc_3DENControlsHint; // toggle Eden controls hints</sqf>
-____________________________________________________________________________________________
-|x1= Toggle Eden controls hints
-<code>[ "toggle" ] call [[BIS_fnc_3DENControlsHint]];</code> |=
-____________________________________________________________________________________________
-| |= See also
+|seealso= [[:Category:Eden Editor|Eden Editor]] [[BIS_fnc_3DENCamera]] [[BIS_fnc_3DENDiagCreateList]] [[BIS_fnc_3DENDiagFonts]] [[BIS_fnc_3DENDiagMouseControl]] [[BIS_fnc_3DENDrawLocations]] [[BIS_fnc_3DENEntityMenu]] [[BIS_fnc_3DENExportAttributes]] [[BIS_fnc_3DENExportOldSQM]] [[BIS_fnc_3DENExportTerrainBuilder]] [[BIS_fnc_3DENFlashlight]] [[BIS_fnc_3DENGrid]] [[BIS_fnc_3DENIntel]] [[BIS_fnc_3DENInterface]] [[BIS_fnc_3DENListLocations]] [[BIS_fnc_3DENMissionPreview]] [[BIS_fnc_3DENModuleDescription]] [[BIS_fnc_3DENShowMessage]] [[BIS_fnc_3DENStatusBar]] [[BIS_fnc_3DENToolbar]] [[BIS_fnc_3DENTutorial]] [[BIS_fnc_3DENVisionMode]]
 }}
-<h3 style="display:none">Notes</h3>
 <dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
+<dt></dt>
-</dl>
+<dd class="notedate">Posted on 2017-07-23 - 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"'''
+: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
+<br>
+'''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"]
+<br>
+'''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
+<br>
-<h3 style="display:none">Bottom Section</h3>
+'''uiNamespace getVariable "BIS_fnc_3DENControlsHint_connect"'''
-[[Category:Function Group: Default|{{uc:3DENControlsHint}}]]
+:default - ["", ""]
-[[Category:Functions|{{uc:3DENControlsHint}}]]
+* 0 - text description of current connection being made eg "Sync to"
-[[Category:{{Name|arma3}}: Functions|{{uc:3DENControlsHint}}]]
+* 1 - config path to CfgWrapperUI cursor texture
+<br>
-<!-- CONTINUE Notes -->
+'''uiNamespace getVariable "BIS_fnc_3DENControlsHint_pos"'''
-<dl class="command_description">
+:default - [1.40902,1.37676,0.309598,0.401606] - may vary between different setups
-<dd class="notedate">Posted on July 23, 2017 - 02:34 (UTC)</dd>
+:default position and size of Eden controls hint - [[ctrlPosition]]
-<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 -->