formLeader: Difference between revisions

Revision as of 23:54, 22 January 2009

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

Syntax:: Object = 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:

? (formLeader player != leader player) :
 hint "The formation leader is different to the group leader!"

returns X

: 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 12: / Line 12: @@
 ____________________________________________________________________________________________
-| [[Object#Person|Person]] <nowiki>=</nowiki> '''formLeader''' [[Object#Unit|Unit]]|= Syntax
+| [[Object]] <nowiki>=</nowiki> '''formLeader''' unitName |= Syntax
-|p1= [[Object#Person|Person]] |= Parameter 1
+|p1= unitName: [[Object]] |= Parameter 1
-|p2= [[Object#Unit|Unit]] |= Parameter 2
 | [[Object]] -
@@ Line 21: / Line 20: @@
 ____________________________________________________________________________________________
-|x1= <pre>? (formLeader player != leader player) : hint "The formation leader is different to the group leader!"</pre>
+|x1= <pre>? (formLeader player != leader player) :
+ hint "The formation leader is different to the group leader!"</pre>
 returns X |= Example 1