BIS fnc taskState: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "[[Arma 3 Task Framework" to "[[Arma 3: Task Framework")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:


{{Function|Comments=
{{Function|Comments=
____________________________________________________________________________________________


| arma3 |Game name=
| arma3 |Game name=
Line 10: Line 9:


|arg= global|Multiplayer Arguments=
|arg= global|Multiplayer Arguments=
____________________________________________________________________________________________


|  Returns task's state. {{Informative| See [[Arma 3: Task Framework]] for more information.}} |DESCRIPTION=
|  Returns task's state. {{Informative| See [[Arma 3: Task Framework]] for more information.}} |DESCRIPTION=
____________________________________________________________________________________________


| taskID call '''BIS_fnc_taskState''' |SYNTAX=
| taskID call '''BIS_fnc_taskState''' |SYNTAX=
Line 26: Line 23:
*FAILED
*FAILED
*CANCELED|RETURNVALUE=
*CANCELED|RETURNVALUE=
____________________________________________________________________________________________


|x1= <code>"task_1" [[call]] '''BIS_fnc_taskState''';</code> |EXAMPLE1=
|x1= <code>"task_1" [[call]] '''BIS_fnc_taskState''';</code> |EXAMPLE1=
|x2= <code>["task_1"] [[call]] '''BIS_fnc_taskState''';</code> |EXAMPLE2=
|x2= <code>["task_1"] [[call]] '''BIS_fnc_taskState''';</code> |EXAMPLE2=


____________________________________________________________________________________________


| [[:Category:Function Group: Tasks|Task Functions]] [[Arma 3: Task Framework]]  |SEEALSO=
| [[:Category:Function Group: Tasks|Task Functions]] [[Arma 3: Task Framework]]  |SEEALSO=

Revision as of 23:45, 16 January 2021


Hover & click on the images for description

Description

Description:
Returns task's state.
See Arma 3: Task Framework for more information.
Execution:
call
Groups:
Tasks

Syntax

Syntax:
taskID call BIS_fnc_taskState
Parameters:
taskID: String - ID of the task
Return Value:
String - State of the task. Can be:
  • AUTOASSIGNED
  • ASSIGNED
  • CREATED
  • SUCCEEDED
  • FAILED
  • CANCELED

Examples

Example 1:
"task_1" call BIS_fnc_taskState;
Example 2:
["task_1"] call BIS_fnc_taskState;

Additional Information

See also:
Task Functions Arma 3: Task Framework

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