formLeader: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Command|Comments= | {{Command|Comments= | ||
| ofp |Game name= | | ofp |Game name= | ||
| Line 9: | Line 8: | ||
|arg= global |Multiplayer Arguments= | |arg= global |Multiplayer Arguments= | ||
| 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= | | 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= | ||
| [[Object]] <nowiki>=</nowiki> '''formLeader''' unitName |SYNTAX= | | [[Object]] <nowiki>=</nowiki> '''formLeader''' unitName |SYNTAX= | ||
| Line 20: | Line 17: | ||
| [[Object]] - | | [[Object]] - | ||
the leader of the formation is returned. If used on a dead unit, the returned value is [[objNull]] |RETURNVALUE= | the leader of the formation is returned. If used on a dead unit, the returned value is [[objNull]] |RETURNVALUE= | ||
|x1= <pre>? (formLeader player != leader player) : | |x1= <pre>? (formLeader player != leader player) : | ||
| Line 26: | Line 22: | ||
returns X |EXAMPLE1= | returns X |EXAMPLE1= | ||
| [[commandFollow]], [[doFollow]], [[formationLeader]], [[isFormationLeader]], [[leader]], [[selectLeader]], [[setLeader]] |SEEALSO= | | [[commandFollow]], [[doFollow]], [[formationLeader]], [[isFormationLeader]], [[leader]], [[selectLeader]], [[setLeader]] |SEEALSO= | ||
Revision as of 02:22, 17 January 2021
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:
- Object = 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:
? (formLeader player != leader player) : hint "The formation leader is different to the group leader!"
returns X
Additional Information
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
Notes
Bottom Section
Categories:
- Scripting Commands
- Introduced with Operation Flashpoint version 1.00
- Operation Flashpoint: New Scripting Commands
- Operation Flashpoint: Scripting Commands
- Command Group: Unit Control
- Scripting Commands OFP 1.99
- Scripting Commands OFP 1.96
- Scripting Commands OFP 1.46
- ArmA: Armed Assault: Scripting Commands
- Arma 2: Scripting Commands
- Arma 3: Scripting Commands
- Take On Helicopters: Scripting Commands