BIS fnc taskCompleted: Difference between revisions

Latest revision as of 00:24, 2 February 2024

Hover & click on the images for description

Description:: Checks if task is completed.
ⓘ
See Arma 3: Task Framework for more information.
Execution:: call
Groups:: Tasks

Syntax:: taskID call BIS_fnc_taskCompleted
Parameters:: taskID: String - ID or name of the task
Return Value:: Boolean - returns true if task state is either "SUCCEEDED", "FAILED" or "CANCELED". Returns false for all other states and if task does not exist

: 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

@@ Line 1: / Line 1: @@
 {{RV|type=function
-| arma3
+|game1= arma3
+|version1= 1.00
-|1.00
 |gr1= Tasks
-|arg= global|eff= global
+|arg= global
+|eff= global
-|descr=  Returns [[true]] if task has been completed. {{Feature|Informative| See [[Arma 3: Task Framework]] for more information.}}
+|descr= Checks if task is completed. {{Feature|informative| See [[Arma 3: Task Framework]] for more information.}}
-|s1=  taskID call [[BIS_fnc_taskCompleted]]
+|s1= taskID call [[BIS_fnc_taskCompleted]]
 |p1= taskID: [[String]] - ID or name of the task
-|r1=[[Boolean]] - Returns [[true]] if completed, otherwise [[false]]
+|r1= [[Boolean]] - returns [[true]] if task state is either "SUCCEEDED", "FAILED" or "CANCELED". Returns [[false]] for all other states and if task does not exist
-|x1= <code>_completed = "task_1" [[call]] [[BIS_fnc_taskCompleted]];</code>
+|x1= <sqf>private _completed = "task_1" call BIS_fnc_taskCompleted;</sqf>
-|seealso= [[:Category:Function Group: Tasks|Task Functions]] [[Arma 3: Task Framework]]
+|seealso=  [[Arma 3: Task Framework]]
 }}