formLeader: Difference between revisions

Latest revision as of 11:34, 3 September 2024

Hover & click on the images for description

Description:: Returns the formation leader of a given unit. This is often the same as the group leader, but not always, for example in cases when a unit is ordered to follow another unit.
Groups:: Unit Control

Syntax:: formLeader unitName
Parameters:: unitName: Object
Return Value:: Object - the leader of the formation is returned. If used on a dead unit, the returned value is objNull

Example 1:: if (formLeader player != leader player) then { hint "The formation leader is different to the group leader!"; };

See also:: commandFollow doFollow formationLeader isFormationLeader leader selectLeader setLeader

: 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

@@ Line 35: / Line 35: @@
 |r1= [[Object]] - the leader of the formation is returned. If used on a dead unit, the returned value is [[objNull]]
-|x1= <code>if (formLeader player != [[leader]] [[player]]) [[then]]
+|x1= <sqf>
+if (formLeader player != leader player) then
 {
-	[[hint]] "The formation leader is different to the group leader!";
+	hint "The formation leader is different to the group leader!";
-};</code>
+};
+</sqf>
 |seealso= [[commandFollow]] [[doFollow]] [[formationLeader]] [[isFormationLeader]] [[leader]] [[selectLeader]] [[setLeader]]
 }}