BIS fnc taskSetState: Difference between revisions

Latest revision as of 12:37, 22 May 2024

Hover & click on the images for description

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

Syntax:

[taskName, taskState, showHint] call BIS_fnc_taskSetState

Parameters:

taskName: String

taskState: String - can be:

showHint: Boolean - (Optional, default true) true to show a hint

Return Value:

Boolean

: 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".

@@ Line 1: / Line 1: @@
 {{RV|type=function
-| arma3
+|game1= arma3
+|version1= 1.00
-|1.00
+|gr1= Tasks
-|gr1= Tasks
+|arg= global
+|eff= global
-|arg= global|eff= global| 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.}}
-| [taskName, taskState, showHint] call [[BIS_fnc_taskSetState]]
+|s1= [taskName, taskState, showHint] call [[BIS_fnc_taskSetState]]
 |p1= taskName: [[String]]
-|p2= taskState: [[String]] -  Can be:
+|p2= taskState: [[String]] - can be:
 *"CREATED"
 *"ASSIGNED"
@@ Line 24: / Line 26: @@
 |r1= [[Boolean]]
-|x1= <code>["BIS_task_01","CANCELED"] [[call]] [[BIS_fnc_taskSetState]];</code>
+|x1= <sqf>["BIS_task_01","CANCELED"] call BIS_fnc_taskSetState;</sqf>
-|seealso= [[:Category:Function Group: Tasks|Task Functions]] [[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".
+}}
-[[Category:{{Name|arma3}}: Functions|{{uc:taskSetState}}]]