BIS fnc taskState: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (template:command argument fix)
(2 intermediate revisions by 2 users not shown)
Line 8: Line 8:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Returns task's state. |DESCRIPTION=
Description:
Return a task's state.
Parameters:
0: STRING - Task name
Returns:
STRING - task's state.
*/
 
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_taskState]]; --> |= Syntax
| taskID call '''BIS_fnc_taskState''' |SYNTAX=


|p1= |= Parameter 1
|p1= taskID: [[String]] - ID of the task |PARAMETER1=


| |= Return value
| [[String]] - State of the task. Can be:
*AUTOASSIGNED
*ASSIGNED
*CREATED
*SUCCEEDED
*FAILED
*CANCELED|RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


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


| |= See also
| [[BIS_fnc_setTask]], [[Arma_3_Task_Framework|Task Framework]], [[Arma_3_Tasks_Overhaul|Tasks Overhaul]] |SEEALSO=
 
}}
}}



Revision as of 15:33, 7 April 2019


Hover & click on the images for description

Description

Description:
Returns task's state.
Execution:
call
Groups:
Uncategorised

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:
BIS_fnc_setTaskTask FrameworkTasks Overhaul

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