BIS_fnc_setTask

Description

Set task parameters.

Create the task when it doesn't exist.

Note

See Arma 3: Task Framework for more information.

Syntax

[taskId, target, description, (destination, state, priority, showNotification, isGlobal, type, visibleIn3D)] call BIS_fnc_setTask

Parameters:

• taskId:
  String - Task ID
  Array - In the format of [task ID, parent task ID]
• target: Task owner(s)
  Boolean - true to set task of all playable units
  Object - set task of a specific object
  Group - set tasks of all objects in the group
  Side - set tasks of all objects of the given side
  Array - collection of above types
• description:
  Array - Task description in the format ["description", "title", "marker"]
  String - CfgTaskDescriptions class name, if empty string is used then CfgTaskDescriptions is searched for a class matching the tasks TaskID
• destination (Optional): Task destination
  Object
  Array - either position in format [x,y,z], or [object,precision] as used by setSimpleTaskTarget command
• state (Optional): Task state
  String - can be one of following:
  "CREATED"
  "ASSIGNED"
  "AUTOASSIGNED" ("ASSIGNED" when no task is assigned yet, otherwise "CREATED")
  "SUCCEEDED"
  "FAILED"
  "CANCELED"
  Boolean - true to set the task as current
• priority (Optional): Number - priority. When a current task is completed, system select a next one with the larges priority >= 0
• showNotification (Optional): Boolean - true to show notification (default), false to disable it
• isGlobal (Optional): Boolean - true to set task globally (default), false to set it only locally
• type (Optional): String - task type from CfgTaskTypes, if not defined, type "" is being used
• visibleIn3D (Optional): Boolean - true to make task always visible in 3D (default: false)

Returns: String - task ID

Examples

Example 1

["Task_01", true, ["Protect the respawn point.","Respawn Point West","respawn_west"], [MHQ,false], "ASSIGNED", 5, true, true, "Defend", true] call BIS_fnc_setTask;

See also

Arma 3: Task Framework