Task Framework Tutorial – Arma 3

From Bohemia Interactive Community
Revision as of 17:28, 22 July 2022 by Lou Montana (talk | contribs) (Some wiki formatting)
Jump to: navigation, search

Basics

Tasks are a group's objectives. Arma 3 introduced the Arma 3: Task Framework to work with tasks with ease.
The Task Framework functions have a global effect.


ⓘ
For Arma 2's Task Tutorial, see Arma 2: Task Tutorial.


How to use a task

Create a task

Copy
private _title = "Get the documents"; private _description = "Enter the house to find the documents. Hurry, as the enemy is on its way."; private _waypoint = "House"; private _myTask = [groupOfPlayers, "taskID", [_description, _title, _waypoint], objDocuments, true] call BIS_fnc_taskCreate;

ⓘ
The "taskID" argument is the task's ID used for later references. This string gets defined here on creation and must be unique for each task. It should be kept short for network economy.

Assign a task

Copy
"taskID" call BIS_fnc_taskSetCurrent;

ⓘ
This step is optional here as we used true as the fifth argument of the BIS_fnc_taskCreate call, making it the current task.

Set a task's type

Copy
["taskID", "attack"] call BIS_fnc_taskSetType;

ⓘ
This could have been set in the task creation call as the eighth argument. See BIS_fnc_taskCreate's type parameter.

Set a task's visibility

Copy
["taskID", true] call BIS_fnc_taskSetAlwaysVisible;

Update a task's description

Copy
_description = _description + "<br/><br/>UPDATE: an officer stole the documents; we got the GPS tracking, follow your HUD."; ["taskID", [_description, _title, _waypoint]] call BIS_fnc_taskSetDescription;

Update a task's waypoint position

Copy
["taskID", [theOfficer, true]] call BIS_fnc_taskSetDestination;

Update a task's status

Copy
["taskID", "SUCCEEDED"] call BIS_fnc_taskSetState;

Delete a task

Copy
["taskID"] call BIS_fnc_deleteTask;


How to read a task's information

Find if a task exists

Copy
["taskID"] call BIS_fnc_taskExists;

Find if a task is completed

Copy
"taskID" call BIS_fnc_taskCompleted;

ⓘ
"Completed" means that the task is either "SUCCEEDED", "FAILED" or "CANCELED".

Check if multiple tasks are all completed

Copy
["taskID_0", "taskID_1", "taskID_2"] findIf {!(_x call BIS_fnc_taskCompleted)} == -1

Get a task's status

Copy
"taskID" call BIS_fnc_taskState;

Get a task's type

Copy
"taskID" call BIS_fnc_taskType;

Get a task's visibility

Copy
"taskID" call BIS_fnc_taskAlwaysVisible;

Get a task's description

Copy
"taskID" call BIS_fnc_taskDescription;

Get a task's destination

Copy
"taskID" call BIS_fnc_taskDestination;

Get a unit's tasks

Copy
player call BIS_fnc_tasksUnit;


Advanced

ⓘ
All these details can be found in the Description.ext's Tasks chapter.

Define a task in mission config

You can define a task in Description.ext's CfgTaskDescriptions: 

class CfgTaskDescriptions
{
	class myTask1
	{
		title		= "myTaskTitle";
		description	= "myTaskDescription";
		marker		= "myTaskDestinationMarker";
	};
	class myTask2
	{
		title		= $STR_myTask2Title;
		description	= $STR_myTask2Description;
		marker		= $STR_myTask2Marker;
	};
};


Define a new task type

class CfgTaskTypes
{
	class Attack
	{
		icon	= "\A3\UI_F_MP_Mark\Data\Tasks\Types\Attack_ca.paa";
		icon3D	= "\A3\UI_F_MP_Mark\Data\Tasks\Types3D\Attack_ca.paa";
	};
	class Defend
	{
		icon	= "\A3\UI_F_MP_Mark\Data\Tasks\Types\Defend_ca.paa";
		icon3D	= "\A3\UI_F_MP_Mark\Data\Tasks\Types3D\Defend_ca.paa";
	};
};


Define task display behaviour

class CfgTaskEnhancements
{
	enable       = 1; // 0: disable new task features (default), 1: enable new task features & add new task markers and task widgets into the map
	3d           = 1; // 0: do not use new 3D markers (default), 1: replace task waypoints with new 3D markers
	3dDrawDist   = 0; // 3d marker draw distance (default: 2000)
	share        = 1; // 0: do not count assigned players (default), 1: count how many players have the task assigned
	propagate    = 1; // 0: do not propagate (default), 1: propagate shared tasks to subordinates
};


See also

Retrieved from "https://community.bistudio.com/wiki?title=Arma_3:_Task_Framework_Tutorial&oldid=329115"