BIS fnc setTask: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Changed my note as previously it was partially incorrect)
m (Text replacement - "{{Feature|Informative|" to "{{Feature|informative|")
 
(52 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| arma3 |= Game name
|game1= arma3
|version1= 1.00


|1.00|= Game version
|arg= global
____________________________________________________________________________________________
|eff= global|gr1= Tasks


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


| [params, target, desc, (dest, state, priority, showNotification, isGlobal, type, shared)] call '''BIS_fnc_setTask'''; |= Syntax
|s1= [taskId, target, description, (destination, state, priority, showNotification, isGlobal, type, visibleIn3D)] call [[BIS_fnc_setTask]]


|p1= '''params''': [[String]] or [[Array]] - Task ID or array in the format [task ID, parent task ID] |= Parameter 1
|p1= '''taskId''':
<br>[[String]] - Task ID
<br>[[Array]] - In the format of [task ID, parent task ID]
|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
Line 19: Line 20:
<br>[[Group]] - set tasks of all objects in the group
<br>[[Group]] - set tasks of all objects in the group
<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
|p3= '''desc''': [[Array]] or [[String]] - Task description in the format ["description", "title", "marker"] or CfgTaskDescriptions class |= Parameter 3
|p3= '''description''':
|p4= '''dest''' (Optional): Task destination
<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>[[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
|p5= '''state''' (Optional): Task state
|p5= '''state''' (Optional): Task state
<br>[[String]] - can be one of following:
<br>[[String]] - can be one of following:
Line 32: Line 35:
<br>"FAILED"
<br>"FAILED"
<br>"CANCELED"
<br>"CANCELED"
<br>[[Boolean]] - true to set the task as current |= Parameter 5
<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 |= Parameter 6
|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 |= Parameter 7
|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 |= Parameter 8
|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 |= Parameter 9
|p9= '''type''' (Optional): [[String]] - task type from CfgTaskTypes, if not defined, type "" is being used
|p10= '''shared''' (Optional): [[Boolean]] - false to disable shared objective counter (default), true to enable it |= Parameter 10
|p10= '''visibleIn3D''' (Optional): [[Boolean]] - true to make task always visible in 3D (default: false)


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


|x1= |= Example 1
|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>
____________________________________________________________________________________________
 
| [[BIS_fnc_taskCreate]], [[Arma_3_Task_Framework|Task Framework]] [[Arma_3_Task_Enhancements|Task Enhancements]] |= 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}}]]
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on September 13, 2017 - 19:35 (UTC)</dd>
<dt class="note">[[User:Dixon13|Dixon13]]</dt>
<dd class="note"> I'm not sure what the shared parameter is but after viewing the function in the function viewer, as of 1.76, the parameter now controls whether or not to make the task always visible in 3D.<br><code>9: BOOL - true to make task always visible in 3D (default: false)</code>
</dd>
</dl>
<!-- DISCONTINUE Notes -->

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"