BIS fnc ORBATOpen: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "(\|p[0-9]+ *= *[^(]+\(Optional(, default[^)]*)\) )L([a-z])" to "$1l$3")
m (Text replacement - "(\|p[0-9]+ *= *[^(]+\(Optional(, default[^)]*)\) )P([a-z])" to "$1p$3")
Line 12: Line 12:
|p1= path: [[Config]] - config path to displayed structure
|p1= path: [[Config]] - config path to displayed structure


|p2= display: [[Display]] - (Optional, default <sqf inline>[] call BIS_fnc_displayMission</sqf>) Parent display
|p2= display: [[Display]] - (Optional, default <sqf inline>[] call BIS_fnc_displayMission</sqf>) parent display


|p3= tags: [[Array]] of [[String]]s - (Optional, default {{hl|[]}}) list of tags. Searching will stop on groups which do not contain at least one of the tags
|p3= tags: [[Array]] of [[String]]s - (Optional, default {{hl|[]}}) list of tags. Searching will stop on groups which do not contain at least one of the tags

Revision as of 12:32, 8 November 2023

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