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


| arma1 |Game name=
| arma1


|1.00|Game version=
|1.00


|gr1= Groups |GROUP1=
|gr1= Groups


| Returns true if the specified unit is subgroup leader. |DESCRIPTION=
| Returns true if the specified unit is subgroup leader.


| '''isFormationLeader''' unit |SYNTAX=
| '''isFormationLeader''' unit


|p1= unit: [[Object]] - Unit being checked. |PARAMETER1=
|p1= unit: [[Object]] - Unit being checked.


| [[Boolean]] - [[true]] if unit is subgroup leader. |RETURNVALUE=
| [[Boolean]] - [[true]] if unit is subgroup leader.


|x1= <code>_isLeader = [[isFormationLeader]] [[player]];</code> |EXAMPLE1=
|x1= <code>_isLeader = [[isFormationLeader]] [[player]];</code>


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


}}
}}

Revision as of 00:41, 18 January 2021

Hover & click on the images for description

Description

Description:
Returns true if the specified unit is subgroup leader.
Groups:
Groups

Syntax

Syntax:
isFormationLeader unit
Parameters:
unit: Object - Unit being checked.
Return Value:
Boolean - true if unit is subgroup leader.

Examples

Example 1:
_isLeader = isFormationLeader player;

Additional Information

See also:
commandFollowdoFollowformationLeaderformLeaderleaderselectLeadersetLeader

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