BIS fnc ORBATSetGroupParams: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
(page filling)
Line 1: Line 1:
{{Function|= Comments
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________
Line 8: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Overrides group params from CfgORBAT. See [[ORBAT Viewer]] for a detailed explaination. |= Description
 
Description:
Override group params from CfgORBAT.
 
Parameter(s):
0: NUMBER or STRING - ID (e.g., 1 to result in "1st", or a specific string)
1: STRING - size as a class from CfgChainOfCommand > Sizes (e.g., "Platoon")
2: STRING - type as a class from CfgChainOfCommand > Types (e.g., "Infantry")
3: STRING - side as a class from CfgChainOfCommand > Sides (e.g., "West")
4: STRING - name. Passed arguments are: %1 - ID, %2 - type, %3 - size)
5: STRING - short name. Passed arguments are: %1 - ID, %2 - type, %3 - size)
6: STRING - texture. Can be link to a file or a class from CfgMarkers
7: NUMBER - texture size coeficient. 1 is the default size
8: STRING - insignia displayed in tooltip and in the ORBAT viewer background
9: ARRAY - texture color in format RGBA
10: STRING - commander name. Can be the name directly or a class from CfgWorlds > GenericNames
11: STRING - commander rank.
12: STRING - description
13: ARRAY - assets. Items are ARRAYs in format [vehicleClass:STRING,count:NUMBER]
 
Returns:
BOOL
*/
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_ORBATSetGroupParams]]; --> |= Syntax
| [IDType, size, type, side, name, shortName, texture, textSizeCoef, insignia, textColour, commName, commRank, description, assets] call [[BIS_fnc_ORBATSetGroupParams]] |= Syntax


|p1= |= Parameter 1
|p1= IDType: [[Number]] or [[String]] - IDType (e.g., 1 to result in "1st", or a specific string)|= Parameter 1
 
|p2= size: [[String]] - Size as a class from CfgChainOfCommand > Sizes (e.g., "Platoon")|= Parameter 2
| |= Return value
|p3= type: [[String]] - Type as a class from CfgChainOfCommand > Types (e.g., "Infantry") |= Parameter 3
____________________________________________________________________________________________
|p4= side: [[String]] - Side as a class from CfgChainOfCommand > Sides (e.g., "West")|= Parameter 4
|p5= name: [[String]] - Name. Passed arguments are: %1 - ID, %2 - type, %3 - size)|= Parameter 5
|p6= shortName: [[String]] - Short name. Passed arguments are: %1 - ID, %2 - type, %3 - size)|= Parameter 6
|p7= texture: [[String]] - Texture. Can be link to a file or a class from CfgMarkers|= Parameter 7
|p8= textSizeCoef: [[Number]] - Texture size coeficient. 1 is the default size|= Parameter 8
|p9= insignia: [[String]] - Insignia displayed in tooltip and in the ORBAT viewer background|= Parameter 9
|p10= textColour: [[Array]] - Texture color in format RGBA|= Parameter 10
|p11= commName: [[String]] - Commander name. Can be the name directly or a class from CfgWorlds > GenericNames|= Parameter 11
|p12= commRank: [[String]] - Commander rank|= Parameter 12
|p13= description: [[String]] - Description shown in tooltip|= Parameter 13
|p14= assets: [[Array]] of [[Array|arrays]] in format:
*vehicleClass: [[String]] - Vehicle class name
*count: [[Number]] - Quantity of vehicles|= Parameter 14


|x1= <code></code> |=  
| [[Boolean]]|= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
|x1= <code>
[
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]];</code> |=
______________


| [[ORBAT Viewer]], [[BIS_fnc_ORBATAnimate]], [[BIS_fnc_ORBATConfigPreview]], [[BIS_fnc_ORBATGetGroupParams]], [[BIS_fnc_ORBATOpen]], [[BIS_fnc_ORBATRemoveGroupOverlay]], [[BIS_fnc_ORBATSetGroupFade]], [[BIS_fnc_ORBATSetGroupParams]], [[BIS_fnc_ORBATTooltip]] |= See also
}}
}}


Revision as of 03:02, 27 May 2018

Arma 3 logo black.png1.00
Hover & click on the images for description

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:
  • vehicleClass: String - Vehicle class name
  • count: Number - Quantity of vehicles
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_ORBATAnimateBIS_fnc_ORBATConfigPreviewBIS_fnc_ORBATGetGroupParamsBIS_fnc_ORBATOpenBIS_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_ORBATSetGroupParams&oldid=107557"