BIS fnc taskSetState: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "[[Arma 3 Task Framework" to "[[Arma 3: Task Framework")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Function|Comments=
{{Function|Comments=
____________________________________________________________________________________________


| arma3 |Game name=
| arma3 |Game name=
Line 11: Line 10:


|eff= global|Multiplayer Effects=
|eff= global|Multiplayer Effects=
____________________________________________________________________________________________


| Set a task's state. {{Informative| See [[Arma 3: Task Framework]] for more information.}} |Description=
| Set a task's state. {{Informative| See [[Arma 3: Task Framework]] for more information.}} |Description=
____________________________________________________________________________________________


| [taskName, taskState, showHint] call [[BIS_fnc_taskSetState]] |Syntax=
| [taskName, taskState, showHint] call [[BIS_fnc_taskSetState]] |Syntax=
Line 30: Line 27:


| [[Boolean]] |Return value=
| [[Boolean]] |Return value=
____________________________________________________________________________________________


|x1= <code>["BIS_task_01","CANCELED"] [[call]] [[BIS_fnc_taskSetState]];</code>|Example 1=
|x1= <code>["BIS_task_01","CANCELED"] [[call]] [[BIS_fnc_taskSetState]];</code>|Example 1=


____________________________________________________________________________________________


| [[:Category:Function Group: Tasks|Task Functions]] [[Arma 3: Task Framework]]  |See also=
| [[:Category:Function Group: Tasks|Task Functions]] [[Arma 3: Task Framework]]  |See also=

Revision as of 23:44, 16 January 2021

Hover & click on the images for description

Description

Description:
Set a task's state.
See Arma 3: Task Framework for more information.
Execution:
call
Groups:
Tasks

Syntax

Syntax:
[taskName, taskState, showHint] call BIS_fnc_taskSetState
Parameters:
taskName: String
taskState: String - Can be:
  • "CREATED"
  • "ASSIGNED"
  • "SUCCEEDED"
  • "FAILED"
  • "CANCELED"
showHint: Boolean - (Optional, default true) true to show a hint
Return Value:
Boolean

Examples

Example 1:
["BIS_task_01","CANCELED"] call BIS_fnc_taskSetState;

Additional Information

See also:
Task Functions 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


Notes

Bottom Section