BIS fnc 3DENControlsHint: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.00|Game version=
|1.00


|gr1= Eden Editor|GROUP1=
|gr1= Eden Editor


| Used by Eden to display control hints for the current Eden operation as seen in the bottom right corner of the Editor display. |Description=
| Used by Eden to display control hints for the current Eden operation as seen in the bottom right corner of the Editor display.


| [mode] call [[BIS_fnc_3DENControlsHint]] |Syntax=
| [mode] call [[BIS_fnc_3DENControlsHint]]


|p1= mode: [[String]] - '''case-sensitive''', can be one of:
|p1= mode: [[String]] - '''case-sensitive''', can be one of:
Line 15: Line 15:
* "hide" - Hides controls hints
* "hide" - Hides controls hints
* "toggle" - Toggles controls hints
* "toggle" - Toggles controls hints
&nbsp; |Parameter 1=
&nbsp;


| [[Nothing]] |Return value=
| [[Nothing]]


|x1= <code>["toggle"] call [[BIS_fnc_3DENControlsHint]]; {{codecomment|// toggle Eden controls hints}}</code> |Example 1=
|x1= <code>["toggle"] call [[BIS_fnc_3DENControlsHint]]; {{codecomment|// toggle Eden controls hints}}</code>


|[[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=
|[[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]]
}}
}}


Revision as of 22:06, 17 January 2021

Arma 3 logo black.png1.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 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

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


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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_3DENControlsHint&oldid=202082"