BIS fnc taskHint: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
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...)
m (Text replacement - "{{Feature|Informative|" to "{{Feature|informative|")
 
(19 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function
{{RV|type=function


| arma3
|game1= arma3
 
|version1= 1.00
|1.00


|gr1= Tasks
|gr1= Tasks


| Shows a task hint. {{Informative| See [[Arma 3: Task Framework]] for more information.}}
|descr= Shows a task hint. {{Feature|informative| See [[Arma 3: Task Framework]] for more information.}}


| [taskName, taskState] call [[BIS_fnc_taskHint]]
|s1= [taskName, taskState] call [[BIS_fnc_taskHint]]


|p1= taskName: [[String]]
|p1= taskName: [[String]]


|p2= taskState: [[String]] - Can be:
|p2= taskState: [[String]] - can be:
*"CREATED"
*"CREATED"
*"ASSIGNED"
*"ASSIGNED"
Line 20: Line 19:
*"CANCELED"
*"CANCELED"


|r1= [[Boolean]]


| [[Boolean]]
|x1= <sqf>["BIS_task_01","CANCELED"] call BIS_fnc_taskHint;</sqf>


|x1= <code>["BIS_task_01","CANCELED"] [[call]] [[BIS_fnc_taskHint]];</code>
|seealso= [[Arma 3: Task Framework]]
 
 
| [[:Category:Function Group: Tasks|Task Functions]] [[Arma 3: Task Framework]]
}}
}}
<h3 style="display:none">Bottom Section</h3>
[[Category:Functions|{{uc:taskHint}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:taskHint}}]]

Latest revision as of 00:24, 2 February 2024

Hover & click on the images for description

Description

Description:
Shows a task hint.
See Arma 3: Task Framework for more information.
Execution:
call
Groups:
Tasks

Syntax

Syntax:
[taskName, taskState] call BIS_fnc_taskHint
Parameters:
taskName: String
taskState: String - can be:
  • "CREATED"
  • "ASSIGNED"
  • "SUCCEEDED"
  • "FAILED"
  • "CANCELED"
Return Value:
Boolean

Examples

Example 1:
["BIS_task_01","CANCELED"] call BIS_fnc_taskHint;

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