BIS fnc taskSetState: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " |s1=[" to " |s1= [")
No edit summary
 
(3 intermediate revisions by one other user not shown)
Line 6: Line 6:
|gr1= Tasks
|gr1= Tasks


|arg= global|eff= global
|arg= global
|eff= global


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


|s1= [taskName, taskState, showHint] call [[BIS_fnc_taskSetState]]
|s1= [taskName, taskState, showHint] call [[BIS_fnc_taskSetState]]
Line 14: Line 15:
|p1= taskName: [[String]]
|p1= taskName: [[String]]


|p2= taskState: [[String]] - Can be:
|p2= taskState: [[String]] - can be:
*"CREATED"
*"CREATED"
*"ASSIGNED"
*"ASSIGNED"
Line 28: Line 29:


|seealso=  [[Arma 3: Task Framework]]
|seealso=  [[Arma 3: Task Framework]]
}}
{{Note
|user= Whiztler
|timestamp= 20240522113748
|text=  Mind the spelling of the TaskState parameter string "CANCELED". The parameter will not work with the TaskState correctly spelled "CANCELLED".
}}
}}

Latest revision as of 12:37, 22 May 2024

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:
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
Whiztler - c
Posted on May 22, 2024 - 11:37 (UTC)
Mind the spelling of the TaskState parameter string "CANCELED". The parameter will not work with the TaskState correctly spelled "CANCELLED".