formationLeader: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<dl class="command_description"> <dt></dt>" to "<dl class="command_description"> <dt></dt>")
m (Some wiki formatting)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma1
|game1= arma1
|version1= 1.00


|1.00
|game2= arma2
|version2= 1.00
 
|game3= arma2oa
|version3= 1.50
 
|game4= tkoh
|version4= 1.00
 
|game5= arma3
|version5= 0.50


|gr1= Unit Control
|gr1= Unit Control


| Return leader of the formation.
|descr= Return leader of the formation.


|s1= '''formationLeader''' unitName
|s1= [[formationLeader]] unitName


|p1= unitName: [[Object]]
|p1= unitName: [[Object]]
Line 15: Line 26:
|r1= [[Object]]
|r1= [[Object]]


|x1= <pre>? (formationLeader player != leader player) :
|x1= <code>[[if]] ([[formationLeader]] [[player]] != [[leader]] [[player]]) [[then]]
hint "Formation leader is not the group leader."</pre>
{
[[hint]] "Formation leader is not the group leader.";
};</code>


|seealso= [[commandFollow]], [[doFollow]], [[formLeader]], [[isFormationLeader]], [[leader]], [[selectLeader]], [[setLeader]]
|seealso= [[commandFollow]], [[doFollow]], [[formLeader]], [[isFormationLeader]], [[leader]], [[selectLeader]], [[setLeader]]
Line 25: Line 38:
<dt></dt>
<dt></dt>
<dd class="notedate">Posted on December 2, 2006 - 00:46</dd>
<dd class="notedate">Posted on December 2, 2006 - 00:46</dd>
<dt class="note">[[User:Kronzky|Kronzky]]<dd class="note">Return value is <NULL-OBJECT> if no group members exist.
<dt class="note">[[User:Kronzky|Kronzky]]</dt>
<dd class="note">Return value is <NULL-OBJECT> if no group members exist.</dd>


</dl>
</dl>
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Revision as of 14:34, 12 June 2021

Hover & click on the images for description

Description

Description:
Return leader of the formation.
Groups:
Unit Control

Syntax

Syntax:
formationLeader unitName
Parameters:
unitName: Object
Return Value:
Object

Examples

Example 1:
if (formationLeader player != leader player) then { hint "Formation leader is not the group leader."; };

Additional Information

See also:
commandFollowdoFollowformLeaderisFormationLeaderleaderselectLeadersetLeader

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
Posted on December 2, 2006 - 00:46
Kronzky
Return value is <NULL-OBJECT> if no group members exist.