BIS fnc taskCompleted: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|arg= global|eff= global" to "|arg= global |eff= global")
m (Text replacement - "{{Feature|Informative|" to "{{Feature|informative|")
 
(One intermediate revision by the same user not shown)
Line 8: Line 8:
|eff= global
|eff= global


|descr= Checks if task is 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]]
Line 14: Line 14:
|p1= taskID: [[String]] - ID or name of the task
|p1= taskID: [[String]] - ID or name of the task


|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
|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= <sqf>private _completed = "task_1" call BIS_fnc_taskCompleted;</sqf>
|x1= <sqf>private _completed = "task_1" call BIS_fnc_taskCompleted;</sqf>

Latest revision as of 00:24, 2 February 2024

Hover & click on the images for description

Description

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

Syntax

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

Examples

Example 1:
private _completed = "task_1" call BIS_fnc_taskCompleted;

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