BIS fnc setTask: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
(populated)
Line 1: Line 1:
{{Function|= Comments
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________
Line 8: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| Set a task parameters.
<br>Create the task when it doesn't exist. |= Description
Description:
Set a task parameters.
Create the task when it doesn't exist.
Parameters:
0: STRING or ARRAY - Task ID or array in the format [task ID, parent task ID]
1: Task owner(s)
BOOL - 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
2: ARRAY or STRING - Task description in the format ["description", "title", "marker"] or CfgTaskDescriptions class
3: Task destination
OBJECT
ARRAY - either position in format [x,y,z], or [object,precision] as used by setSimpleTaskTarget command
4: Task state
STRING - can be one of following:
"CREATED"
"ASSIGNED"
"AUTOASSIGNED" ("ASSIGNED" when no task is assigned yet, otherwise "CREATED")
"SUCCEEDED"
"FAILED"
"CANCELED"
BOOL - true to set the task as current
5: NUMBER - priority. When a current task is completed, system select a next one with the larges priority >= 0
6: BOOL - true to show notification (default), false to disable it
7: BOOL - true to set task globally (default), false to set it only locally
Returns:
STRING - Task ID
*/
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_setTask]]; --> |= Syntax
| [params, target, desc, dest, state, priority, showNotification, isGlobal] call '''BIS_fnc_setTask'''; |= Syntax


|p1= |= 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)
<br>[[Boolean]] - true to set task of all playable units
<br>[[Object]] - set task of a specific object
<br>[[Group]] - set tasks of all objects in the group
<br>[[Side]] - set tasks of all objects of the given side
<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
|p4= dest: Task destination
<br>[[Object]]
<br>[[Array]] - either position in format [x,y,z], or [object,precision] as used by setSimpleTaskTarget command |= Parameter 4
|p5= state: Task state
<br>[[String]] - can be one of following:
<br>"CREATED"
<br>"ASSIGNED"
<br>"AUTOASSIGNED" ("ASSIGNED" when no task is assigned yet, otherwise "CREATED")
<br>"SUCCEEDED"
<br>"FAILED"
<br>"CANCELED"
<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
|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


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


|x1= <code></code> |=  
|x1= |=  
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 67: Line 55:


<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Tasks|{{uc:setTask}}]]
 
[[Category:Functions|{{uc:setTask}}]]
[[Category:Arma 3:_Functions|setTask]]
[[Category:{{Name|arma3}}: Functions|{{uc:setTask}}]]

Revision as of 22:14, 3 May 2014

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

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

Notes

Bottom Section

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