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 - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.06|Game version=
|1.06


|gr1 = Tasks |GROUP1=
|gr1 = Tasks


|arg= global|Multiplayer Arguments=
|arg= global|Multiplayer Arguments=
Line 11: Line 11:
|eff= global|Multiplayer Effects=
|eff= global|Multiplayer Effects=


| Deletes given task. {{Informative| See [[Arma 3: Task Framework]].}} |DESCRIPTION=
| Deletes given task. {{Informative| See [[Arma 3: Task Framework]].}}


| [taskID, owner] call '''BIS_fnc_deleteTask''' |SYNTAX=
| [taskID, owner] call '''BIS_fnc_deleteTask'''


|p1= taskID: [[String]] - ID of the task |PARAMETER1=
|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:
Line 22: Line 22:
* [[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




| [[Nothing]] |RETURNVALUE=
| [[Nothing]]


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


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



Revision as of 23:04, 17 January 2021

Hover & click on the images for description

Description

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

Syntax

Syntax:
[taskID, owner] 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
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:
Task Functions 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


Bottom Section