BIS fnc setTask: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (template:command argument fix)
Line 8: Line 8:


| Set task parameters.
| Set task parameters.
<br>Create the task when it doesn't exist. |= Description
<br>Create the task when it doesn't exist. |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=


|p1= '''taskId''':
|p1= '''taskId''':
<br>[[String]] - Task ID
<br>[[String]] - Task ID
<br>[[Array]] -  In the format of [task ID, parent task ID] |= Parameter 1
<br>[[Array]] -  In the format of [task ID, parent task ID] |PARAMETER1=
|p2= '''target''': Task owner(s)
|p2= '''target''': Task owner(s)
<br>[[Boolean]] - true to set task of all playable units
<br>[[Boolean]] - true to set task of all playable units
Line 21: Line 21:
<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 |= Parameter 2
<br>[[Array]] - collection of above types |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 |= Parameter 3
<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]]
<br>[[Object]]
<br>[[Array]] - either position in format [x,y,z], or [object,precision] as used by setSimpleTaskTarget command |= Parameter 4
<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 36: Line 36:
<br>"FAILED"
<br>"FAILED"
<br>"CANCELED"
<br>"CANCELED"
<br>[[Boolean]] - true to set the task as current |= Parameter 5
<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 |= Parameter 6
|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 |= Parameter 7
|p7= '''showNotification''' (Optional): [[Boolean]] - true to show notification (default), false to disable it |PARAMETER7=
|p8= '''isGlobal''' (Optional): [[Boolean]] - true to set task globally (default), false to set it only locally |= Parameter 8
|p8= '''isGlobal''' (Optional): [[Boolean]] - true to set task globally (default), false to set it only locally |PARAMETER8=
|p9= '''type''' (Optional): [[String]] - task type from CfgTaskTypes, if not defined, type "" is being used |= Parameter 9
|p9= '''type''' (Optional): [[String]] - task type from CfgTaskTypes, if not defined, type "" is being used |PARAMETER9=
|p10= '''visibleIn3D''' (Optional): [[Boolean]] - true to make task always visible in 3D (default: false) |= Parameter 10
|p10= '''visibleIn3D''' (Optional): [[Boolean]] - true to make task always visible in 3D (default: false) |PARAMETER1=0


| [[String]] - Task ID |= Return value
| [[String]] - Task ID |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1=  |= Example 1
|x1=  |EXAMPLE1=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[BIS fnc deleteTask]],[[BIS fnc setTaskLocal]],[[BIS fnc sharedObjectives]],[[BIS fnc taskAlwaysVisible]],[[BIS fnc taskChildren]],[[BIS fnc taskCompleted]],[[BIS fnc taskCreate]],[[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]]|= See also
| [[BIS fnc deleteTask]],[[BIS fnc setTaskLocal]],[[BIS fnc sharedObjectives]],[[BIS fnc taskAlwaysVisible]],[[BIS fnc taskChildren]],[[BIS fnc taskCompleted]],[[BIS fnc taskCreate]],[[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 15:33, 7 April 2019

Arma 3 logo black.png1.00
Hover & click on the images for description

Description

Description:
Set task parameters.
Create the task when it doesn't exist.
Execution:
call
Groups:
Uncategorised

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

Examples:
Example needed

Additional Information

See also:
BIS fnc deleteTaskBIS fnc setTaskLocalBIS fnc sharedObjectivesBIS fnc taskAlwaysVisibleBIS fnc taskChildrenBIS fnc taskCompletedBIS fnc taskCreateBIS 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

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