BIS fnc taskCreate: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.00|Game version=
|1.00


|gr1= Tasks |GROUP1=
|gr1= Tasks


|arg= global|Multiplayer Arguments=
|arg= global|Multiplayer Arguments=
Line 11: Line 11:
|eff= global|Multiplayer Effects=
|eff= global|Multiplayer Effects=


|  Create a task. {{Informative| See [[Arma 3: Task Framework]] for more information.}} |DESCRIPTION=
|  Create a task. {{Informative| See [[Arma 3: Task Framework]] for more information.}}


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


|p1= '''owner''': Task owner(s)
|p1= '''owner''': Task owner(s)
Line 20: Line 20:
<br>[[Group]] - set tasks of all objects in the group
<br>[[Group]] - set tasks of all objects in the group
<br>[[Side]] - set tasks of all objects of the given side
<br>[[Side]] - set tasks of all objects of the given side
<br>[[Array]] - collection of above types |PARAMETER1=
<br>[[Array]] - collection of above types


|p2= '''taskID''':
|p2= '''taskID''':
<br>[[String]] - Task ID
<br>[[String]] - Task ID
<br>[[Array]] - In the format of [task ID, parent task ID] |PARAMETER2=
<br>[[Array]] - In the format of [task ID, parent task ID]


|p3= '''description''':
|p3= '''description''':
<br>[[Array]] - Task description in the format ["description", "title", "marker"]
<br>[[Array]] - Task description in the format ["description", "title", "marker"]
<br>[[String]] - [[Description.ext#CfgTaskDescriptions|CfgTaskDescriptions]] class name, if empty string is used then [[Description.ext#CfgTaskDescriptions|CfgTaskDescriptions]] is searched for a class matching the tasks TaskID |PARAMETER3=
<br>[[String]] - [[Description.ext#CfgTaskDescriptions|CfgTaskDescriptions]] class name, if empty string is used then [[Description.ext#CfgTaskDescriptions|CfgTaskDescriptions]] is searched for a class matching the tasks TaskID


|p4= '''destination''' (Optional): Task destination
|p4= '''destination''' (Optional): Task destination
<br>[[Object]] - Use [[objNull]] to set no position
<br>[[Object]] - Use [[objNull]] to set no position
<br>[[Array]] - Either position in format [x,y,z], or [object,precision] as used by setSimpleTaskTarget command |PARAMETER4=
<br>[[Array]] - Either position in format [x,y,z], or [object,precision] as used by setSimpleTaskTarget command


|p5= '''state''' (Optional): Task state
|p5= '''state''' (Optional): Task state
Line 42: Line 42:
<br>"FAILED"
<br>"FAILED"
<br>"CANCELED"
<br>"CANCELED"
<br>[[Boolean]] - true to set the task as current |PARAMETER5=
<br>[[Boolean]] - true to set the task as current


|p6= '''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.|PARAMETER6=
|p6= '''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.


|p7= '''showNotification''' (Optional): [[Boolean]] - true to show notification (default), false to disable it |PARAMETER7=
|p7= '''showNotification''' (Optional): [[Boolean]] - true to show notification (default), false to disable it


|p8= '''type''' (Optional): [[String]] - task type from CfgTaskTypes, if not defined, type "" is being used |PARAMETER8=
|p8= '''type''' (Optional): [[String]] - task type from CfgTaskTypes, if not defined, type "" is being used


|p9= '''visibleIn3D''' (Optional): [[Boolean]] - true to make task always visible in 3D (default: false) |PARAMETER9=
|p9= '''visibleIn3D''' (Optional): [[Boolean]] - true to make task always visible in 3D (default: false)


| [[Boolean]] |RETURNVALUE=
| [[Boolean]]


|x1= <code><nowiki>[</nowiki>[[civilian]], ["task1"], ["Do this and you get a cookie", "Earn Cookie", "cookiemarker"], [0,0,0] ,1, 2, [[true]]] [[call]] [[BIS_fnc_taskCreate]];</code> |Example1=
|x1= <code><nowiki>[</nowiki>[[civilian]], ["task1"], ["Do this and you get a cookie", "Earn Cookie", "cookiemarker"], [0,0,0] ,1, 2, [[true]]] [[call]] [[BIS_fnc_taskCreate]];</code>


|x2= <code><nowiki>[</nowiki>[[west]], ["task2"], ["Good luck finding this cookie", "Find Cookie", "cookiemarker2"], [[objNull]], 1, 3, [[true]]] [[call]] [[BIS_fnc_taskCreate]]; {{cc|Task without a map location}}</code> |Example2=
|x2= <code><nowiki>[</nowiki>[[west]], ["task2"], ["Good luck finding this cookie", "Find Cookie", "cookiemarker2"], [[objNull]], 1, 3, [[true]]] [[call]] [[BIS_fnc_taskCreate]]; {{cc|Task without a map location}}</code>


|x3= <code>
|x3= <code>
Line 71: Line 71:
//calling the function//
//calling the function//


<nowiki>[</nowiki>[[east]], ["taskType_"], ["Setting taskType", "The simple way", "marker2"], [[objNull]], 1, 3, [[true]], "my_CfgTaskType"] [[call]] [[BIS_fnc_taskCreate]]; {{cc|Task with a custom icon}}</code> |Example3=
<nowiki>[</nowiki>[[east]], ["taskType_"], ["Setting taskType", "The simple way", "marker2"], [[objNull]], 1, 3, [[true]], "my_CfgTaskType"] [[call]] [[BIS_fnc_taskCreate]]; {{cc|Task with a custom icon}}</code>


| [[:Category:Function Group: Tasks|Task Functions]] [[Arma 3: Task Framework]] |SEEALSO=
| [[:Category:Function Group: Tasks|Task Functions]] [[Arma 3: Task Framework]]
}}
}}


Revision as of 00:46, 18 January 2021

Arma 3 logo black.png1.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 (3rd) parameter.

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_taskCreate&oldid=203587"