createSimpleTask

From Bohemia Interactive Community
Revision as of 15:52, 8 November 2023 by Lou Montana (talk | contribs) (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *U([a-z ])" to "$1 - u$2")
Jump to navigation Jump to search
Hover & click on the images for description

Description

Description:
Creates a new Task and adds it to the Diary.
Arma 3
Using the Arma 3: Task Framework instead is recommended
When task is added as a child, it appears as subcategory to the parent task in the Tasks menu and can be parent to another child task. However this is cosmetic appearance as each task has own id and can be referenced directly via diary link.
Multiplayer:
The task effect is local, it will only exist on the client it was added.
Groups:
Briefing

Syntax

Syntax:
unit createSimpleTask [name, parentTask]
Parameters:
unit: Object - unit to add this new task
name: String
parentTask: Task - (Optional, taskNull) - The new task will be a sub task of the parent task
Return Value:
Task - the new task

Examples

Example 1:
_currentTask = player createSimpleTask ["NewTask"];
Example 2:
_childTask = player createSimpleTask ["ChildTask", _currentTask];

Additional Information

See also:
simpleTasks removeSimpleTask setSimpleTaskDescription setSimpleTaskDestination setTaskState setTaskResult taskState Tasks Briefing

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
Lou Montana
Posted on Jul 02, 2011 - 11:45 (UTC)
  • Creating child will position the new task just under the parent task.
  • Creating another "normal" (parent) task will create a new line above the others. Think of it if you want ordered objectives.
  • Succeeding parent task will automatically succeed childs, whatever their taskState was set to. (I.E. If a task is set as a child to another, it will be completed when its parent is complete.. no matter if the child task really was or not).
  • This command has to be executed again for it to be applied for JIP players - no server sync

Full step by step code from beginning to end:
Step 1: create a new simpleTask
MySimpleTask = player createSimpleTask [(localize "STR_aSimpleTask")];
You may create a task at any given point in time. You just need to be aware of the fact, that you've created the task for a single unit (the player). So if you make use of teamSwitch, respawn or similiar, you need to think about how to manage this, so all of these units will have up to date tasks assigned to them. Second, it is a good practice to use a stringtable, even if you do not plan (yet) to offer translations.
Step 2: task destination
MySimpleTask setSimpleTaskDestination _destination;
variable/pointer-to-your-task setSimpleTaskDestination some-position. That's it.
Step 3: task description
MySimpleTask setSimpleTaskDescription [ (localize "STR_aSimpleTaskLongText"), (localize "STR_aSimpleTask"), (localize "STR_aSimpleTaskWaypointLabel") ];
Again, no magic involved here. You take your task, the command setSimpleTaskDescription an pass an array with three strings in it. The first string is the long description text, the second is the name/title of the task and the last one will show up on-screen on the waypoint in cadet mode.
Step 4: set and update task states
MySimpleTask setTaskState "CREATED";
And that's it. Here a minimal working example:
MySimpleTask = player createSimpleTask ["simple task title"]; MySimpleTask setSimpleTaskDestination (position player); MySimpleTask setSimpleTaskDescription [ "simple task long description", "simple task title", "simple task waypoint label" ]; MySimpleTask setTaskState "CREATED";
And then later in the mission:
MySimpleTask setTaskState "SUCCEEDED";
If you want to keep the player in the loop about the status of tasks, you may always do this:
[objNull, objNull, MySimpleTask, "SUCCEEDED"] execVM "CA\Modules\MP\data\scriptCommands\taskHint.sqf";