BIS fnc ORBATSetGroupParams: Difference between revisions
Jump to navigation
Jump to search
m (see also) |
m (template:command argument fix) |
||
| Line 7: | Line 7: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Overrides group params from CfgORBAT. See [[ORBAT Viewer]] for a detailed explaination. |= | | Overrides group params from CfgORBAT. See [[ORBAT Viewer]] for a detailed explaination. |DESCRIPTION= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [IDType, size, type, side, name, shortName, texture, textSizeCoef, insignia, textColour, commName, commRank, description, assets] call [[BIS_fnc_ORBATSetGroupParams]] |= | | [IDType, size, type, side, name, shortName, texture, textSizeCoef, insignia, textColour, commName, commRank, description, assets] call [[BIS_fnc_ORBATSetGroupParams]] |SYNTAX= | ||
|p1= IDType: [[Number]] or [[String]] - IDType (e.g., 1 to result in "1st", or a specific string)|= | |p1= IDType: [[Number]] or [[String]] - IDType (e.g., 1 to result in "1st", or a specific string)|PARAMETER1= | ||
|p2= size: [[String]] - Size as a class from CfgChainOfCommand > Sizes (e.g., "Platoon")|= | |p2= size: [[String]] - Size as a class from CfgChainOfCommand > Sizes (e.g., "Platoon")|PARAMETER2= | ||
|p3= type: [[String]] - Type as a class from CfgChainOfCommand > Types (e.g., "Infantry") |= | |p3= type: [[String]] - Type as a class from CfgChainOfCommand > Types (e.g., "Infantry") |PARAMETER3= | ||
|p4= side: [[String]] - Side as a class from CfgChainOfCommand > Sides (e.g., "West")|= | |p4= side: [[String]] - Side as a class from CfgChainOfCommand > Sides (e.g., "West")|PARAMETER4= | ||
|p5= name: [[String]] - Name. Passed arguments are: %1 - ID, %2 - type, %3 - size)|= | |p5= name: [[String]] - Name. Passed arguments are: %1 - ID, %2 - type, %3 - size)|PARAMETER5= | ||
|p6= shortName: [[String]] - Short name. Passed arguments are: %1 - ID, %2 - type, %3 - size)|= | |p6= shortName: [[String]] - Short name. Passed arguments are: %1 - ID, %2 - type, %3 - size)|PARAMETER6= | ||
|p7= texture: [[String]] - Texture. Can be link to a file or a class from CfgMarkers|= | |p7= texture: [[String]] - Texture. Can be link to a file or a class from CfgMarkers|PARAMETER7= | ||
|p8= textSizeCoef: [[Number]] - Texture size coeficient. 1 is the default size|= | |p8= textSizeCoef: [[Number]] - Texture size coeficient. 1 is the default size|PARAMETER8= | ||
|p9= insignia: [[String]] - Insignia displayed in tooltip and in the ORBAT viewer background|= | |p9= insignia: [[String]] - Insignia displayed in tooltip and in the ORBAT viewer background|PARAMETER9= | ||
|p10= textColour: [[Array]] - Texture color in format RGBA|= | |p10= textColour: [[Array]] - Texture color in format RGBA|PARAMETER1=0 | ||
|p11= commName: [[String]] - Commander name. Can be the name directly or a class from CfgWorlds > GenericNames|= | |p11= commName: [[String]] - Commander name. Can be the name directly or a class from CfgWorlds > GenericNames|PARAMETER1=1 | ||
|p12= commRank: [[String]] - Commander rank|= | |p12= commRank: [[String]] - Commander rank|PARAMETER1=2 | ||
|p13= description: [[String]] - Description shown in tooltip|= | |p13= description: [[String]] - Description shown in tooltip|PARAMETER1=3 | ||
|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 | ||
*count: [[Number]] - Quantity of vehicles|= | *count: [[Number]] - Quantity of vehicles|PARAMETER1=4 | ||
| [[Boolean]]|= | | [[Boolean]]|RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 51: | Line 51: | ||
______________ | ______________ | ||
| [[ORBAT Viewer]], [[BIS_fnc_ORBATAddGroupOverlay]], [[BIS_fnc_ORBATAnimate]], [[BIS_fnc_ORBATConfigPreview]], [[BIS_fnc_ORBATGetGroupParams]], [[BIS_fnc_ORBATOpen]], [[BIS_fnc_ORBATRemoveGroupOverlay]], [[BIS_fnc_ORBATSetGroupFade]], [[BIS_fnc_ORBATTooltip]] |= | | [[ORBAT Viewer]], [[BIS_fnc_ORBATAddGroupOverlay]], [[BIS_fnc_ORBATAnimate]], [[BIS_fnc_ORBATConfigPreview]], [[BIS_fnc_ORBATGetGroupParams]], [[BIS_fnc_ORBATOpen]], [[BIS_fnc_ORBATRemoveGroupOverlay]], [[BIS_fnc_ORBATSetGroupFade]], [[BIS_fnc_ORBATTooltip]] |SEEALSO= | ||
}} | }} | ||
Revision as of 15:32, 7 April 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