BIS fnc deleteTask: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "Task Functions" to "")
No edit summary
Line 12: Line 12:
|descr= Deletes given task. {{Feature|Informative| See [[Arma 3: Task Framework]].}}
|descr= Deletes given task. {{Feature|Informative| See [[Arma 3: Task Framework]].}}


|s1=[taskID, owner] call [[BIS_fnc_deleteTask]]
|s1=[taskID, owner, removeFromJIP] call [[BIS_fnc_deleteTask]]


|p1= taskID: [[String]] - ID of the task
|p1= taskID: [[String]] - ID of the task
Line 22: Line 22:
* [[Side]] - all objects of the given side
* [[Side]] - all objects of the given side
* [[Array]] - collection of above types
* [[Array]] - collection of above types
 
|p3= removeFromJIP: [[Boolean]] - [[true]] to also remove task from JIP queue, default [[false]]
|p3since= Arma3 2.08
|r1= [[Nothing]]
|r1= [[Nothing]]



Revision as of 19:00, 23 November 2021

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