BIS fnc deleteTask: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
(page filling)
Line 1: Line 1:
{{Function|= Comments
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________
Line 8: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Deletes given task. |= Description
____________________________________________________________________________________________
Description:
 
Delete task
| [taskID,owner] call '''BIS_fnc_deleteTask''' |= Syntax
Parameters:
0: STRING - Task ID
1: Removed task owners (optional, the task will be removed for all existing owners by default)
BOOL - 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


Returns:
|p1= taskID: [[String]] - ID of the task |= Parameter 1
BOOL
*/
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_deleteTask]]; --> |= Syntax
|p2= 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|= Parameter 2


|p1= |= Parameter 1


| |= Return value
| [[Nothing]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=  
|x1= <code>[ "task_1" ] [[call]] '''BIS_fnc_deleteTask''';</code> |= example 1
|x2= <code>[ "task_1",[[west]] ] [[call]] '''BIS_fnc_deleteTask''';</code> |= example 2
|x3= <code>[ "task_1",[ [[west]], [[player]], [[group]] soldier ] ] [[call]] '''BIS_fnc_deleteTask''';</code> |= example 3
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[Arma_3_Task_Framework|Task Framework]] [[Arma_3_Task_Enhancements|Task Enhancements]] |= See also
| [[BIS_fnc_setTask]], [[Arma_3_Task_Framework|Task Framework]], [[Arma_3_Tasks_Overhaul|Tasks Overhaul]] |= See also
}}


}}


<h3 style="display:none">Notes</h3>
<h3 style="display:none">Notes</h3>

Revision as of 09:17, 11 May 2018

Arma 3 logo black.png1.06
Hover & click on the images for description

Description

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

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:
BIS_fnc_setTaskTask FrameworkTasks Overhaul

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


Notes

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_deleteTask&oldid=107333"