BIS_fnc_3DENControlsHint

From Bohemia Interactive Community
Revision as of 18:16, 8 November 2023 by Lou Montana (talk | contribs) (Text replacement - " +\]" to "]")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
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