BIS fnc taskState: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(example 1)
m (Text replacement - "{{Feature|Informative|" to "{{Feature|informative|")
 
(36 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 0.76


| arma3 |= Game name
|gr1= Tasks


|0.76|= Game version
|arg= global
____________________________________________________________________________________________


| <pre>/*
|descr= Returns task's state. {{Feature|informative| See [[Arma 3: Task Framework]] for more information.}}
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
|s1= taskID call [[BIS_fnc_taskState]]
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_taskState]]; --> |= Syntax
|p1= taskID: [[String]] - ID of the task


|p1= |= Parameter 1
|r1= [[String]] - state of the task. Can be:
* "AUTOASSIGNED"
* "ASSIGNED"
* "CREATED"
* "SUCCEEDED"
* "FAILED"
* "CANCELED"


| |= Return value
|x1= <sqf>"task_1" call BIS_fnc_taskState;</sqf>
____________________________________________________________________________________________


|x1= <code>_currTaskState = ["task1"] [[call]] [[BIS_fnc_taskState]];</code> |=
|x2= <sqf>["task_1"] call BIS_fnc_taskState;</sqf>
____________________________________________________________________________________________
 
| |= See also


|seealso=  [[Arma 3: Task Framework]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Tasks|{{uc:taskState}}]]
[[Category:Functions|{{uc:taskState}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:taskState}}]]

Latest revision as of 01:25, 2 February 2024

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:
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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_taskState&oldid=352114"