formLeader: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{Command|Comments=
{{Command


| ofp |Game name=
| ofp


|1.00|Game version=
|1.00


|gr1= Unit Control |GROUP1=
|gr1= Unit Control


|arg= global |Multiplayer Arguments=
|arg= global


| 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. |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.


| [[Object]] <nowiki>=</nowiki> '''formLeader''' unitName |SYNTAX=
| [[Object]] <nowiki>=</nowiki> '''formLeader''' unitName


|p1= unitName: [[Object]] |PARAMETER1=
|p1= unitName: [[Object]]


| [[Object]] -   
| [[Object]] -   
the leader of the formation is returned. If used on a dead unit, the returned value is [[objNull]] |RETURNVALUE=
the leader of the formation is returned. If used on a dead unit, the returned value is [[objNull]]
   
   
|x1= <pre>? (formLeader player != leader player) :
|x1= <pre>? (formLeader player != leader player) :
  hint "The formation leader is different to the group leader!"</pre>
  hint "The formation leader is different to the group leader!"</pre>


returns X |EXAMPLE1=
returns X


| [[commandFollow]], [[doFollow]], [[formationLeader]], [[isFormationLeader]], [[leader]], [[selectLeader]], [[setLeader]] |SEEALSO=
| [[commandFollow]], [[doFollow]], [[formationLeader]], [[isFormationLeader]], [[leader]], [[selectLeader]], [[setLeader]]


}}
}}

Revision as of 01:38, 18 January 2021

Logo A0.png1.00
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:
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

Examples

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

Additional Information

See also:
commandFollowdoFollowformationLeaderisFormationLeaderleaderselectLeadersetLeader

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

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=formLeader&oldid=204881"