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 - "(\|[pr][0-9]+ *= *[^- ]*) *- *U([a-z ])" to "$1 - u$2")
 
(26 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command


| arma1 |Game name=
|game1= arma1
|version1= 1.00


|1.00|Game version=
|game2= arma2
|version2= 1.00


|gr1= Groups |GROUP1=
|game3= arma2oa
|version3= 1.50


| Returns true if the specified unit is subgroup leader. |DESCRIPTION=
|game4= tkoh
|version4= 1.00


| '''isFormationLeader''' unit |SYNTAX=
|game5= arma3
|version5= 0.50


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


| [[Boolean]] - [[true]] if unit is subgroup leader. |RETURNVALUE=
|descr= Returns true if the specified unit is subgroup leader.


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


| [[commandFollow]], [[doFollow]], [[formationLeader]], [[formLeader]], [[leader]], [[selectLeader]], [[setLeader]] |SEEALSO=
|p1= unit: [[Object]] - unit being checked.


|r1= [[Boolean]] - [[true]] if unit is subgroup leader.
|x1= <sqf>_isLeader = isFormationLeader player;</sqf>
|seealso= [[commandFollow]] [[doFollow]] [[formationLeader]] [[formLeader]] [[leader]] [[selectLeader]] [[setLeader]]
}}
}}
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|ISFORMATIONLEADER]]
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 15:52, 8 November 2023

Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
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:
commandFollow doFollow formationLeader formLeader 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=isFormationLeader&oldid=349302"