BIS fnc setTask: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "{{Feature|Informative|" to "{{Feature|informative|")
 
(62 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|arg= global
|eff= global|gr1= Tasks


|1.00|= Game version
|descr= Set task parameters.
____________________________________________________________________________________________
<br>Create the task when it doesn't exist. {{Feature|informative| See [[Arma 3: Task Framework]] for more information.}}


| <pre>/*
|s1= [taskId, target, description, (destination, state, priority, showNotification, isGlobal, type, visibleIn3D)] call [[BIS_fnc_setTask]]
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
|p1= '''taskId''':
<br>[[String]] - Task ID
<br>[[Array]] -  In the format of [task ID, parent task ID]
|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
|p3= '''description''':
<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
|p4= '''destination''' (Optional): Task destination
<br>[[Object]]
<br>[[Array]] - either position in format [x,y,z], or [object,precision] as used by setSimpleTaskTarget command
|p5= '''state''' (Optional): 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
|p6= '''priority''' (Optional): [[Number]] - priority. When a current task is completed, system select a next one with the larges priority >{{=}} 0
|p7= '''showNotification''' (Optional): [[Boolean]] - true to show notification (default), false to disable it
|p8= '''isGlobal''' (Optional): [[Boolean]] - true to set task globally (default), false to set it only locally
|p9= '''type''' (Optional): [[String]] - task type from CfgTaskTypes, if not defined, type "" is being used
|p10= '''visibleIn3D''' (Optional): [[Boolean]] - true to make task always visible in 3D (default: false)


|p1= |= Parameter 1
|r1= [[String]] - task ID


| |= Return value
|x1= <sqf>["Task_01", true, ["Protect the respawn point.","Respawn Point West","respawn_west"], [MHQ,false], "ASSIGNED", 5, true, true, "Defend", true] call BIS_fnc_setTask;</sqf>
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso=  [[Arma 3: Task Framework]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Tasks|{{uc:setTask}}]]
[[Category:Functions|{{uc:setTask}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:setTask}}]]

Latest revision as of 01:25, 2 February 2024

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

Description

Description:
Set task parameters.
Create the task when it doesn't exist.
ⓘ
See Arma 3: Task Framework for more information.
Execution:
call
Groups:
Tasks

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

Example 1:
["Task_01", true, ["Protect the respawn point.","Respawn Point West","respawn_west"], [MHQ,false], "ASSIGNED", 5, true, true, "Defend", true] call BIS_fnc_setTask;

Additional Information

See also:
Arma 3: Task Framework

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_setTask&oldid=352179"