BIS fnc ORBATSetGroupParams: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(page filling)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *T([a-z ])" to "$1 - t$2")
 
(48 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 1.00


|1.00|= Game version
|gr1= Strategic
____________________________________________________________________________________________


| Overrides group params from CfgORBAT. See [[ORBAT Viewer]] for a detailed explaination. |= Description
|descr= Overrides group params from CfgORBAT. See [[ORBAT Viewer]] for a detailed explanation.
____________________________________________________________________________________________


| [IDType, size, type, side, name, shortName, texture, textSizeCoef, insignia, textColour, commName, commRank, description, assets] call [[BIS_fnc_ORBATSetGroupParams]] |= Syntax
|s1= [target, idType, size, type, side, name, shortName, texture, textSizeCoef, insignia, textColour, commName, commRank, description, assets] call [[BIS_fnc_ORBATSetGroupParams]]


|p1= IDType: [[Number]] or [[String]] - IDType (e.g., 1 to result in "1st", or a specific string)|= Parameter 1
|p1= target: [[Config]] - path to class in CfgORBAT
|p2= size: [[String]] - Size as a class from CfgChainOfCommand > Sizes (e.g., "Platoon")|= Parameter 2
|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


| [[Boolean]]|= Return value
|p2= idType: [[Number]] or [[String]] - ID Type (e.g. {{hl|1}} to result in "1st", or a specific string)
____________________________________________________________________________________________


|x1= <code>
|p3= size: [[String]] - size as a class from CfgChainOfCommand > Sizes (e.g., "Platoon")
[
 
1,  
|p4= type: [[String]] - type as a class from CfgChainOfCommand > Types (e.g., "Infantry")
"Platoon",  
 
"Infantry",  
|p5= side: [[String]] - side as a class from CfgChainOfCommand > Sides (e.g., "West")
"West",
 
"Name: %1 %2 %3",
|p6= name: [[String]] - name. Passed arguments are: %1 - ID, %2 - type, %3 - size)
"Short Name: %1 %2 %3",
 
"b_air",
|p7= shortName: [[String]] - short name. Passed arguments are: %1 - ID, %2 - type, %3 - size)
3,
 
"\A3\Air_F_EPB\Heli_Light_03\data\UI\Heli_Light_03_CA.paa",
|p8= texture: [[String]] - texture. Can be link to a file or a class from CfgMarkers
[0,0,0,1],
 
"Commander Name",
|p9= textSizeCoef: [[Number]] - texture size coeficient. 1 is the default size
"General",
 
"Description",
|p10= insignia: [[String]] - insignia displayed in tooltip and in the ORBAT viewer background
[ ["B_MRAP_01_F",5] ]  
 
]  call [[BIS_fnc_ORBATAddGroupOverlay]];</code> |=
|p11= textColour: [[Array]] - texture color in format RGBA
______________
 
|p12= commName: [[String]] - commander name. Can be the name directly or a class from CfgWorlds > GenericNames
 
|p13= commRank: [[String]] - commander rank
 
|p14= description: [[String]] - description shown in tooltip


| [[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
|p15= assets: [[Array]] of [[Array]]s in format [vehicleClass, count]:
}}
* vehicleClass: [[String]] - vehicle class name
* count: [[Number]] - quantity of vehicles


<h3 style="display:none">Notes</h3>
|r1= [[Boolean]]
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x1= <sqf>
</dl>
[
configFile >> "CfgORBAT" >> "BIS" >> "B_1_A_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_ORBATSetGroupParams;
</sqf>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[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]]
[[Category:Function Group: Strategic|{{uc:ORBATSetGroupParams}}]]
}}
[[Category:Functions|{{uc:ORBATSetGroupParams}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:ORBATSetGroupParams}}]]

Latest revision as of 15:50, 8 November 2023

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 explanation.
Execution:
call
Groups:
Strategic

Syntax

Syntax:
[target, idType, size, type, side, name, shortName, texture, textSizeCoef, insignia, textColour, commName, commRank, description, assets] call BIS_fnc_ORBATSetGroupParams
Parameters:
target: Config - path to class in CfgORBAT
idType: Number or String - ID Type (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, count]:
  • vehicleClass: String - vehicle class name
  • count: Number - quantity of vehicles
Return Value:
Boolean

Examples

Example 1:
[ configFile >> "CfgORBAT" >> "BIS" >> "B_1_A_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_ORBATSetGroupParams;

Additional Information

See also:
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

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_ORBATSetGroupParams&oldid=349199"