BIS fnc ORBATSetGroupParams: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "|PARAMETER1=1" to "|PARAMETER11=") |
Lou Montana (talk | contribs) m (Text replacement - "|PARAMETER1=3" to "|PARAMETER13=") |
||
Line 24: | Line 24: | ||
|p11= commName: [[String]] - Commander name. Can be the name directly or a class from CfgWorlds > GenericNames|PARAMETER11= | |p11= commName: [[String]] - Commander name. Can be the name directly or a class from CfgWorlds > GenericNames|PARAMETER11= | ||
|p12= commRank: [[String]] - Commander rank|PARAMETER1=2 | |p12= commRank: [[String]] - Commander rank|PARAMETER1=2 | ||
|p13= description: [[String]] - Description shown in tooltip| | |p13= description: [[String]] - Description shown in tooltip|PARAMETER13= | ||
|p14= assets: [[Array]] of [[Array|arrays]] in format: | |p14= assets: [[Array]] of [[Array|arrays]] in format: | ||
*vehicleClass: [[String]] - Vehicle class name | *vehicleClass: [[String]] - Vehicle class name |
Revision as of 20:08, 1 October 2019
Description
- Description:
- Overrides group params from CfgORBAT. See ORBAT Viewer for a detailed explaination.
- Execution:
- call
- Groups:
- Uncategorised
Syntax
- Syntax:
- [IDType, size, type, side, name, shortName, texture, textSizeCoef, insignia, textColour, commName, commRank, description, assets] call BIS_fnc_ORBATSetGroupParams
- Parameters:
- IDType: Number or String - IDType (e.g., 1 to result in "1st", or a specific string)
- size: String - Size as a class from CfgChainOfCommand > Sizes (e.g., "Platoon")
- type: String - Type as a class from CfgChainOfCommand > Types (e.g., "Infantry")
- side: String - Side as a class from CfgChainOfCommand > Sides (e.g., "West")
- name: String - Name. Passed arguments are: %1 - ID, %2 - type, %3 - size)
- shortName: String - Short name. Passed arguments are: %1 - ID, %2 - type, %3 - size)
- texture: String - Texture. Can be link to a file or a class from CfgMarkers
- textSizeCoef: Number - Texture size coeficient. 1 is the default size
- insignia: String - Insignia displayed in tooltip and in the ORBAT viewer background
- textColour: Array - Texture color in format RGBA
- commName: String - Commander name. Can be the name directly or a class from CfgWorlds > GenericNames
- commRank: String - Commander rank
- description: String - Description shown in tooltip
- assets: Array of arrays in format:
- Return Value:
- Boolean
Examples
- Example 1:
[ 1, "Platoon", "Infantry", "West", "Name: %1 %2 %3", "Short Name: %1 %2 %3", "b_air", 3, "\A3\Air_F_EPB\Heli_Light_03\data\UI\Heli_Light_03_CA.paa", [0,0,0,1], "Commander Name", "General", "Description", [ ["B_MRAP_01_F",5] ] ] call BIS_fnc_ORBATAddGroupOverlay;
Additional Information
- See also:
- ORBAT ViewerBIS_fnc_ORBATAddGroupOverlayBIS_fnc_ORBATAnimateBIS_fnc_ORBATConfigPreviewBIS_fnc_ORBATGetGroupParamsBIS_fnc_ORBATOpenBIS_fnc_ORBATRemoveGroupOverlayBIS_fnc_ORBATSetGroupFadeBIS_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