BIS fnc taskSetCurrent: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "{{Feature|Informative|" to "{{Feature|informative|")
 
(31 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 to current. Identical to assigning a task. {{Feature|informative| See [[Arma 3: Task Framework]].}}
Description:
Set a task to current.
Parameters:
0: STRING - Task name
Returns:
BOOL
*/


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


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


|p1= |= Parameter 1
|p2= showNotification: [[Boolean]] - (Optional, default true) true to show notification, false to disable it


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


|x1= <code></code> |=
|x1= <sqf>"BIS_task_01" call BIS_fnc_taskSetCurrent;</sqf>
____________________________________________________________________________________________


| |= See also
|x2= <sqf>["BIS_task_01", false] call BIS_fnc_taskSetCurrent; //Assign without notificiation</sqf>


|seealso= [[Arma 3: Task Framework]]
}}
}}
<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:taskSetCurrent}}]]
[[Category:Functions|{{uc:taskSetCurrent}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:taskSetCurrent}}]]

Latest revision as of 00:24, 2 February 2024

Hover & click on the images for description

Description

Description:
Set a task to current. Identical to assigning a task.
Execution:
call
Groups:
Tasks

Syntax

Syntax:
taskName call BIS_fnc_taskSetCurrent
Parameters:
taskName: String
showNotification: Boolean - (Optional, default true) true to show notification, false to disable it
Return Value:
Boolean

Examples

Example 1:
"BIS_task_01" call BIS_fnc_taskSetCurrent;
Example 2:
["BIS_task_01", false] call BIS_fnc_taskSetCurrent; //Assign without notificiation

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