formLeader: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (template:command argument fix) |
||
| Line 9: | Line 9: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| 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. |= | | 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 |= | | [[Object]] <nowiki>=</nowiki> '''formLeader''' unitName |SYNTAX= | ||
|p1= unitName: [[Object]] |= | |p1= unitName: [[Object]] |PARAMETER1= | ||
| [[Object]] - | | [[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]] |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 23: | Line 23: | ||
hint "The formation leader is different to the group leader!"</pre> | hint "The formation leader is different to the group leader!"</pre> | ||
returns X |= | returns X |EXAMPLE1= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[formationLeader]], [[leader]], [[isFormationLeader]], [[selectLeader]] |= | | [[formationLeader]], [[leader]], [[isFormationLeader]], [[selectLeader]] |SEEALSO= | ||
}} | }} | ||
Revision as of 14:39, 7 April 2019
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:
- Uncategorised
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: Uncategorised
- Scripting Commands OFP 1.99
- Scripting Commands OFP 1.96
- Scripting Commands OFP 1.46
- Scripting Commands ArmA
- Command Group: Groups
- Command Group: Object Information
- Scripting Commands ArmA2
- Scripting Commands Arma 3
- Scripting Commands Take On Helicopters