formLeader: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\| \[\[.+\]\] \<nowiki\>\=\<\/nowiki\> " to "| ")
m (Some wiki formatting)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| ofp
|game1= ofp
|version1= 1.00


|1.00
|game2= ofpe
|version2= 1.00
 
|game3= arma1
|version3= 1.00
 
|game4= arma2
|version4= 1.00
 
|game5= arma2oa
|version5= 1.50
 
|game6= tkoh
|version6= 1.00
 
|game7= arma3
|version7= 0.50


|gr1= Unit Control
|gr1= Unit Control
Line 9: Line 26:
|arg= global
|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.
|descr= 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.


| '''formLeader''' unitName
|s1= [[formLeader]] unitName


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


| [[Object]] -
|r1= [[Object]] - the leader of the formation is returned. If used on a dead unit, the returned value is [[objNull]]
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= <code>[[if]] ([[formLeader]] [[player]] != [[leader]] [[player]]) [[then]]
hint "The formation leader is different to the group leader!"</pre>
{
 
[[hint]] "The formation leader is different to the group leader!";
returns X
};</code>


|seealso= [[commandFollow]], [[doFollow]], [[formationLeader]], [[isFormationLeader]], [[leader]], [[selectLeader]], [[setLeader]]
|seealso= [[commandFollow]], [[doFollow]], [[formationLeader]], [[isFormationLeader]], [[leader]], [[selectLeader]], [[setLeader]]
}}
}}
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Revision as of 15:48, 9 June 2021

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