BIS fnc deleteTask: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "")
m (Text replacement - "since= Arma3" to "since= arma3")
 
(30 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function


| arma3 |Game name=
|game1= arma3
|version1= 1.06


|1.06|Game version=
|gr1= Tasks


|gr1 = Tasks |GROUP1=
|arg= global


|arg= global|Multiplayer Arguments=
|eff= global


|eff= global|Multiplayer Effects=
|descr= Deletes given task. {{Feature|informative| See [[Arma 3: Task Framework]].}}


| Deletes given task. {{Informative| See [[Arma 3: Task Framework]].}} |DESCRIPTION=
|s1= [taskID, owner, removeFromJIP] call [[BIS_fnc_deleteTask]]


| [taskID, owner] call '''BIS_fnc_deleteTask''' |SYNTAX=
|p1= taskID: [[String]] - ID of the task


|p1= taskID: [[String]] - ID of the task |PARAMETER1=
|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
* [[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 |PARAMETER2=
* [[Array]] - collection of above types
 
|p3= removeFromJIP: [[Boolean]] - [[true]] to also remove task from JIP queue, default [[false]]
 
|p3since= arma3 2.08
| [[Nothing]] |RETURNVALUE=
|r1= [[Nothing]]


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


| [[:Category:Function Group: Tasks|Task Functions]] [[Arma 3: Task Framework]] |SEEALSO=
|seealso=  [[Arma 3: Task Framework]]
}}
}}
<h3 style="display:none">Bottom Section</h3>

Latest revision as of 17:26, 9 February 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 - 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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_deleteTask&oldid=352427"