BIS fnc ORBATOpen: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " *\|= * " to " ") |
Lou Montana (talk | contribs) 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 | {{Function | ||
| arma3 | | arma3 | ||
|1.00 | |1.00 | ||
|gr1 = Strategic | |gr1 = Strategic | ||
| Opens the [[ORBAT Viewer]]. | | Opens the [[ORBAT Viewer]]. | ||
| [path, display, tags, numTiers, parameters] call [[BIS_fnc_ORBATOpen]] | | [path, display, tags, numTiers, parameters] call [[BIS_fnc_ORBATOpen]] | ||
|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" | ||
|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 | ||
|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 | ||
|p4= numTiers: [[Number]] - (Optional,default -1 (all)) Number of tiers displayed | |p4= numTiers: [[Number]] - (Optional,default -1 (all)) Number of tiers displayed | ||
|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 | ||
| [[Display]] | | [[Display]] | ||
|x1= <code>[ [[configFile]] >> "CfgORBAT" >> "BIS" >> "O_Brigade",[[findDisplay]] 46, [], 4, ["ConfigClass_1",{[[systemChat]] "ConfigClass_1"}] ] [[call]] '''BIS_fnc_ORBATOpen''';</code> | |x1= <code>[ [[configFile]] >> "CfgORBAT" >> "BIS" >> "O_Brigade",[[findDisplay]] 46, [], 4, ["ConfigClass_1",{[[systemChat]] "ConfigClass_1"}] ] [[call]] '''BIS_fnc_ORBATOpen''';</code> | ||
| [[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]] | ||
}} | }} | ||
Revision as of 22:23, 17 January 2021
Description
- Description:
- Opens the ORBAT Viewer.
- Execution:
- call
- Groups:
- Strategic
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