BIS fnc deleteTask: Difference between revisions

Latest revision as of 15:01, 14 June 2024

1.06

GAGlobal GEGlobal

Hover & click on the images for description

Description

Description:: Deletes given task.
ⓘ
See Arma 3: Task Framework.
Execution:: call
Groups:: Tasks

Syntax

Syntax:

[taskID, owner, removeFromJIP] call BIS_fnc_deleteTask

Parameters:

taskID: String - ID of the task

owner: String - (Optional) owner of the task. Can be:

Boolean - true to use all playable units
Object - specific object
Group - all objects in the group
Side - all objects of the given side
Array - collection of above types

since 2.08

removeFromJIP: Boolean - (Optional, default false) true to also remove task from JIP queue

Return Value:

Nothing

Examples

Example 1:: ["task_1"] call BIS_fnc_deleteTask;
Example 2:: ["task_1", west] call BIS_fnc_deleteTask;
Example 3:: ["task_1", [west, player, group soldier]] call BIS_fnc_deleteTask;

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

@@ Line 1: / Line 1: @@
+{{RV|type=function
-{{Function|= Comments
+|game1= arma3
-____________________________________________________________________________________________
+|version1= 1.06
-| arma3 |= Game name
+|gr1= Tasks
-|1.06|= Game version
+|arg= global
-____________________________________________________________________________________________
-| <pre>/*
+|eff= global
-	Description:
-	Delete task
-	Parameters:
-: STRING - Task ID
-: Removed task owners (optional, the task will be removed for all existing owners by default)
-			BOOL - true to useall playable units
-			OBJECT - specific object
-			GROUP - all objects in the group
-			SIDE - all objects of the given side
-			ARRAY - collection of above types
-	Returns:
+|descr= Deletes given task. {{Feature|informative| See [[Arma 3: Task Framework]].}}
-	BOOL
-*/
-</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
-____________________________________________________________________________________________
-| <!-- [] call [[BIS_fnc_deleteTask]]; --> |= Syntax
+|s1= [taskID, owner, removeFromJIP] call [[BIS_fnc_deleteTask]]
-|p1= |= Parameter 1
+|p1= taskID: [[String]] - ID of the task
-| |= Return value
+|p2= owner: [[String]] - (Optional) owner of the task. Can be:
-____________________________________________________________________________________________
+* [[Boolean]] - true to use all playable units
+* [[Object]] - specific object
+* [[Group]] - all objects in the group
+* [[Side]] - all objects of the given side
+* [[Array]] - collection of above types
-|x1= <code></code> |=
+|p3= removeFromJIP: [[Boolean]] - (Optional, default [[false]]) [[true]] to also remove task from JIP queue
-____________________________________________________________________________________________
+|p3since= arma3 2.08
-| |= See also
+|r1= [[Nothing]]
-}}
+|x1= <sqf>["task_1"] call BIS_fnc_deleteTask;</sqf>
-<h3 style="display:none">Notes</h3>
+|x2= <sqf>["task_1", west] call BIS_fnc_deleteTask;</sqf>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
+|x3= <sqf>["task_1", [west, player, group soldier]] call BIS_fnc_deleteTask;</sqf>
-</dl>
-<h3 style="display:none">Bottom Section</h3>
+|seealso= [[Arma 3: Task Framework]]
-[[Category:Function Group: Tasks|{{uc:deleteTask}}]]
+}}
-[[Category:Functions|{{uc:deleteTask}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:deleteTask}}]]