BIS fnc taskSetState: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
No edit summary
 
(34 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= Tasks


|1.00|= Game version
|arg= global
____________________________________________________________________________________________
|eff= global


| <pre>/*
|descr= Set a task's state. {{Feature|informative| See [[Arma 3: Task Framework]] for more information.}}
Description:
Set a task's state.
Parameters:
0: STRING - Task name
1: STRING - Task state
2: BOOL - Show hint (default: true)
Returns:
BOOL
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|s1= [taskName, taskState, showHint] call [[BIS_fnc_taskSetState]]
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_taskSetState]]; --> |= Syntax
|p1= taskName: [[String]]


|p1= |= Parameter 1
|p2= taskState: [[String]] - can be:
*"CREATED"
*"ASSIGNED"
*"SUCCEEDED"
*"FAILED"
*"CANCELED"


| |= Return value
|p3= showHint: [[Boolean]] - (Optional, default [[true]]) [[true]] to show a hint
____________________________________________________________________________________________


|x1= <code>_task = ["task1", "ASSIGNED",true] spawn BIS_fnc_taskSetState;</code> |=
|r1= [[Boolean]]
____________________________________________________________________________________________


| |= See also
|x1= <sqf>["BIS_task_01","CANCELED"] call BIS_fnc_taskSetState;</sqf>


|seealso=  [[Arma 3: Task Framework]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= Whiztler
<!-- Note Section BEGIN -->
|timestamp= 20240522113748
|text= Mind the spelling of the TaskState parameter string "CANCELED". The parameter will not work with the TaskState correctly spelled "CANCELLED".


<!-- 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}}]]

Latest revision as of 12:37, 22 May 2024

Arma 3 logo black.png1.00
GAGlobalGEGlobal
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".
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_taskSetState&oldid=364616"