BIS fnc setTask: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "[[Arma 3 Task Framework" to "[[Arma 3: Task Framework") |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Function|Comments= | {{Function|Comments= | ||
| arma3 |Game name= | | arma3 |Game name= | ||
| Line 11: | Line 10: | ||
|gr1 = Tasks |GROUP1= | |gr1 = Tasks |GROUP1= | ||
| Set task parameters. | | Set task parameters. | ||
<br>Create the task when it doesn't exist. {{Informative| See [[Arma 3: Task Framework]] for more information.}} |DESCRIPTION= | <br>Create the task when it doesn't exist. {{Informative| See [[Arma 3: Task Framework]] for more information.}} |DESCRIPTION= | ||
| [taskId, target, description, (destination, state, priority, showNotification, isGlobal, type, visibleIn3D)] call '''BIS_fnc_setTask'''; |SYNTAX= | | [taskId, target, description, (destination, state, priority, showNotification, isGlobal, type, visibleIn3D)] call '''BIS_fnc_setTask'''; |SYNTAX= | ||
| Line 50: | Line 47: | ||
| [[String]] - Task ID |RETURNVALUE= | | [[String]] - Task ID |RETURNVALUE= | ||
|x1= <code>["Task_01", [[true]], ["Protect the respawn point.","Respawn Point West","respawn_west"], [MHQ,false], "ASSIGNED", 5, [[true]], [[true]], "Defend", [[true]]] [[call]] [[BIS_fnc_setTask]];</code> |EXAMPLE1= | |x1= <code>["Task_01", [[true]], ["Protect the respawn point.","Respawn Point West","respawn_west"], [MHQ,false], "ASSIGNED", 5, [[true]], [[true]], "Defend", [[true]]] [[call]] [[BIS_fnc_setTask]];</code> |EXAMPLE1= | ||
| [[:Category:Function Group: Tasks|Task Functions]] [[Arma 3: Task Framework]] |SEEALSO= | | [[:Category:Function Group: Tasks|Task Functions]] [[Arma 3: Task Framework]] |SEEALSO= | ||
Revision as of 23:55, 16 January 2021
Description
- Description:
- Set task parameters.
Create the task when it doesn't exist. - Execution:
- call
- Groups:
- Tasks
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:
["Task_01", true, ["Protect the respawn point.","Respawn Point West","respawn_west"], [MHQ,false], "ASSIGNED", 5, true, true, "Defend", true] call BIS_fnc_setTask;
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