formationTask: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - "<code>_([a-zA-Z0-9_]+) = \[\[([a-zA-Z0-9]+)\]\] _([a-zA-Z0-9_]+);?<\/code>" to "<sqf>_$1 = $2 _$3;</sqf>")
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command


| arma1 |Game name=
|game1= arma1
|version1= 1.00


|1.00|Game version=
|game2= arma2
|version2= 1.00


|gr1= Groups |GROUP1=
|game3= arma2oa
|version3= 1.50


| Return the current task of the unit in the formation. {{Important|This command is not available in {{arma2}}.}}|DESCRIPTION=
|game4= tkoh
|version4= 1.00


| [[String]] <nowiki>=</nowiki> '''formationTask''' person |SYNTAX=
|game5= arma3
|version5= 0.50


|p1= person: [[Object]] |PARAMETER1=
|gr1= Groups


| [[String]]: (EXCLUDED, MOVE, COVER, LEADER) |RETURNVALUE=
|descr= Return the current task of the unit in the formation.
|x1= <pre>_CurrentTask = FormationTask _person </pre>
| [[setFormationTask]] |SEEALSO=


}}
|s1= [[formationTask]] unit
 
|p1= unit: [[Object]]


<h3 style="display:none">Notes</h3>
|r1= [[String]]: "EXCLUDED", "MOVE", "COVER", "LEADER", "NOTHING"
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x1= <sqf>_currentTask = formationTask _unit;</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[setFormationTask]]
[[Category:Scripting Commands|FORMATIONTASK]]
}}
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 21:24, 7 May 2022

Hover & click on the images for description

Description

Description:
Return the current task of the unit in the formation.
Groups:
Groups

Syntax

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

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