BIS fnc ORBATOpen: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (fixed path example)
(page filling)
Line 8: Line 8:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Opens the [[ORBAT Viewer]].|= Description
 
Description:
Show ORBAT viewer.
 
Parameter(s):
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:
DISPLAY
*/
#define GROUPPARAMS_COUNT 12
 
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_ORBATOpen]]; --> |= Syntax
| [path, display, tags, numTiers,parameters] call '''BIS_fnc_ORBATOpen'''; |= Syntax


|p1= |= Parameter 1
|p1= path: [[Config]] - Path to displayed structure, e.g. configfile >> "CfgORBAT" >> "BIS" >> "O_Brigade"|= Parameter 1
|p2= display: [[Display]] - Parent display (optionl) |= Parameter 2
|p3= tags: [[Array]] of [[String|strings]] List of tags. Searching will stop on groups which don't contain at least one of the tags |= Parameter 3
|p4= numTiers: [[Number]] - Number of tiers displayed (optional) |= Parameter 4
|p5= parameters: [[Array]] of [[Array|arrays]] - Each array looks as follows:
*1: [[Config]] - Group class
*2: [[Code]] - Action performed upon clicking on group icon |= Parameter 5


| |= Return value
| [[Display]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=  
|x1= <code>[ [[configFile]] >> "CfgORBAT" >> "BIS" >> "O_Brigade",[[findDisplay]] 46, [], 4, ["ConfigClass_1",{[[systemChat]] "ConfigClass_1"}] ] [[call]] '''BIS_fnc_ORBATOpen''';</code> |=  
____________________________________________________________________________________________
______________


| |= 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]]  |= See also


}}
}}

Revision as of 11:39, 26 May 2018


Arma 3 logo black.png1.00
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 - Parent display (optionl)
tags: Array of strings List of tags. Searching will stop on groups which don't contain at least one of the tags
numTiers: Number - Number of tiers displayed (optional)
parameters: Array of arrays - 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

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_ORBATOpen&oldid=107532"