BIS fnc ORBATOpen: Difference between revisions
Jump to navigation
Jump to search
m (further formatting) |
m (template:command argument fix) |
||
| Line 8: | Line 8: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Opens the [[ORBAT Viewer]].|= | | Opens the [[ORBAT Viewer]].|DESCRIPTION= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [path, display, tags, numTiers, parameters] call [[BIS_fnc_ORBATOpen]] |= | | [path, display, tags, numTiers, parameters] call [[BIS_fnc_ORBATOpen]] |SYNTAX= | ||
|p1= path: [[Config]] - Path to displayed structure, e.g. configfile >> "CfgORBAT" >> "BIS" >> "O_Brigade"|= | |p1= path: [[Config]] - Path to displayed structure, e.g. configfile >> "CfgORBAT" >> "BIS" >> "O_Brigade"|PARAMETER1= | ||
|p2= display: [[Display]] - (Optional, default {{Inline code|[] [[call]] [[BIS_fnc_displayMission]]}}) Parent display |= | |p2= display: [[Display]] - (Optional, default {{Inline code|[] [[call]] [[BIS_fnc_displayMission]]}}) Parent display |PARAMETER2= | ||
|p3= tags: [[Array]] of [[String|strings]] - (Optional,default []) List of tags. Searching will stop on groups which don't contain at least one of the tags |= | |p3= tags: [[Array]] of [[String|strings]] - (Optional,default []) List of tags. Searching will stop on groups which don't contain at least one of the tags |PARAMETER3= | ||
|p4= numTiers: [[Number]] - (Optional,default -1 (all)) Number of tiers displayed |= | |p4= numTiers: [[Number]] - (Optional,default -1 (all)) Number of tiers displayed |PARAMETER4= | ||
|p5= parameters: [[Array]] of [[Array|arrays]] - (Optional,default []) Each array looks as follows: | |p5= parameters: [[Array]] of [[Array|arrays]] - (Optional,default []) Each array looks as follows: | ||
*1: [[Config]] - Group class | *1: [[Config]] - Group class | ||
*2: [[Code]] - Action performed upon clicking on group icon |= | *2: [[Code]] - Action performed upon clicking on group icon |PARAMETER5= | ||
| [[Display]] |= | | [[Display]] |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 27: | Line 27: | ||
______________ | ______________ | ||
| [[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]] |= | | [[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]] |SEEALSO= | ||
}} | }} | ||
Revision as of 14:32, 7 April 2019
Description
- Description:
- Opens the ORBAT Viewer.
- Execution:
- call
- Groups:
- Uncategorised
Syntax
- Syntax:
- [path, display, tags, numTiers, parameters] call BIS_fnc_ORBATOpen
- Parameters:
- path: Config - Path to displayed structure, e.g. configfile >> "CfgORBAT" >> "BIS" >> "O_Brigade"
- 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 don't contain at least one of the tags
- numTiers: Number - (Optional,default -1 (all)) Number of tiers displayed
- parameters: Array of arrays - (Optional,default []) Each array looks as follows:
- 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 ViewerBIS_fnc_ORBATAddGroupOverlayBIS_fnc_ORBATAnimateBIS_fnc_ORBATConfigPreviewBIS_fnc_ORBATGetGroupParamsBIS_fnc_ORBATRemoveGroupOverlayBIS_fnc_ORBATSetGroupFadeBIS_fnc_ORBATSetGroupParamsBIS_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