BIS fnc setTask: Difference between revisions
Jump to navigation
Jump to search
(populated) |
(formatting) |
||
| Line 13: | Line 13: | ||
| [params, target, desc, dest, state, priority, showNotification, isGlobal] call '''BIS_fnc_setTask'''; |= Syntax | | [params, target, desc, dest, state, priority, showNotification, isGlobal] call '''BIS_fnc_setTask'''; |= Syntax | ||
|p1= params: [[String]] or [[Array]] - Task ID or array in the format [task ID, parent task ID] |= Parameter 1 | |p1= '''params''': [[String]] or [[Array]] - Task ID or array in the format [task ID, parent task ID] |= Parameter 1 | ||
|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 | ||
<br>[[Object]] - set task of a specific object | <br>[[Object]] - set task of a specific object | ||
| Line 20: | Line 20: | ||
<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 |= Parameter 2 | ||
|p3= desc: [[Array]] or [[String]] - Task description in the format ["description", "title", "marker"] or CfgTaskDescriptions class |= Parameter 3 | |p3= '''desc''': [[Array]] or [[String]] - Task description in the format ["description", "title", "marker"] or CfgTaskDescriptions class |= Parameter 3 | ||
|p4= dest: Task destination | |p4= '''dest''': 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 |= Parameter 4 | ||
|p5= state: Task state | |p5= '''state''': Task state | ||
<br>[[String]] - can be one of following: | <br>[[String]] - can be one of following: | ||
<br>"CREATED" | <br>"CREATED" | ||
| Line 33: | Line 33: | ||
<br>"CANCELED" | <br>"CANCELED" | ||
<br>[[Boolean]] - true to set the task as current |= Parameter 5 | <br>[[Boolean]] - true to set the task as current |= Parameter 5 | ||
|p6= priority: | |p6= '''priority''': [[Number]] - priority. When a current task is completed, system select a next one with the larges priority >{{=}} 0 |= Parameter 6 | ||
|p7= showNotification: [[Boolean]] - true to show notification (default), false to disable it |= Parameter 7 | |p7= '''showNotification''': [[Boolean]] - true to show notification (default), false to disable it |= Parameter 7 | ||
|p8= isGlobal: [[Boolean]] - true to set task globally (default), false to set it only locally |= Parameter 8 | |p8= '''isGlobal''': [[Boolean]] - true to set task globally (default), false to set it only locally |= Parameter 8 | ||
| [[String]] - Task ID |= Return value | | [[String]] - Task ID |= Return value | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= |= | |x1= |= Example 1 | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
Revision as of 14:36, 4 May 2014
Description
- Description:
- Set a task parameters.
Create the task when it doesn't exist. - Execution:
- call
- Groups:
- Uncategorised
Syntax
- Syntax:
- [params, target, desc, dest, state, priority, showNotification, isGlobal] call BIS_fnc_setTask;
- Parameters:
- params: String or Array - Task ID or array in the format [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 - desc: Array or String - Task description in the format ["description", "title", "marker"] or CfgTaskDescriptions class
- dest: Task destination
Object
Array - either position in format [x,y,z], or [object,precision] as used by setSimpleTaskTarget command - state: 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: Number - priority. When a current task is completed, system select a next one with the larges priority >= 0
- showNotification: Boolean - true to show notification (default), false to disable it
- isGlobal: Boolean - true to set task globally (default), false to set it only locally
- Return Value:
- String - Task ID
Examples
- Examples:
- Example needed
Additional Information
- See also:
- See also needed
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