BIS fnc deleteTask: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "= <code>([^<{]+)<\/code>" to "= <sqf>$1</sqf>") |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 10: | Line 10: | ||
|eff= global | |eff= global | ||
|descr= Deletes given task. {{Feature| | |descr= Deletes given task. {{Feature|informative| See [[Arma 3: Task Framework]].}} | ||
|s1= [taskID, owner, removeFromJIP] call [[BIS_fnc_deleteTask]] | |s1= [taskID, owner, removeFromJIP] call [[BIS_fnc_deleteTask]] | ||
| Line 16: | Line 16: | ||
|p1= taskID: [[String]] - ID of the task | |p1= taskID: [[String]] - ID of the task | ||
|p2= owner: [[String]] - | |p2= owner: [[String]] - (Optional) owner of the task. Can be: | ||
* [[Boolean]] - true to | * [[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]] - [[true]] to also remove task from JIP queue | |||
|p3since= | |p3= removeFromJIP: [[Boolean]] - (Optional, default [[false]]) [[true]] to also remove task from JIP queue | ||
|p3since= arma3 2.08 | |||
|r1= [[Nothing]] | |r1= [[Nothing]] | ||
|x1= <sqf>["task_1"] call BIS_fnc_deleteTask;</sqf> | |x1= <sqf>["task_1"] call BIS_fnc_deleteTask;</sqf> | ||
|x2= <sqf>["task_1", west] call BIS_fnc_deleteTask;</sqf> | |x2= <sqf>["task_1", west] call BIS_fnc_deleteTask;</sqf> | ||
|x3= <sqf>["task_1", [west, player, group soldier]] call BIS_fnc_deleteTask;</sqf> | |x3= <sqf>["task_1", [west, player, group soldier]] call BIS_fnc_deleteTask;</sqf> | ||
|seealso= | |seealso= [[Arma 3: Task Framework]] | ||
}} | }} | ||
Latest revision as of 15:01, 14 June 2024
Description
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:
- since
2.08 - removeFromJIP: Boolean - (Optional, default false) true to also remove task from JIP queue
- Return Value:
- Nothing
Examples
- Example 1:
- Example 2:
- Example 3:
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