formLeader: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<code>([^ ]*)\[\[([a-zA-Z][a-zA-Z0-9_]+)\]\]([^ ]*) ([^ ]*) ([^ ]*) ([^ ]*)<\/code>" to "<code>$1$2$3 $4 $5 $6</code>")
m (Text replacement - "<code>([^ ]*)\[\[([a-zA-Z][a-zA-Z0-9_]+)\]\]([^ ]*) ([^ ]*) ([^ ]*) ([^ ]*)<\/code>" to "<code>$1$2$3 $4 $5 $6</code>")
Line 35: Line 35:
|r1= [[Object]] - the leader of the formation is returned. If used on a dead unit, the returned value is [[objNull]]
|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= <code>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!";

Revision as of 12:49, 12 May 2022

Logo A0.png1.00ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
GAGlobal
Hover & click on the images for description

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

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

Examples

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

Additional Information

See also:
commandFollow doFollow formationLeader isFormationLeader leader selectLeader setLeader

Notes

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
Retrieved from "https://community.bistudio.com/wiki?title=formLeader&oldid=315835"