BIS fnc taskCreate: Difference between revisions
Jump to navigation
Jump to search
(Added info for task description / CfgTaskDescriptions, reformatted to match BIS_fnc_setTask page) |
m (template:command argument fix) |
||
| Line 7: | Line 7: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Create a task. |= | | Create a task. |DESCRIPTION= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [owner, taskID, description, destination, state, priority, showNotification, type, visibleIn3D] call [[BIS_fnc_taskCreate]] |= | | [owner, taskID, description, destination, state, priority, showNotification, type, visibleIn3D] call [[BIS_fnc_taskCreate]] |SYNTAX= | ||
|p1= '''owner''': Task owner(s) | |p1= '''owner''': Task owner(s) | ||
| Line 17: | Line 17: | ||
<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 |= | <br>[[Array]] - collection of above types |PARAMETER1= | ||
|p2= '''taskID''': | |p2= '''taskID''': | ||
<br>[[String]] - Task ID | <br>[[String]] - Task ID | ||
<br>[[Array]] - In the format of [task ID, parent task ID] |= | <br>[[Array]] - In the format of [task ID, parent task ID] |PARAMETER2= | ||
|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 |= | <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= | ||
|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 |= | <br>[[Array]] - Either position in format [x,y,z], or [object,precision] as used by setSimpleTaskTarget command |PARAMETER4= | ||
|p5= '''state''' (Optional): Task state | |p5= '''state''' (Optional): Task state | ||
<br>[[String]] - can be one of following: | <br>[[String]] - can be one of following: | ||
| Line 35: | Line 35: | ||
<br>"FAILED" | <br>"FAILED" | ||
<br>"CANCELED" | <br>"CANCELED" | ||
<br>[[Boolean]] - true to set the task as current |= | <br>[[Boolean]] - true to set the task as current |PARAMETER5= | ||
|p6= '''priority''' (Optional): [[Number]] - priority. When a current task is completed, system select a next one with the larges priority >{{=}} 0 |= | |p6= '''priority''' (Optional): [[Number]] - priority. When a current task is completed, system select a next one with the larges priority >{{=}} 0 |PARAMETER6= | ||
|p7= '''showNotification''' (Optional): [[Boolean]] - true to show notification (default), false to disable it |= | |p7= '''showNotification''' (Optional): [[Boolean]] - true to show notification (default), false to disable it |PARAMETER7= | ||
|p8= '''type''' (Optional): [[String]] - task type from CfgTaskTypes, if not defined, type "" is being used |= | |p8= '''type''' (Optional): [[String]] - task type from CfgTaskTypes, if not defined, type "" is being used |PARAMETER8= | ||
|p9= '''visibleIn3D''' (Optional): [[Boolean]] - true to make task always visible in 3D (default: false) |= | |p9= '''visibleIn3D''' (Optional): [[Boolean]] - true to make task always visible in 3D (default: false) |PARAMETER9= | ||
| [[Boolean]] |= | | [[Boolean]] |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 49: | Line 49: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[BIS_fnc_deleteTask]],[[BIS_fnc_setTask]],[[BIS_fnc_setTaskLocal]],[[BIS_fnc_sharedObjectives]],[[BIS_fnc_taskAlwaysVisible]],[[BIS_fnc_taskChildren]],[[BIS_fnc_taskCompleted]],[[BIS_fnc_taskCurrent]],[[BIS_fnc_taskDescription]],[[BIS_fnc_taskDestination]],[[BIS_fnc_taskExists]],[[BIS_fnc_taskHint]],[[BIS_fnc_taskParent]],[[BIS_fnc_taskReal]],[[BIS_fnc_taskSetAlwaysVisible]],[[BIS_fnc_taskSetCurrent]],[[BIS_fnc_taskSetDescription]],[[BIS_fnc_taskSetDestination]],[[BIS_fnc_taskSetState]],[[BIS_fnc_taskSetType]],[[BIS_fnc_taskState]],[[BIS_fnc_tasksUnit]],[[BIS_fnc_taskType]],[[BIS_fnc_taskTypeIcon]],[[BIS_fnc_taskVar]],[[Arma 3 Task Framework]],[[Arma 3 Tasks Overhaul]] |= | | [[BIS_fnc_deleteTask]],[[BIS_fnc_setTask]],[[BIS_fnc_setTaskLocal]],[[BIS_fnc_sharedObjectives]],[[BIS_fnc_taskAlwaysVisible]],[[BIS_fnc_taskChildren]],[[BIS_fnc_taskCompleted]],[[BIS_fnc_taskCurrent]],[[BIS_fnc_taskDescription]],[[BIS_fnc_taskDestination]],[[BIS_fnc_taskExists]],[[BIS_fnc_taskHint]],[[BIS_fnc_taskParent]],[[BIS_fnc_taskReal]],[[BIS_fnc_taskSetAlwaysVisible]],[[BIS_fnc_taskSetCurrent]],[[BIS_fnc_taskSetDescription]],[[BIS_fnc_taskSetDestination]],[[BIS_fnc_taskSetState]],[[BIS_fnc_taskSetType]],[[BIS_fnc_taskState]],[[BIS_fnc_tasksUnit]],[[BIS_fnc_taskType]],[[BIS_fnc_taskTypeIcon]],[[BIS_fnc_taskVar]],[[Arma 3 Task Framework]],[[Arma 3 Tasks Overhaul]] |SEEALSO= | ||
}} | }} | ||
Revision as of 14:33, 7 April 2019
Description
- Description:
- Create a task.
- Execution:
- call
- Groups:
- Uncategorised
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 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
- 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
Additional Information
- See also:
- BIS_fnc_deleteTaskBIS_fnc_setTaskBIS_fnc_setTaskLocalBIS_fnc_sharedObjectivesBIS_fnc_taskAlwaysVisibleBIS_fnc_taskChildrenBIS_fnc_taskCompletedBIS_fnc_taskCurrentBIS_fnc_taskDescriptionBIS_fnc_taskDestinationBIS_fnc_taskExistsBIS_fnc_taskHintBIS_fnc_taskParentBIS_fnc_taskRealBIS_fnc_taskSetAlwaysVisibleBIS_fnc_taskSetCurrentBIS_fnc_taskSetDescriptionBIS_fnc_taskSetDestinationBIS_fnc_taskSetStateBIS_fnc_taskSetTypeBIS_fnc_taskStateBIS_fnc_tasksUnitBIS_fnc_taskTypeBIS_fnc_taskTypeIconBIS_fnc_taskVarArma 3 Task FrameworkArma 3 Tasks Overhaul
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
Notes
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 details parameter.