BIS fnc taskSetState: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category\:Function Group\: Tasks(\|\{\{[a-zA-Z0-9_:]+\}\})?\]\]" to "")
m (Text replacement - "True" to "true")
Line 27: Line 27:
*"CANCELED" |Parameter 2=
*"CANCELED" |Parameter 2=


|p3= showHint: [[Boolean]] - (Optional, default [[true]]) [[True]] to show a hint |Parameter 3=
|p3= showHint: [[Boolean]] - (Optional, default [[true]]) [[true]] to show a hint |Parameter 3=


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

Revision as of 19:31, 26 December 2020

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