taskHint: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "[[Category:Scripting_Commands_Take_On_Helicopters" to "[[Category:Scripting Commands Take On Helicopters")
m (Fix description and example)
Line 5: Line 5:


|1.00|Game version=
|1.00|Game version=
|eff= local |MP Effects=
____________________________________________________________________________________________
____________________________________________________________________________________________


| Shows info about new, changed or failed task. The text can contain several lines. \n is used to indicate the end of a line.<br><br>
| Shows info about new, changed or failed task. The text can contain several lines. <tt>\n</tt> is used to set a line return.
{{Feature arma3 | It is recommended to use [[BIS_fnc_showNotification]] in order to maintain {{arma3}}'s visual style.}} |DESCRIPTION=


{{Feature arma3|To maintain Arma 3 visual style, it's recommended to use [[BIS_fnc_showNotification]] instead.}}|DESCRIPTION=
| [[taskHint]] [text, colour, icon] |SYNTAX=
| '''taskHint''' [hintText, [r, g, b, a], icon] |SYNTAX=


|p1= [hintText, [r, g, b, a], icon]: [[Array]] |PARAMETER1=  
|p1= [text, colour, icon]: [[Array]] |PARAMETER1=


|p2= hintText: [[String]] |PARAMETER2=  
|p2= text: [[String]] |PARAMETER2=


|p3= [r, g, b, a]: [[Array]] - format [[Color]] |PARAMETER3=  
|p3= colour: [[Array]] - format [[Color]] |PARAMETER3=


|p4= icon: [[String]] - possible values: taskNew, taskDone, taskFailed, taskCurrent |PARAMETER4=  
|p4= icon: [[String]] - one of:
* "taskNew"
* "taskCurrent"
* "taskDone"
* "taskFailed" |PARAMETER4=


| [[Nothing]] |RETURNVALUE=
| [[Nothing]] |RETURNVALUE=
 
 
|x1= <code>taskhint ["Task failed!\nBad job!", [1, 0, 0, 1], "taskFailed"]</code>|EXAMPLE1=  


|x1= <code>[[taskHint]] ["Task failed.\nBad job!", [1, 0, 0, 1], "taskFailed"];</code>|EXAMPLE1=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[BIS_fnc_showNotification]] |SEEALSO=  
| [[BIS_fnc_showNotification]] [[Task]] |SEEALSO=
 
|  |MPBEHAVIOUR=
____________________________________________________________________________________________
}}
}}


Line 39: Line 40:
<dt class="note">Unknown
<dt class="note">Unknown
<dd class="note">Here are the BIS colors:
<dd class="note">Here are the BIS colors:
<code>
<code>[[taskHint]] ["New Task!\nHere's your new task!", [1, 1, 1, 1], "taskNew"];
[[taskHint]] ["New Task!\nHere's your new task!", [1, 1, 1, 1], "taskNew"];
[[taskHint]] ["Task Assigned!\nDo this now!", [1, 1, 1, 1], "taskCurrent"];
[[taskHint]] ["Task Assigned!\nDo this now!", [1, 1, 1, 1], "taskCurrent"];
[[taskHint]] ["Task Succeeded!\nGood job!", [0.600000,0.839215,0.466666,1], "taskDone"];
[[taskHint]] ["Task Succeeded!\nGood job!", [0.600000,0.839215,0.466666,1], "taskDone"];
Line 52: Line 52:
<h3 style='display:none'>Bottom Section</h3>
<h3 style='display:none'>Bottom Section</h3>


[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Command Group: Briefing|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Briefing|{{uc:{{PAGENAME}}}}]]

Revision as of 22:15, 6 May 2020

Hover & click on the images for description

Description

Description:
Shows info about new, changed or failed task. The text can contain several lines. \n is used to set a line return.
Arma 3
It is recommended to use BIS_fnc_showNotification in order to maintain Arma 3's visual style.
Groups:
Uncategorised

Syntax

Syntax:
taskHint [text, colour, icon]
Parameters:
[text, colour, icon]: Array
text: String
colour: Array - format Color
icon: String - one of:
  • "taskNew"
  • "taskCurrent"
  • "taskDone"
  • "taskFailed"
Return Value:
Nothing

Examples

Example 1:
taskHint ["Task failed.\nBad job!", [1, 0, 0, 1], "taskFailed"];

Additional Information

See also:
BIS_fnc_showNotification Task

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

Unknown
Here are the BIS colors: taskHint ["New Task!\nHere's your new task!", [1, 1, 1, 1], "taskNew"]; taskHint ["Task Assigned!\nDo this now!", [1, 1, 1, 1], "taskCurrent"]; taskHint ["Task Succeeded!\nGood job!", [0.600000,0.839215,0.466666,1], "taskDone"]; taskHint ["Task Failed!\nBad job!", [0.972549,0.121568,0,1], "taskFailed"]; taskHint ["Task Canceled!\nNever mind!", [0.75,0.75,0.75,1], "taskFailed"];

Bottom Section