BIS fnc taskHint: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl> " to "")
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|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.00|Game version=
|1.00


|gr1= Tasks |GROUP1=
|gr1= Tasks


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


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


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


|p2= taskState: [[String]] -  Can be:
|p2= taskState: [[String]] -  Can be:
Line 18: Line 18:
*"SUCCEEDED"
*"SUCCEEDED"
*"FAILED"
*"FAILED"
*"CANCELED" |Parameter 2=
*"CANCELED"




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


|x1= <code>["BIS_task_01","CANCELED"] [[call]] [[BIS_fnc_taskHint]];</code>|Example 1=
|x1= <code>["BIS_task_01","CANCELED"] [[call]] [[BIS_fnc_taskHint]];</code>




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



Revision as of 23:45, 17 January 2021

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:
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

Bottom Section