BIS fnc taskState: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "^ \{\{(Command|Function)" to "{{$1")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|0.76|Game version=
|0.76


|gr1= Tasks |GROUP1=
|gr1= Tasks


|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.}}


| taskID call '''BIS_fnc_taskState''' |SYNTAX=
| taskID call '''BIS_fnc_taskState'''


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


| [[String]] - State of the task. Can be:
| [[String]] - State of the task. Can be:
Line 21: Line 21:
*SUCCEEDED
*SUCCEEDED
*FAILED
*FAILED
*CANCELED|RETURNVALUE=
*CANCELED


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




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


Revision as of 00:44, 18 January 2021

Arma 3 logo black.png0.76
GAGlobal
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

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_taskState&oldid=203497"