BIS fnc setTask: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
(Added params for new task marker system as seen in EndGame) |
||
| 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, type, shared)] 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 36: | Line 36: | ||
|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 |= Parameter 7 | ||
|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 |= Parameter 8 | ||
|p9= '''type''' (Optional): [[String]] - task type from CfgTaskTypes, if not defined, type "" is being used |= Parameter 9 | |||
|p10= '''shared''' (Optional): [[Boolean]] - false to disable shared objective counter (default), true to enable it |= Parameter 10 | |||
| [[String]] - Task ID |= Return value | | [[String]] - Task ID |= Return value | ||
Revision as of 10:52, 22 April 2015
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, type, shared)] 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
- type (Optional): String - task type from CfgTaskTypes, if not defined, type "" is being used
- shared (Optional): Boolean - false to disable shared objective counter (default), true to enable it
- 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