formationTask: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\{\{( *)Important( *)\|" to "{{$1Feature$2|$2important$2|")
m (page formatting)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma1
|game1= arma1


|1.00
|version1= 1.00


|gr1= Groups
|gr1= Groups


| Return the current task of the unit in the formation. {{Feature|important|This command is not available in {{arma2}}.}}
|descr= Return the current task of the unit in the formation. {{Feature|important|This command is not available in {{arma2}}.}}


| [[String]] <nowiki>=</nowiki> '''formationTask''' person
|s1= [[formationTask]] unit


|p1= person: [[Object]]
|p1= unit: [[Object]]


| [[String]]: (EXCLUDED, MOVE, COVER, LEADER)
|r1= [[String]]: "EXCLUDED", "MOVE", "COVER", "LEADER"
|x1= <pre>_CurrentTask = FormationTask _person </pre>
 
| [[setFormationTask]]
|x1= <code>_currentTask = [[formationTask]] _unit;</code>
 
|seealso= [[setFormationTask]]
}}
}}


{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma1|Scripting Commands}}

Revision as of 02:27, 7 February 2021

Hover & click on the images for description

Description

Description:
Return the current task of the unit in the formation.
This command is not available in Arma 2.
Groups:
Groups

Syntax

Syntax:
formationTask unit
Parameters:
unit: Object
Return Value:
String: "EXCLUDED", "MOVE", "COVER", "LEADER"

Examples

Example 1:
_currentTask = formationTask _unit;

Additional Information

See also:
setFormationTask

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