BIS fnc deleteTask: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \| *(\[[a-zA-Z,. ]*\] call ('''|\[\[)?BI(N|S)_fnc_[a-zA-Z]+('''|\]\])?) * \|p1=" to " |s1=$1 |p1=")
m (Some wiki formatting)
 
(21 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function
{{RV|type=function


| arma3
|game1= arma3
 
|version1= 1.06
|1.06


|gr1= Tasks
|gr1= Tasks
Line 11: Line 10:
|eff= global
|eff= global


| 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


|p2= owner: [[String]] - Owner of the task.(Optional) Can be:
|p2= owner: [[String]] - (Optional) owner of the task. Can be:
* [[Boolean]] - true to useall playable units
* [[Boolean]] - true to use all playable units
* [[Object]]- specific object
* [[Object]] - specific object
* [[Group]] - all objects in the group
* [[Group]] - all objects in the group
* [[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]] - (Optional, default [[false]]) [[true]] to also remove task from JIP queue
|p3since= arma3 2.08


|r1= [[Nothing]]
|r1= [[Nothing]]


|x1= <code>["task_1"] [[call]] '''BIS_fnc_deleteTask''';</code>
|x1= <sqf>["task_1"] call BIS_fnc_deleteTask;</sqf>
|x2= <code>["task_1", [[west]]] [[call]] '''BIS_fnc_deleteTask''';</code>
 
|x3= <code>["task_1", [<nowiki/>[[west]], [[player]], [[group]] soldier]] [[call]] '''BIS_fnc_deleteTask''';</code>
|x2= <sqf>["task_1", west] call BIS_fnc_deleteTask;</sqf>
 
|x3= <sqf>["task_1", [west, player, group soldier]] call BIS_fnc_deleteTask;</sqf>


|seealso= [[:Category:Function Group: Tasks|Task Functions]] [[Arma 3: Task Framework]]
|seealso= [[Arma 3: Task Framework]]
}}
}}

Latest revision as of 15:01, 14 June 2024

Arma 3 logo black.png1.06
GAGlobalGEGlobal
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 - (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 Arma 3 logo black.png2.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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_deleteTask&oldid=364798"