BIS fnc taskSetState: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...) |
||
| Line 1: | Line 1: | ||
{{Function | {{Function | ||
| arma3 | | arma3 | ||
|1.00 | |1.00 | ||
|gr1= Tasks | |gr1= Tasks | ||
|arg= global|Multiplayer Arguments= | |arg= global|Multiplayer Arguments= | ||
| Line 11: | Line 11: | ||
|eff= global|Multiplayer Effects= | |eff= global|Multiplayer Effects= | ||
| Set a task's state. {{Informative| See [[Arma 3: Task Framework]] for more information.}} | | Set a task's state. {{Informative| See [[Arma 3: Task Framework]] for more information.}} | ||
| [taskName, taskState, showHint] call [[BIS_fnc_taskSetState]] | | [taskName, taskState, showHint] call [[BIS_fnc_taskSetState]] | ||
|p1= taskName: [[String]] | |p1= taskName: [[String]] | ||
|p2= taskState: [[String]] - Can be: | |p2= taskState: [[String]] - Can be: | ||
| Line 22: | Line 22: | ||
*"SUCCEEDED" | *"SUCCEEDED" | ||
*"FAILED" | *"FAILED" | ||
*"CANCELED" | *"CANCELED" | ||
|p3= showHint: [[Boolean]] - (Optional, default [[true]]) [[true]] to show a hint | |p3= showHint: [[Boolean]] - (Optional, default [[true]]) [[true]] to show a hint | ||
| [[Boolean]] | | [[Boolean]] | ||
|x1= <code>["BIS_task_01","CANCELED"] [[call]] [[BIS_fnc_taskSetState]];</code> | |x1= <code>["BIS_task_01","CANCELED"] [[call]] [[BIS_fnc_taskSetState]];</code> | ||
| [[:Category:Function Group: Tasks|Task Functions]] [[Arma 3: Task Framework]] | | [[:Category:Function Group: Tasks|Task Functions]] [[Arma 3: Task Framework]] | ||
}} | }} | ||
Revision as of 23:45, 17 January 2021
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:
["BIS_task_01","CANCELED"] call BIS_fnc_taskSetState;
Additional Information
- See also:
- Task Functions 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