BIS fnc setTask: Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
mNo edit summary |
||
| Line 11: | Line 11: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [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 | ||
| Line 21: | Line 21: | ||
<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''' (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 |= Parameter 4 | ||
|p5= '''state''': Task state | |p5= '''state''' (Optional): 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''': [[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 |= Parameter 6 | ||
|p7= '''showNotification''': [[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 |= Parameter 7 | ||
|p8= '''isGlobal''': [[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 |= Parameter 8 | ||
| [[String]] - Task ID |= Return value | | [[String]] - Task ID |= Return value | ||
| Line 55: | Line 55: | ||
<h3 style="display:none">Bottom Section</h3> | <h3 style="display:none">Bottom Section</h3> | ||
[[Category:Function Group: Tasks|{{uc:setTask}}]] | |||
[[Category: | [[Category:Functions|{{uc:setTask}}]] | ||
[[Category:{{Name|arma3}}: Functions|{{uc:setTask}}]] | |||
Revision as of 12:07, 28 July 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 (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
- 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