{"name":"BIS_fnc_ORBATSetGroupParams","title":"BIS fnc ORBATSetGroupParams","type":"function","url":"https://community.bistudio.com/wiki/BIS_fnc_ORBATSetGroupParams","revid":349199,"updated":"2023-11-08T14:50:42Z","groups":["Strategic"],"status":"ok","games":{"arma3":"1.00"},"since":"arma3 1.00","arma3_since":"1.00","description":"Overrides group params from CfgORBAT. See ORBAT Viewer for a detailed explanation.","syntaxes":[{"syntax":"[target, idType, size, type, side, name, shortName, texture, textSizeCoef, insignia, textColour, commName, commRank, description, assets] call BIS_fnc_ORBATSetGroupParams","params":[{"name":"target","type":"Config","description":"path to class in CfgORBAT","type_expr":"Config"},{"name":"idType","type":"Number or String","description":"ID Type (e.g. `1` to result in \"1st\", or a specific string)","type_expr":"Number | String"},{"name":"size","type":"String","description":"size as a class from CfgChainOfCommand > Sizes (e.g., \"Platoon\")","type_expr":"String"},{"name":"type","type":"String","description":"type as a class from CfgChainOfCommand > Types (e.g., \"Infantry\")","type_expr":"String"},{"name":"side","type":"String","description":"side as a class from CfgChainOfCommand > Sides (e.g., \"West\")","type_expr":"String"},{"name":"name","type":"String","description":"name. Passed arguments are: %1 - ID, %2 - type, %3 - size)","type_expr":"String"},{"name":"shortName","type":"String","description":"short name. Passed arguments are: %1 - ID, %2 - type, %3 - size)","type_expr":"String"},{"name":"texture","type":"String","description":"texture. Can be link to a file or a class from CfgMarkers","type_expr":"String"},{"name":"textSizeCoef","type":"Number","description":"texture size coeficient. 1 is the default size","type_expr":"Number"},{"name":"insignia","type":"String","description":"insignia displayed in tooltip and in the ORBAT viewer background","type_expr":"String"},{"name":"textColour","type":"Array","description":"texture color in format RGBA","type_expr":"Array"},{"name":"commName","type":"String","description":"commander name. Can be the name directly or a class from CfgWorlds > GenericNames","type_expr":"String"},{"name":"commRank","type":"String","description":"commander rank","type_expr":"String"},{"name":"description","type":"String","description":"description shown in tooltip","type_expr":"String"},{"name":"assets","type":"Array of Arrays in format [vehicleClass, count]:","description":"Array of Arrays in format [vehicleClass, count]:\n\n- vehicleClass: String - vehicle class name\n- count: Number - quantity of vehicles","type_expr":"Array<Array>","text":"assets: Array of Arrays in format [vehicleClass, count]:\n\n- vehicleClass: String - vehicle class name\n- count: Number - quantity of vehicles"}],"returns":{"type":"Boolean","type_expr":"Boolean"}}],"examples":[{"text":"```sqf\n[\n    configFile >> \"CfgORBAT\" >> \"BIS\" >> \"B_1_A_1\",\n    1,\n    \"Platoon\",\n    \"Infantry\",\n    \"West\",\n    \"Name: %1 %2 %3\",\n    \"Short Name: %1 %2 %3\",\n    \"b_air\",\n    3,\n    \"\\A3\\Air_F_EPB\\Heli_Light_03\\data\\UI\\Heli_Light_03_CA.paa\",\n    [0,0,0,1],\n    \"Commander Name\",\n    \"General\",\n    \"Description\",\n    [[\"B_MRAP_01_F\",5]]\n] call BIS_fnc_ORBATSetGroupParams;\n```","code":["[\n\tconfigFile >> \"CfgORBAT\" >> \"BIS\" >> \"B_1_A_1\",\n\t1,\n\t\"Platoon\",\n\t\"Infantry\",\n\t\"West\",\n\t\"Name: %1 %2 %3\",\n\t\"Short Name: %1 %2 %3\",\n\t\"b_air\",\n\t3,\n\t\"\\A3\\Air_F_EPB\\Heli_Light_03\\data\\UI\\Heli_Light_03_CA.paa\",\n\t[0,0,0,1],\n\t\"Commander Name\",\n\t\"General\",\n\t\"Description\",\n\t[[\"B_MRAP_01_F\",5]]\n] call BIS_fnc_ORBATSetGroupParams;"]}],"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"]}