BIS fnc taskCreate

1.00

GAGlobalGEGlobal

Hover & click on the images for description

Description

Description:

Create a task.

ⓘ

See Arma 3 Task Framework for more information.

Execution:

call

Groups:

Tasks

Syntax

Syntax:

[owner, taskID, description, destination, state, priority, showNotification, type, visibleIn3D] call BIS_fnc_taskCreate

Parameters:

owner: 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

taskID:
String - Task ID
Array - In the format of [task ID, parent task ID]

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 - Use objNull to set no position
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 the current task is completed, the system selects the one with the largest priority >= 0. To avoid auto assignment of that task, give it a priority of -1.

showNotification (Optional): Boolean - true to show notification (default), false to disable it

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:

Boolean

Examples

Example 1:

[civilian, ["task1"], ["Do this and you get a cookie", "Earn Cookie", "cookiemarker"], [0,0,0] ,1, 2, true] call BIS_fnc_taskCreate;

Example 2:

[west, ["task2"], ["Good luck finding this cookie", "Find Cookie", "cookiemarker2"], objNull, 1, 3, true] call BIS_fnc_taskCreate; // Task without a map location

Example 3:

//description.ext// class CfgTaskTypes { class my_CfgTaskType { displayname = "Tank"; icon = "Tank_MCO.paa"; icon3D = "Tank_MCO.paa"; }; }; //calling the function// [east, ["taskType_"], ["Setting taskType", "The simple way", "marker2"], objNull, 1, 3, true, "my_CfgTaskType"] call BIS_fnc_taskCreate; // Task with a custom icon

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

Posted on February 2, 2018 - 13:15 (UTC)

Lou Montana

You can define a CfgTaskDescriptions part in description.ext, such as:

class CfgTaskDescriptions
{
	class myTask
	{
		title = $STR_MyTaskTitle;
		description = $STR_MyTaskDescription;
	};
};

This should allow tasks to be localised for every player in MP if created locally. You can use "myTask" as description (3^rd) parameter.