Difference between revisions of "BIS fnc 3DENControlsHint"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision imported: BIS Functions update 7/7)
m (see also)
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
 
{{Function|= Comments
 
{{Function|= Comments
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| arma3 |= Game name
+
| arma3 |Game name=
  
|1.00|= Game version
+
|1.00|Game version=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| ''N/A'' |= Description
+
| Used by Eden to display control hints for the current Eden operation as seen in the bottom right corner of the Editor display. |Description=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| <!-- [] call [[BIS_fnc_3DENControlsHint]]; --> |= Syntax
+
| [mode] call [[BIS_fnc_3DENControlsHint]] |Syntax=
|p1= |= Parameter 1
 
  
| |= Return value
+
|p1= mode: [[String]] - '''case-sensitive''', can be one of:
 +
* "show" - Shows controls hints
 +
* "hide" - Hides controls hints
 +
* "toggle" - Toggles controls hints
 +
&nbsp; |Parameter 1=
 +
 
 +
| [[Nothing]] |Return value=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
|x1= <code></code> |=  
+
|x1= <code>["toggle"] call [[BIS_fnc_3DENControlsHint]]; {{codecomment|// toggle Eden controls hints}}</code> |Example 1=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| |= 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]]|See also=
 
 
 
}}
 
}}
  
Line 32: Line 35:
  
 
<h3 style="display:none">Bottom Section</h3>
 
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Default|{{uc:3DENControlsHint}}]]
 
 
[[Category:Functions|{{uc:3DENControlsHint}}]]
 
[[Category:Functions|{{uc:3DENControlsHint}}]]
 
[[Category:{{Name|arma3}}: Functions|{{uc:3DENControlsHint}}]]
 
[[Category:{{Name|arma3}}: Functions|{{uc:3DENControlsHint}}]]
 +
[[Category:Function Group: Eden Editor|{{uc:3DENControlsHint}}]]
 +
 +
<!-- CONTINUE Notes -->
 +
<dl class="command_description">
 +
<dd class="notedate">Posted on July 23, 2017 - 02:34 (UTC)
 +
<dt class="note">[[User:Larrow|Larrow]]
 +
<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 />
 +
 +
'''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
 +
<br />
 +
 +
'''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]]
 +
</dd>
 +
</dl>
 +
<!-- DISCONTINUE Notes -->

Latest revision as of 14:14, 28 May 2018

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.

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

Execution:
call
Multiplayer:
-
See also:
Eden EditorBIS_fnc_3DENCameraBIS_fnc_3DENDiagCreateListBIS_fnc_3DENDiagFontsBIS_fnc_3DENDiagMouseControlBIS_fnc_3DENDrawLocationsBIS_fnc_3DENEntityMenuBIS_fnc_3DENExportAttributesBIS_fnc_3DENExportOldSQMBIS_fnc_3DENExportTerrainBuilderBIS_fnc_3DENFlashlightBIS_fnc_3DENGridBIS_fnc_3DENIntelBIS_fnc_3DENInterfaceBIS_fnc_3DENListLocationsBIS_fnc_3DENMissionPreviewBIS_fnc_3DENModuleDescriptionBIS_fnc_3DENShowMessageBIS_fnc_3DENStatusBarBIS_fnc_3DENToolbarBIS_fnc_3DENTutorialBIS_fnc_3DENVisionMode

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