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: @@
-{{Function|Comments=
+{{RV|type=function
-____________________________________________________________________________________________
-| arma3 |Game name=
+|game1= arma3
+|version1= 1.06
-|1.06|Game version=
+|gr1= Tasks
-____________________________________________________________________________________________
-| Deletes given task. |DESCRIPTION=
+|arg= global
-____________________________________________________________________________________________
-| [taskID,owner] call '''BIS_fnc_deleteTask''' |SYNTAX=
+|eff= global
-|p1= taskID: [[String]] - ID of the task |PARAMETER1=
+|descr= Deletes given task. {{Feature|informative| See [[Arma 3: Task Framework]].}}
-|p2= owner: [[String]] - Owner of the task.(Optional) Can be:
+|s1= [taskID, owner, removeFromJIP] call [[BIS_fnc_deleteTask]]
-*[[Boolean]] - 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|PARAMETER2=
+|p1= taskID: [[String]] - ID of the task
-| [[Nothing]] |RETURNVALUE=
+|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>[ "task_1" ] [[call]] '''BIS_fnc_deleteTask''';</code> |EXAMPLE1=
+|p3= removeFromJIP: [[Boolean]] - (Optional, default [[false]]) [[true]] to also remove task from JIP queue
-|x2= <code>[ "task_1",[[west]] ] [[call]] '''BIS_fnc_deleteTask''';</code> |EXAMPLE2=
+|p3since= arma3 2.08
-|x3= <code>[ "task_1",[ [[west]], [[player]], [[group]] soldier ] ] [[call]] '''BIS_fnc_deleteTask''';</code> |EXAMPLE3=
-____________________________________________________________________________________________
-| [[BIS fnc setTask]],[[BIS fnc setTaskLocal]],[[BIS fnc sharedObjectives]],[[BIS fnc taskAlwaysVisible]],[[BIS fnc taskChildren]],[[BIS fnc taskCompleted]],[[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=
+|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}}]]