taskHint: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Game version" to "|Game version=")
m (Fix username)
 
(42 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma2 |= Game name
|game1= arma2
|version1= 1.00


|1.00|Game version=
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


| 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>
|game3= tkoh
|version3= 1.00


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


|p1= [hintText, [r, g, b, a], icon]: [[Array]] |PARAMETER1=  
|gr1= Briefing


|p2= hintText: [[String]] |PARAMETER2=  
|eff= local


|p3= [r, g, b, a]: [[Array]] - format [[Color]] |PARAMETER3=
|descr= Shows info about new, changed or failed task. The text can contain several lines. {{hl|\n}} 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.}}


|p4= icon: [[String]] - possible values: taskNew, taskDone, taskFailed, taskCurrent |PARAMETER4=
|s1= [[taskHint]] [text, colour, icon]


| [[Nothing]] |RETURNVALUE=
|p1= text: [[String]]


|p2= colour: [[Array]] format [[Color|Color (RGBA)]]


|x1= <code>taskhint ["Task failed!\nBad job!", [1, 0, 0, 1], "taskFailed"]</code>|EXAMPLE1=
|p3= icon: [[String]] - one of:
{{Columns|2|
* "taskNew"
* "taskCurrent"
* "taskDone"
* "taskFailed"
}}


____________________________________________________________________________________________
|r1= [[Nothing]]


| [[BIS_fnc_showNotification]] |SEEALSO=
|x1= <sqf>taskHint ["Task failed.\nBad job!", [1, 0, 0, 1], "taskFailed"];</sqf>


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


<h3 style='display:none'>Notes</h3>
{{Note
<dl class='command_description'>
|user= Kylania
<!-- Note Section BEGIN -->
|timestamp= 20110715033700
 
|text= Here are the BIS colors:
<dt class="note">Unknown
<sqf>
<dd class="note">Here are the BIS colors:
taskHint ["New Task!\nHere's your new task!", [1, 1, 1, 1], "taskNew"];
<code>
taskHint ["Task Assigned!\nDo this now!", [1, 1, 1, 1], "taskCurrent"];
[[taskHint]] ["New Task!\nHere's your new task!", [1, 1, 1, 1], "taskNew"];
taskHint ["Task Succeeded!\nGood job!", [0.60,0.839215,0.466666,1], "taskDone"];
[[taskHint]] ["Task Assigned!\nDo this now!", [1, 1, 1, 1], "taskCurrent"];
taskHint ["Task Failed!\nBad job!", [0.972549,0.121568,0,1], "taskFailed"];
[[taskHint]] ["Task Succeeded!\nGood job!", [0.600000,0.839215,0.466666,1], "taskDone"];
taskHint ["Task Canceled!\nNever mind!", [0.75,0.75,0.75,1], "taskFailed"];
[[taskHint]] ["Task Failed!\nBad job!", [0.972549,0.121568,0,1], "taskFailed"];
</sqf>
[[taskHint]] ["Task Canceled!\nNever mind!", [0.75,0.75,0.75,1], "taskFailed"];
}}
</code>
 
<!-- Note Section END -->
</dl>
 
<h3 style='display:none'>Bottom Section</h3>
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Briefing|{{uc:{{PAGENAME}}}}]]

Latest revision as of 00:11, 30 April 2024

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
LELocal
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:
Briefing

Syntax

Syntax:
taskHint [text, colour, icon]
Parameters:
text: String
colour: Array format Color (RGBA)
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
Kylania - c
Posted on Jul 15, 2011 - 03:37 (UTC)
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.60,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"];
Retrieved from "https://community.bistudio.com/wiki?title=taskHint&oldid=363983"