BIS fnc ORBATSetGroupParams: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " *\|= " to " ")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.00|Game version=
|1.00


|gr1 = Strategic |GROUP1=
|gr1 = Strategic


| Overrides group params from CfgORBAT. See [[ORBAT Viewer]] for a detailed explanation. |DESCRIPTION=
| Overrides group params from CfgORBAT. See [[ORBAT Viewer]] for a detailed explanation.


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


|p1= target: [[Config]] - Path to class in CfgORBAT
|p1= target: [[Config]] - Path to class in CfgORBAT
|p2= IDType: [[Number]] or [[String]] - IDType (e.g., 1 to result in "1st", or a specific string)|PARAMETER1=
|p2= IDType: [[Number]] or [[String]] - IDType (e.g., 1 to result in "1st", or a specific string)
|p3= size: [[String]] - Size as a class from CfgChainOfCommand > Sizes (e.g., "Platoon")|PARAMETER2=
|p3= size: [[String]] - Size as a class from CfgChainOfCommand > Sizes (e.g., "Platoon")
|p4= type: [[String]] - Type as a class from CfgChainOfCommand > Types (e.g., "Infantry") |PARAMETER3=
|p4= type: [[String]] - Type as a class from CfgChainOfCommand > Types (e.g., "Infantry")
|p5= side: [[String]] - Side as a class from CfgChainOfCommand > Sides (e.g., "West")|PARAMETER4=
|p5= side: [[String]] - Side as a class from CfgChainOfCommand > Sides (e.g., "West")
|p6= name: [[String]] - Name. Passed arguments are: %1 - ID, %2 - type, %3 - size)|PARAMETER5=
|p6= name: [[String]] - Name. Passed arguments are: %1 - ID, %2 - type, %3 - size)
|p7= shortName: [[String]] - Short name. Passed arguments are: %1 - ID, %2 - type, %3 - size)|PARAMETER6=
|p7= shortName: [[String]] - Short name. Passed arguments are: %1 - ID, %2 - type, %3 - size)
|p8= texture: [[String]] - Texture. Can be link to a file or a class from CfgMarkers|PARAMETER7=
|p8= texture: [[String]] - Texture. Can be link to a file or a class from CfgMarkers
|p9= textSizeCoef: [[Number]] - Texture size coeficient. 1 is the default size|PARAMETER8=
|p9= textSizeCoef: [[Number]] - Texture size coeficient. 1 is the default size
|p10= insignia: [[String]] - Insignia displayed in tooltip and in the ORBAT viewer background|PARAMETER9=
|p10= insignia: [[String]] - Insignia displayed in tooltip and in the ORBAT viewer background
|p11= textColour: [[Array]] - Texture color in format RGBA|PARAMETER10=
|p11= textColour: [[Array]] - Texture color in format RGBA|PARAMETER10=
|p12= commName: [[String]] - Commander name. Can be the name directly or a class from CfgWorlds > GenericNames|PARAMETER11=
|p12= commName: [[String]] - Commander name. Can be the name directly or a class from CfgWorlds > GenericNames|PARAMETER11=
Line 29: Line 29:
*count: [[Number]] - Quantity of vehicles|PARAMETER14=
*count: [[Number]] - Quantity of vehicles|PARAMETER14=


| [[Boolean]]|RETURNVALUE=
| [[Boolean]]


|x1= <code>[
|x1= <code>[
Line 49: Line 49:
] call [[BIS_fnc_ORBATSetGroupParams]];</code>
] call [[BIS_fnc_ORBATSetGroupParams]];</code>


| [[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=
| [[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]]
}}
}}


Revision as of 23:21, 17 January 2021

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 - 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:
[ 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 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


Bottom Section

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