{"name":"formLeader","operator":null,"title":"formLeader","type":"command","url":"https://community.bistudio.com/wiki/formLeader","revid":369162,"updated":"2024-09-03T10:34:40Z","groups":["Unit Control"],"status":"ok","replaced_by":[],"games":[{"game":"ofp","name":"Operation Flashpoint","version":"1.00"},{"game":"ofpe","name":"Operation Flashpoint: Elite","version":"1.00"},{"game":"arma1","name":"Armed Assault","version":"1.00"},{"game":"arma2","name":"Arma 2","version":"1.00"},{"game":"arma2oa","name":"Arma 2: Operation Arrowhead","version":"1.50"},{"game":"tkoh","name":"Take On Helicopters","version":"1.00"},{"game":"arma3","name":"Arma 3","version":"0.50"}],"since":{"game":"ofp","name":"Operation Flashpoint","version":"1.00"},"arma3_since":"0.50","branch":null,"locality":{"argument":"global","effect":null,"server_exec":false},"exec":null,"description":"Returns the formation leader of a given unit.\nThis is often the same as the group leader, but not always, for example in cases when a unit is ordered to follow another unit.","syntaxes":[{"syntax":"formLeader unitName","since":null,"effect":null,"exec":null,"params":[{"name":"unitName","type":"Object","optional":false,"default":null,"description":null,"types":["Object"],"since":null,"text":"unitName: Object"}],"returns":{"type":"Object","types":["Object"],"description":"the leader of the formation is returned. If used on a dead unit, the returned value is objNull","text":"Object - the leader of the formation is returned. If used on a dead unit, the returned value is objNull"},"form":"unary","operator":null,"left":null,"right":{"text":"unitName","types":["Object"]}}],"examples":[{"text":"```sqf\nif (formLeader player != leader player) then\n{\n    hint \"The formation leader is different to the group leader!\";\n};\n```","code":["if (formLeader player != leader player) then\n{\n\thint \"The formation leader is different to the group leader!\";\n};"]}],"multiplayer":null,"problems":null,"aliases":[],"see_also":["commandFollow","doFollow","formationLeader","isFormationLeader","leader","selectLeader","setLeader"],"notes":[],"categories":["ArmA: Armed Assault: Scripting Commands","Arma 2: Operation Arrowhead: Scripting Commands","Arma 2: Scripting Commands","Arma 3: Scripting Commands","Command Group: Unit Control","Introduced with Operation Flashpoint version 1.00","Operation Flashpoint: Elite: Scripting Commands","Operation Flashpoint: New Scripting Commands","Operation Flashpoint: Scripting Commands","Scripting Commands","Take On Helicopters: Scripting Commands"]}