BIS fnc taskCompleted: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - "{{Feature|Informative|" to "{{Feature|informative|")
 
(40 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 1.00


|1.00|= Game version
|gr1= Tasks
____________________________________________________________________________________________
|arg= global
|eff= global


| Returns [[true]] if task has been completed. |DESCRIPTION=
|descr= Checks if task is completed. {{Feature|informative| See [[Arma 3: Task Framework]] for more information.}}
____________________________________________________________________________________________


| taskID call '''BIS_fnc_taskCompleted''' |SYNTAX=
|s1= taskID call [[BIS_fnc_taskCompleted]]


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


| [[Boolean]] - Returns [[true]] if completed, otherwise [[false]]|RETURNVALUE=
|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> |EXAMPLE1=
|x1= <sqf>private _completed = "task_1" call BIS_fnc_taskCompleted;</sqf>


____________________________________________________________________________________________
|seealso=  [[Arma 3: Task Framework]]
 
| [[BIS fnc deleteTask]],[[BIS fnc setTask]],[[BIS fnc setTaskLocal]],[[BIS fnc sharedObjectives]],[[BIS fnc taskAlwaysVisible]],[[BIS fnc taskChildren]],[[BIS fnc taskCreate]],[[BIS fnc taskCurrent]],[[BIS fnc taskDescription]],[[BIS fnc taskDestination]],[[BIS fnc taskExists]],[[BIS fnc taskHint]],[[BIS fnc taskParent]],[[BIS fnc taskReal]],[[BIS fnc taskSetAlwaysVisible]],[[BIS fnc taskSetCurrent]],[[BIS fnc taskSetDescription]],[[BIS fnc taskSetDestination]],[[BIS fnc taskSetState]],[[BIS fnc taskSetType]],[[BIS fnc taskState]],[[BIS fnc tasksUnit]],[[BIS fnc taskType]],[[BIS fnc taskTypeIcon]],[[BIS fnc taskVar]],[[Arma 3 Task Framework]],[[Arma 3 Tasks Overhaul]] |SEEALSO=
}}
}}
<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:taskCompleted}}]]
[[Category:Functions|{{uc:taskCompleted}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:taskCompleted}}]]

Latest revision as of 01: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"