formLeader: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category\: ?Command[ _]Group\:.*\|\{\{uc\:\{\{PAGENAME\}\}\}\}\]\] " to "")
m (Text replacement - "<sqf>([^↵][^\/]*↵[^\/]*)<\/sqf>" to "<sqf> $1 </sqf>")
 
(33 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| ofp |Game name=
|game1= ofp
|version1= 1.00


|gr1= Groups |GROUP1=
|game2= ofpe
|version2= 1.00


|game3= arma1
|version3= 1.00


|game4= arma2
|version4= 1.00


|1.00|Game version=
|game5= arma2oa
|gr1= Groups |GROUP1=
|version5= 1.50


|arg= global |Multiplayer Arguments=
|game6= tkoh
____________________________________________________________________________________________
|version6= 1.00


| 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=
|game7= arma3
____________________________________________________________________________________________
|version7= 0.50


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


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


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


returns X |EXAMPLE1=
|s1= [[formLeader]] unitName
____________________________________________________________________________________________


| [[commandFollow]], [[doFollow]], [[formationLeader]], [[isFormationLeader]], [[leader]], [[selectLeader]], [[setLeader]] |SEEALSO=
|p1= unitName: [[Object]]


}}
|r1= [[Object]] - the leader of the formation is returned. If used on a dead unit, the returned value is [[objNull]]


<h3 style="display:none">Notes</h3>
|x1= <sqf>
<dl class="command_description">
if (formLeader player != leader player) then
<!-- Note Section BEGIN -->
{
hint "The formation leader is different to the group leader!";
};
</sqf>


<!-- Note Section END -->
|seealso= [[commandFollow]] [[doFollow]] [[formationLeader]] [[isFormationLeader]] [[leader]] [[selectLeader]] [[setLeader]]
</dl>
}}
 
<h3 style="display:none">Bottom Section</h3>
[[Category:Scripting Commands|FORMLEADER]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|FORMLEADER]]
[[Category:Scripting Commands OFP 1.46|FORMLEADER]]
[[Category:Scripting Commands Armed Assault|FORMLEADER]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]

Latest revision as of 11:34, 3 September 2024

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:
commandFollow doFollow formationLeader isFormationLeader 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=formLeader&oldid=369162"