{"name":"BIS_fnc_ORBATSetGroupParams","operator":null,"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","replaced_by":[],"games":[{"game":"arma3","name":"Arma 3","version":"1.00"}],"since":{"game":"arma3","name":"Arma 3","version":"1.00"},"arma3_since":"1.00","branch":null,"locality":{"argument":null,"effect":null,"server_exec":false},"exec":null,"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","since":null,"effect":null,"exec":null,"params":[{"name":"target","type":"Config","optional":false,"default":null,"description":"path to class in CfgORBAT","types":["Config"],"since":null,"text":"target: Config - path to class in CfgORBAT"},{"name":"idType","type":"Number or String","optional":false,"default":null,"description":"ID Type (e.g. `1` to result in \"1st\", or a specific string)","types":["Number","String"],"since":null,"text":"idType: Number or String - ID Type (e.g. `1` to result in \"1st\", or a specific string)"},{"name":"size","type":"String","optional":false,"default":null,"description":"size as a class from CfgChainOfCommand > Sizes (e.g., \"Platoon\")","types":["String"],"since":null,"text":"size: String - size as a class from CfgChainOfCommand > Sizes (e.g., \"Platoon\")"},{"name":"type","type":"String","optional":false,"default":null,"description":"type as a class from CfgChainOfCommand > Types (e.g., \"Infantry\")","types":["String"],"since":null,"text":"type: String - type as a class from CfgChainOfCommand > Types (e.g., \"Infantry\")"},{"name":"side","type":"String","optional":false,"default":null,"description":"side as a class from CfgChainOfCommand > Sides (e.g., \"West\")","types":["String"],"since":null,"text":"side: String - side as a class from CfgChainOfCommand > Sides (e.g., \"West\")"},{"name":"name","type":"String","optional":false,"default":null,"description":"name. Passed arguments are: %1 - ID, %2 - type, %3 - size)","types":["String"],"since":null,"text":"name: String - name. Passed arguments are: %1 - ID, %2 - type, %3 - size)"},{"name":"shortName","type":"String","optional":false,"default":null,"description":"short name. Passed arguments are: %1 - ID, %2 - type, %3 - size)","types":["String"],"since":null,"text":"shortName: String - short name. Passed arguments are: %1 - ID, %2 - type, %3 - size)"},{"name":"texture","type":"String","optional":false,"default":null,"description":"texture. Can be link to a file or a class from CfgMarkers","types":["String"],"since":null,"text":"texture: String - texture. Can be link to a file or a class from CfgMarkers"},{"name":"textSizeCoef","type":"Number","optional":false,"default":null,"description":"texture size coeficient. 1 is the default size","types":["Number"],"since":null,"text":"textSizeCoef: Number - texture size coeficient. 1 is the default size"},{"name":"insignia","type":"String","optional":false,"default":null,"description":"insignia displayed in tooltip and in the ORBAT viewer background","types":["String"],"since":null,"text":"insignia: String - insignia displayed in tooltip and in the ORBAT viewer background"},{"name":"textColour","type":"Array","optional":false,"default":null,"description":"texture color in format RGBA","types":["Array"],"since":null,"text":"textColour: Array - texture color in format RGBA"},{"name":"commName","type":"String","optional":false,"default":null,"description":"commander name. Can be the name directly or a class from CfgWorlds > GenericNames","types":["String"],"since":null,"text":"commName: String - commander name. Can be the name directly or a class from CfgWorlds > GenericNames"},{"name":"commRank","type":"String","optional":false,"default":null,"description":"commander rank","types":["String"],"since":null,"text":"commRank: String - commander rank"},{"name":"description","type":"String","optional":false,"default":null,"description":"description shown in tooltip","types":["String"],"since":null,"text":"description: String - description shown in tooltip"},{"name":"assets","type":"Array of Arrays in format [vehicleClass, count]:","optional":false,"default":null,"description":"Array of Arrays in format [vehicleClass, count]:\n- vehicleClass: String - vehicle class name\n- count: Number - quantity of vehicles","types":["Array"],"since":null,"text":"assets: Array of Arrays in format [vehicleClass, count]:\n- vehicleClass: String - vehicle class name\n- count: Number - quantity of vehicles"}],"returns":{"type":"Boolean","types":["Boolean"],"description":null,"text":"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;"]}],"multiplayer":null,"problems":null,"aliases":[],"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":[],"categories":["Arma 3: Functions","Arma 3: New Functions","Function Group: Strategic","Functions","Introduced with Arma 3 version 1.00"],"docblock":null,"filled_from_docblock":[]}