BIS fnc deleteTask: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "= <code>([^<{]+)<\/code>" to "= <sqf>$1</sqf>")
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *O([a-z ])" to "$1 - o$2")
Line 16: Line 16:
|p1= taskID: [[String]] - ID of the task
|p1= taskID: [[String]] - ID of the task


|p2= owner: [[String]] - Owner of the task.(Optional) Can be:
|p2= owner: [[String]] - owner of the task.(Optional) Can be:
* [[Boolean]] - true to useall playable units
* [[Boolean]] - true to useall playable units
* [[Object]]- specific object
* [[Object]]- specific object

Revision as of 16:44, 8 November 2023

Hover & click on the images for description

Description

Description:
Deletes given task.
Execution:
call
Groups:
Tasks

Syntax

Syntax:
[taskID, owner, removeFromJIP] call BIS_fnc_deleteTask
Parameters:
taskID: String - ID of the task
owner: String - owner of the task.(Optional) Can be:
  • 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
since Arma 3 logo black.png2.08
removeFromJIP: Boolean - true to also remove task from JIP queue, default false
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