BIS_fnc_setTask

From Bohemia Interactive Community
Jump to: navigation, search
Introduced with Arma 3 version 1.00
  

Click on the images for descriptions

Introduced in

Game:
Arma 3
Version:
1.00

Description

Description:
Set task parameters.
Create the task when it doesn't exist.

Syntax

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)
Return Value:
String - Task ID

Examples

Example 1:
Example needed

Additional Information

Execution:
call
Multiplayer:
-
See also:
BIS fnc deleteTaskBIS fnc setTaskLocalBIS fnc sharedObjectivesBIS fnc taskAlwaysVisibleBIS fnc taskChildrenBIS fnc taskCompletedBIS fnc taskCreateBIS fnc taskCurrentBIS fnc taskDescriptionBIS fnc taskDestinationBIS fnc taskExistsBIS fnc taskHintBIS fnc taskParentBIS fnc taskRealBIS fnc taskSetAlwaysVisibleBIS fnc taskSetCurrentBIS fnc taskSetDescriptionBIS fnc taskSetDestinationBIS fnc taskSetStateBIS fnc taskSetTypeBIS fnc taskStateBIS fnc tasksUnitBIS fnc taskTypeBIS fnc taskTypeIconBIS fnc taskVarArma 3 Task FrameworkArma 3 Tasks Overhaul

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Bottom Section