BIS fnc ORBATOpen: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (added default values)
m (format)
Line 15: Line 15:
|p1= path: [[Config]] - Path to displayed structure, e.g. configfile >> "CfgORBAT" >> "BIS" >> "O_Brigade"|= Parameter 1
|p1= path: [[Config]] - Path to displayed structure, e.g. configfile >> "CfgORBAT" >> "BIS" >> "O_Brigade"|= Parameter 1
|p2= display: [[Display]] - (Optional, default [[call]] [[BIS_fnc_displayMission]]) Parent display |= Parameter 2
|p2= display: [[Display]] - (Optional, default [[call]] [[BIS_fnc_displayMission]]) Parent display |= Parameter 2
|p3= tags: [[Array]] of [[String|strings]] List of tags.(Optional,default []) Searching will stop on groups which don't contain at least one of the tags |= Parameter 3
|p3= tags: [[Array]] of [[String|strings]] - List of tags.(Optional,default []) Searching will stop on groups which don't contain at least one of the tags |= Parameter 3
|p4= numTiers: [[Number]] - (Optional,default -1 (all)) Number of tiers displayed |= Parameter 4
|p4= numTiers: [[Number]] - (Optional,default -1 (all)) Number of tiers displayed |= Parameter 4
|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:

Revision as of 10:57, 26 May 2018


Hover & click on the images for description

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 - List of tags.(Optional,default []) 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:
  • 1: Config - Group class
  • 2: 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 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

Notes

Bottom Section