BIS fnc taskSetState: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "Task Functions" to "") |
No edit summary |
||
| (5 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| | |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]] | ||
|p1= taskName: [[String]] | |p1= taskName: [[String]] | ||
|p2= taskState: [[String]] - | |p2= taskState: [[String]] - can be: | ||
*"CREATED" | *"CREATED" | ||
*"ASSIGNED" | *"ASSIGNED" | ||
| Line 25: | Line 26: | ||
|r1= [[Boolean]] | |r1= [[Boolean]] | ||
|x1= < | |x1= <sqf>["BIS_task_01","CANCELED"] call BIS_fnc_taskSetState;</sqf> | ||
|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
Description
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:
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
- 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".