BIS fnc taskSetState: Difference between revisions

Revision as of 00:24, 2 February 2024

1.00

GAGlobal GEGlobal

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

@@ Line 1: / Line 1: @@
-{{Function|Comments=
+{{RV|type=function
-____________________________________________________________________________________________
-| arma3 |Game name=
+|game1= arma3
+|version1= 1.00
-|1.00|Game version=
+|gr1= Tasks
-____________________________________________________________________________________________
-| Set a task's state. |Description=
+|arg= global
-____________________________________________________________________________________________
+|eff= global
-| [taskName, taskState, showHint] call [[BIS_fnc_taskSetState]] |Syntax=
+|descr= Set a task's state. {{Feature|informative| See [[Arma 3: Task Framework]] for more information.}}
-|p1= taskName: [[String]] |Parameter 1=
+|s1= [taskName, taskState, showHint] call [[BIS_fnc_taskSetState]]
-|p2= taskState: [[String]] -  Can be:
+|p1= taskName: [[String]]
+|p2= taskState: [[String]] - can be:
 *"CREATED"
 *"ASSIGNED"
 *"SUCCEEDED"
 *"FAILED"
-*"CANCELED" |Parameter 2=
+*"CANCELED"
-|p3= showHint: [[Boolean]] - (Optional, default [[true]]) [[True]] to show a hint |Parameter 3=
+|p3= showHint: [[Boolean]] - (Optional, default [[true]]) [[true]] to show a hint
-| [[Boolean]] |Return value=
+|r1= [[Boolean]]
-____________________________________________________________________________________________
-|x1= ["BIS_task_01","CANCELED"] [[call]] [[BIS_fnc_taskSetState]];|Example 1=
+|x1= <sqf>["BIS_task_01","CANCELED"] call BIS_fnc_taskSetState;</sqf>
-____________________________________________________________________________________________
+|seealso=  [[Arma 3: Task Framework]]
-| [[:Category:Function Group: Tasks|Task Functions]], [[Arma 3 Tasks Overhaul]] |See also=
 }}
-<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:taskSetState}}]]
-[[Category:Functions|{{uc:taskSetState}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:taskSetState}}]]