BIS fnc ORBATOpen: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (fixed path example)
m (Text replacement - "(Optional, default {{hl|[]}})" to "(Optional, default <sqf inline>[]</sqf>)")
 
(39 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= Strategic


|1.00|= Game version
|descr= Opens the [[ORBAT Viewer]].
____________________________________________________________________________________________


| <pre>/*
|s1= [path, display, tags, numTiers, parameters] call [[BIS_fnc_ORBATOpen]]


Description:
|p1= path: [[Config]] - config path to displayed structure
Show ORBAT viewer.


Parameter(s):
|p2= display: [[Display]] - (Optional, default <sqf inline>[] call BIS_fnc_displayMission</sqf>) parent display
0: CONFIG - path to displayed structure, e.g. configfile >> "CfgORBAT" >> "BIS" >> "O_Brigade"
1 (Optional): DISPLAY - parent display of the viewer
2 (Optional): ARRAY - list of tags. Searching will stop on groups which doesn't contain at least one of the tags (default: no tags)
3 (Optional): NUMBER - number of tier displayed (default: unlimited)
4 (Optional): ARRAY - array of arrays in format [group class (CONFIG),action performed upon clicking on group icon (CODE)]


Returns:
|p3= tags: [[Array]] of [[String]]s - (Optional, default <sqf inline>[]</sqf>) list of tags. Searching will stop on groups which do not contain at least one of the tags
DISPLAY
*/
#define GROUPPARAMS_COUNT 12


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|p4= numTiers: [[Number]] - (Optional, default -1 (all)) Number of tiers displayed
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_ORBATOpen]]; --> |= Syntax
|p5= parameters: [[Array]] of [[Array]]s - (Optional, default <sqf inline>[]</sqf>) sub-arrays in format [config, code] where:
config: [[Config]] - group class
code: [[Code]] - action performed upon clicking on group icon


|p1= |= Parameter 1
|r1= [[Display]]


| |= Return value
|x1= <sqf>[configFile >> "CfgORBAT" >> "BIS" >> "O_Brigade", findDisplay 46, [], 4, ["ConfigClass_1", { systemChat "ConfigClass_1" }]] call BIS_fnc_ORBATOpen;</sqf>
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[ORBAT Viewer]] [[BIS_fnc_ORBATAddGroupOverlay]] [[BIS_fnc_ORBATAnimate]] [[BIS_fnc_ORBATConfigPreview]] [[BIS_fnc_ORBATGetGroupParams]] [[BIS_fnc_ORBATRemoveGroupOverlay]] [[BIS_fnc_ORBATSetGroupFade]] [[BIS_fnc_ORBATSetGroupParams]] [[BIS_fnc_ORBATTooltip]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Strategic|{{uc:ORBATOpen}}]]
[[Category:Functions|{{uc:ORBATOpen}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:ORBATOpen}}]]

Latest revision as of 18:09, 8 November 2023

Arma 3 logo black.png1.00
Hover & click on the images for description

Description

Description:
Opens the ORBAT Viewer.
Execution:
call
Groups:
Strategic

Syntax

Syntax:
[path, display, tags, numTiers, parameters] call BIS_fnc_ORBATOpen
Parameters:
path: Config - config path to displayed structure
display: Display - (Optional, default [] call BIS_fnc_displayMission) parent display
tags: Array of Strings - (Optional, default []) list of tags. Searching will stop on groups which do not contain at least one of the tags
numTiers: Number - (Optional, default -1 (all)) Number of tiers displayed
parameters: Array of Arrays - (Optional, default []) sub-arrays in format [config, code] where: config: Config - group class code: Code - action performed upon clicking on group icon
Return Value:
Display

Examples

Example 1:
[configFile >> "CfgORBAT" >> "BIS" >> "O_Brigade", findDisplay 46, [], 4, ["ConfigClass_1", { systemChat "ConfigClass_1" }]] call BIS_fnc_ORBATOpen;

Additional Information

See also:
ORBAT Viewer BIS_fnc_ORBATAddGroupOverlay BIS_fnc_ORBATAnimate BIS_fnc_ORBATConfigPreview BIS_fnc_ORBATGetGroupParams BIS_fnc_ORBATRemoveGroupOverlay BIS_fnc_ORBATSetGroupFade BIS_fnc_ORBATSetGroupParams BIS_fnc_ORBATTooltip

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