BIS fnc taskState: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " \|p([0-9]{1,2})=(.+) * + \| *(\[\[Str.+) * " to " |p$1=$2 |r1=$3 ") |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
| Line 1: | Line 1: | ||
{{RV|type=function | {{RV|type=function | ||
| arma3 | |game1= arma3 | ||
|version1= 0.76 | |||
| | |gr1= Tasks | ||
| | |arg= global | ||
| | |descr= Returns task's state. {{Feature|Informative| See [[Arma 3: Task Framework]] for more information.}} | ||
|s1= | |s1= taskID call [[BIS_fnc_taskState]] | ||
|p1= taskID: [[String]] - ID of the task | |p1= taskID: [[String]] - ID of the task | ||
|r1=[[String]] - State of the task. Can be: | |r1=[[String]] - State of the task. Can be: | ||
*AUTOASSIGNED | * "AUTOASSIGNED" | ||
*ASSIGNED | * "ASSIGNED" | ||
*CREATED | * "CREATED" | ||
*SUCCEEDED | * "SUCCEEDED" | ||
*FAILED | * "FAILED" | ||
*CANCELED | * "CANCELED" | ||
|x1= <code>"task_1" [[call]] [[BIS_fnc_taskState]];</code> | |x1= <code>"task_1" [[call]] [[BIS_fnc_taskState]];</code> | ||
|x2= <code>["task_1"] [[call]] [[BIS_fnc_taskState]];</code> | |x2= <code>["task_1"] [[call]] [[BIS_fnc_taskState]];</code> | ||
|seealso= [[:Category:Function Group: Tasks|Task Functions]] [[Arma 3: Task Framework]] | |seealso= [[:Category:Function Group: Tasks|Task Functions]] [[Arma 3: Task Framework]] | ||
}} | }} | ||
Revision as of 05:08, 13 June 2021
Description
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