formationTask: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
 
m (Text replacement - "<code>_([a-zA-Z0-9_]+) = \[\[([a-zA-Z0-9]+)\]\] _([a-zA-Z0-9_]+);?<\/code>" to "<sqf>_$1 = $2 _$3;</sqf>")
 
(51 intermediate revisions by 11 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|HINTCARRAY]]
{{RV|type=command
[[Category:Scripting Commands ArmA|HINTCARRAY]]


|game1= arma1
|version1= 1.00


<h2 style="color:#000066">''title '' ''' hintC  '' [text1, text2, ...]'''''</h2>
|game2= arma2
|version2= 1.00


|game3= arma2oa
|version3= 1.50


'''Operand types:'''
|game4= tkoh
|version4= 1.00


'''title''': [[String]]
|game5= arma3
   
|version5= 0.50
'''[text1, text2, ...]''': [[Array]]


'''Type of returned value:'''
|gr1= Groups


[[Nothing]]
|descr= Return the current task of the unit in the formation.


'''Compatibility:'''
|s1= [[formationTask]] unit


Version 2.01 required.
|p1= unit: [[Object]]


'''Description:'''
|r1= [[String]]: "EXCLUDED", "MOVE", "COVER", "LEADER", "NOTHING"


Creates a hint dialog with the given title and text. Texts can be plain or structured.
|x1= <sqf>_currentTask = formationTask _unit;</sqf>
 
|seealso= [[setFormationTask]]
}}

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