BIS fnc taskCurrent: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - "{{Feature|Informative|" to "{{Feature|informative|")
 
(41 intermediate revisions by 2 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


| Returns unit's current task. |DESCRIPTION=
|descr= Returns unit's current task. {{Feature|informative| See [[Arma 3: Task Framework]] for more information.}}
____________________________________________________________________________________________


| unit call '''BIS_fnc_taskCurrent''' |SYNTAX=
|s1= unit call [[BIS_fnc_taskCurrent]]


|p1= unit: [[Object]] - Unit to be checked |PARAMETER1=
|p1= unit: [[Object]] - unit to be checked


| [[String]] - Task ID|RETURNVALUE=
|r1= [[String]] - task ID
____________________________________________________________________________________________


|x1= <code>_currentTask = [[player]] [[call]] '''BIS_fnc_taskCurrent''';</code> |EXAMPLE1=
|x1= <sqf>private _currentTask = player call BIS_fnc_taskCurrent;</sqf>


____________________________________________________________________________________________
|seealso=  [[Arma 3: Task Framework]]
 
| [[BIS_fnc_setTask]], [[Arma_3_Task_Framework|Task Framework]], [[Arma_3_Tasks_Overhaul|Tasks Overhaul]] |SEEALSO=
}}
}}
<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:taskCurrent}}]]
[[Category:Functions|{{uc:taskCurrent}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:taskCurrent}}]]

Latest revision as of 01:26, 2 February 2024

Hover & click on the images for description

Description

Description:
Returns unit's current task.
See Arma 3: Task Framework for more information.
Execution:
call
Groups:
Tasks

Syntax

Syntax:
unit call BIS_fnc_taskCurrent
Parameters:
unit: Object - unit to be checked
Return Value:
String - task ID

Examples

Example 1:
private _currentTask = player call BIS_fnc_taskCurrent;

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