BIS fnc taskSetState: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (pf)
Line 1: Line 1:
{{Function|Comments=
____________________________________________________________________________________________


{{Function|= Comments
| arma3 |Game name=
 
|1.00|Game version=
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma3 |= Game name
| Set a task's state. |Description=
 
|1.00|= Game version
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| [taskName, taskState, showHint] call [[BIS_fnc_taskSetState]] |Syntax=
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
|p1= taskName: [[String]] |Parameter 1=
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_taskSetState]]; --> |= Syntax
|p2= taskState: [[String]] - Can be:
*"CREATED"
*"ASSIGNED"
*"SUCCEEDED"
*"FAILED"
*"CANCELED" |Parameter 2=


|p1= |= Parameter 1
|p3= showHint: [[Boolean]] - (Optional, default [[true]]) [[True]] to show a hint |Parameter 3=


| |= Return value
| [[Boolean]] |Return value=
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code>_task = ["task1", "ASSIGNED",true] spawn BIS_fnc_taskSetState;</code> |=  
|x1= ["BIS_task_01","CANCELED"] [[call]] [[BIS_fnc_taskSetState]];|Example 1=
 
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
| [[:Category:Function Group: Tasks|Task Functions]], [[Arma 3 Tasks Overhaul]] |See also=
}}


}}


<h3 style="display:none">Notes</h3>
<h3 style="display:none">Notes</h3>
Line 50: Line 45:
[[Category:Functions|{{uc:taskSetState}}]]
[[Category:Functions|{{uc:taskSetState}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:taskSetState}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:taskSetState}}]]
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on January 9, 2016 - 01:02 (UTC)</dd>
<dt class="note">[[User:DaVidoSS|DaVidoSS]]</dt>
<dd class="note">
Available states are: "CREATED",  "ASSIGNED",  "SUCCEEDED", "FAILED" or "CANCELED"
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Revision as of 00:20, 20 June 2018

Arma 3 logo black.png1.00
Hover & click on the images for description

Description

Description:
Set a task's state.
Execution:
call
Groups:
Uncategorised

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 FunctionsArma 3 Tasks Overhaul

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


Notes

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_taskSetState&oldid=108533"