BIS fnc taskCompleted: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
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...)
m (Text replacement - "{{Feature|Informative|" to "{{Feature|informative|")
 
(30 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function
{{RV|type=function


| arma3
|game1= arma3
 
|version1= 1.00
|1.00


|gr1= Tasks
|gr1= Tasks
|arg= global|Multiplayer Arguments=
|arg= global
|eff= global


|eff= global|Multiplayer Effects=
|descr= Checks if task is completed. {{Feature|informative| See [[Arma 3: Task Framework]] for more information.}}


| Returns [[true]] if task has been completed. {{Informative| See [[Arma 3: Task Framework]] for more information.}}
|s1= taskID call [[BIS_fnc_taskCompleted]]
 
| taskID call '''BIS_fnc_taskCompleted'''


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


| [[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=  [[Arma 3: Task Framework]]
| [[:Category:Function Group: Tasks|Task Functions]] [[Arma 3: Task Framework]]
}}
}}
<h3 style="display:none">Bottom Section</h3>
[[Category:Functions|{{uc:taskCompleted}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:taskCompleted}}]]

Latest revision as of 00:24, 2 February 2024

Arma 3 logo black.png1.00
GAGlobalGEGlobal
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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_taskCompleted&oldid=352054"