BIS fnc taskHint: Difference between revisions

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


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


| arma3 |= Game name
| Shows a task hint. |Description=
 
|1.00|= Game version
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| [taskName, taskState] call [[BIS_fnc_taskHint]] |Syntax=
Description:
Display a task hint.
Parameters:
_this select 0: STRING - Task name
_this select 1: STRING - Task state
Returns:
True if successful, false if not.
*/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|p1= taskName: [[String]] |Parameter 1=
____________________________________________________________________________________________


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


|p1= |= Parameter 1


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


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


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


Revision as of 10:18, 20 June 2018

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

Description

Description:
Shows a task hint.
Execution:
call
Groups:
Uncategorised

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 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_taskHint&oldid=108557"