Difference between revisions of "hint"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
(Page cleanup)
Line 1: Line 1:
{{Command|= Comments
+
{{Command|Comments=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| ofp |= Game name
+
| ofp |Game name=
  
|1.00|= Game version
+
|1.00|Game version=
|eff= local |= Effects in MP
+
 
 +
|eff= local |Effects in MP=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| Outputs a multi-line hint message in the left upper corner of the screen (in the right upper corner in Arma). This version of hint is supposed to play a sound when hint is shown, but this varies between games and versions. Use [[hintSilent]] for soundless hint. To split message in multiple line either use [[Structured Text]] or <tt>"\n"</tt> character in lower case.
+
| Outputs a hint message to the right of the screen (left of the screen in {{ofp}}) with a sound (except in {{arma}}). Use [[hintSilent]] for soundless hint. To split message in multiple lines either use [[Structured Text]], [[endl]] or <tt>\n</tt> (in lower case). |DESCRIPTION=
 
 
The effect of this command is [[local]], i.e. the hint will only show on the computer command was executed.
 
 
 
|DESCRIPTION=
 
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| '''hint''' text |SYNTAX=
+
| [[hint]] message |SYNTAX=
  
|p1=  text: [[String]] or [[Structured Text]] - the message to write on the screen may consist of any characters. \n indicates a line break. |PARAMETER1=
+
|p1=  message: [[String]] or [[Structured Text]] - the message to display. |PARAMETER1=
  
 
| [[Nothing]] |RETURNVALUE=
 
| [[Nothing]] |RETURNVALUE=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
 
   
 
   
|x1= <pre>hint "Press W to move forward. \nPress S to move backwards."</pre>
+
|x1= <code>{{codecomment|// outputs the following:
 +
// Press W to move forward.
 +
// Press S to move backwards.}}
 +
[[hint]] "Press W to move forward.\nPress S to move backwards."</code> |EXAMPLE1=
  
outputs the following message:
+
|x2= <code>[[hint]] [[format]] ["Hello, %1!", [[name]] [[player]]];</code> |Example2=
  
<pre>Press W to move forward.
+
|x3= <code>[[hint]] [[str]] [[count]] [[allPlayers]];
Press S to move backwards.</pre>
+
[[sleep]] 10;
 +
[[hintSilent]] ""; {{codecomment|// hides the previous hint display}}</code> |Example3=
 +
____________________________________________________________________________________________
  
Known Problems: Avoid hint messages that exceed the screen, as this may lead to crashes. |EXAMPLE1=
+
|pr= {{GVI|ofp|1.00}} {{GVI|arma|1.00}} {{GVI|arma2|1.00}} Hint messages that exceed the screen may lead to crashes.<br>
____________________________________________________________________________________________
+
{{GVI|arma3|1.00}} The game would not crash but suffer FPS drop / temporary freezing. |Problem=
  
 
| [[hintC]], [[hintCadet]], [[hintSilent]], [[diag_log]] |SEEALSO=
 
| [[hintC]], [[hintCadet]], [[hintSilent]], [[diag_log]] |SEEALSO=
 
 
}}
 
}}
  
 
<h3 style="display:none">Notes</h3>
 
<h3 style="display:none">Notes</h3>
 
<dl class="command_description">
 
<dl class="command_description">
<!-- Note Section BEGIN -->
 
<dt class="note">'''[[User:ArmAtec|ArmAtec]]'''<dd class="note">
 
Hint can be used with formatting like this:
 
<code>[[hint]] [[format]] ["Hello %1",[[player]] ]</code>
 
<dt class="note">'''[[User:pyro05x|pyro05x]]'''
 
<dd class="note">To remove the hint box from the screen, pass a null string (<tt>""</tt>) to the command.
 
<code>[[hint]] ""</code>
 
<dt class="note">'''[[User:Worldeater|Worldeater]]'''
 
<dd class="note">''hint'' happily accepts [[Structured_Text|structured text]]:
 
<code>_starL  = "<img image='\ca\ui\data\debr_star.paa' align='left'/>";
 
_starL  = _starL + _starL + _starL;
 
_starR  = "<img image='\ca\ui\data\debr_star.paa' align='right'/>";
 
_starR  = _starR + _starR + _starR;
 
_title  = "<t color='#ff0000' size='1.2' shadow='1' shadowColor='#000000' align='center'>TITLE</t><br/><br/>";
 
_text  = "Bla bla bla bla bla...";
 
[[hint]] [[parseText]] (_starL + _starR + _title + _text);
 
</code>
 
(Tested with 1.14, 1.15 beta and 1.16 beta)
 
<!-- Note Section END -->
 
</dl>
 
  
<h3 style="display:none">Bottom Section</h3>
 
[[Category:Scripting Commands|HINT]]
 
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands OFP 1.96|HINT]]
 
[[Category:Scripting Commands OFP 1.46|HINT]]
 
[[Category:Scripting Commands ArmA|HINT]]
 
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 
[[Category:Command_Group:_Interaction|{{uc:{{PAGENAME}}}}]]
 
 
<!-- CONTINUE Notes -->
 
<dl class="command_description">
 
 
<dd class="notedate">Posted on October 20, 2014 - 19:27 (UTC)</dd>
 
<dd class="notedate">Posted on October 20, 2014 - 19:27 (UTC)</dd>
 
<dt class="note">[[User:DreadedEntity|DreadedEntity]]</dt>
 
<dt class="note">[[User:DreadedEntity|DreadedEntity]]</dt>
 
<dd class="note">
 
<dd class="note">
Be careful when using hints to visualize the effects of commands using the Debug Console. Hint can accept an undefined variable and neither the error nor the hint is shown, the command simply fails. Also notice how the hint command should be "hint str _o;"<br>
+
Be careful when using hints to visualize the effects of commands using the Debug Console. Hint can accept an undefined variable and neither the error nor the hint is shown, the command simply fails. Also notice how the hint command should be {{Inline code|[[hint]] [[str]] _i;}}:
<code>for "_i" from 0 to 50 do
+
<code>[[for]] "_i" [[from]] 0 [[to]] 50 [[do]] {
{
+
[[hint]] _i;
    hint _o;
 
 
};</code>
 
};</code>
'''tested in A3 1.32.127785'''<br><br>In a script, an "undefined variable" error will be shown as expected.
+
'''tested in A3 1.32.127785'''<br>
 +
<br>
 +
In a script, an "undefined variable" error will be shown as expected.
 
</dd>
 
</dd>
</dl>
 
<!-- DISCONTINUE Notes -->
 
  
<!-- CONTINUE Notes -->
 
<dl class="command_description">
 
 
<dd class="notedate">Posted on October 21, 2014 - 23:07 (UTC)</dd>
 
<dd class="notedate">Posted on October 21, 2014 - 23:07 (UTC)</dd>
 
<dt class="note">[[User:DreadedEntity|DreadedEntity]]</dt>
 
<dt class="note">[[User:DreadedEntity|DreadedEntity]]</dt>
 
<dd class="note">
 
<dd class="note">
Contrary to what's written under "Examples", Arma 3 will happily display hints that far exceed screen space.<br>However, as hints get longer, FPS suffers tremendously.<br>
+
Contrary to previous games, Arma 3 will happily display hints that far exceed screen space.<br>
'''(tested in Debug Console, A3 1.32.127785, using:'''<br>
+
However, as hints get longer, FPS suffers tremendously.<br>
<code>hint str (([[nearestObjects]] [player, ["BUILDING"], 100]) - [player]); [] spawn { sleep 5; systemChat str diag_fps;};
+
'''tested in Debug Console, A3 1.32.127785 with the following:'''
hint str (([[nearestObjects]] [player, ["BUILDING"], 1000]) - [player]); [] spawn { sleep 5; systemChat str diag_fps;};</code>
+
<code>[[hint]] [[str]] (([[nearestObjects]] <nowiki>[</nowiki>[[player]], ["BUILDING"], 100]) - <nowiki>[</nowiki>[[player]]]); [] [[spawn]] { [[sleep]] 5; [[systemChat]] [[str]] [[diag_fps]]; };
Results were: '''59.7015''' and '''5.17297''', respectively. Drawing a hint even longer than this, such as [[nearestObjects]] with a radius of 10,000 or 100,000 reduces your FPS so much Arma 3 '''appears''' to crash, though it doesn't.
+
[[sleep]] 10;
<br><br>
+
[[hint]] [[str]] (([[nearestObjects]] <nowiki>[</nowiki>[[player]], ["BUILDING"], 1000]) - <nowiki>[</nowiki>[[player]]]); [] [[spawn]] { [[sleep]] 5; [[systemChat]] [[str]] [[diag_fps]]; };</code>
Unrelated: Hints will stay on screen for 30 seconds, then fade away over the course of 5 seconds. Tested with: '''(A3 1.32.127785)'''<br>
+
Results were: '''59.7015''' and '''5.17297''', respectively. Drawing a hint even longer than this, such as [[nearestObjects]] with a radius of 10,000 or 100,000 reduces your FPS so much Arma 3 '''appears''' to crash, though it doesn't.<br>
<code>hint "a";[] spawn{_counter = 0;while {true} do{sleep 1;_counter = _counter + 1;systemChat str _counter;};};</code>
+
<br>
 +
Unrelated: Hints will stay on screen for 30 seconds, then fade away over the course of 5 seconds. '''Tested with: A3 1.32.127785'''
 
</dd>
 
</dd>
</dl>
 
<!-- DISCONTINUE Notes -->
 
  
<!-- CONTINUE Notes -->
 
<dl class="command_description">
 
 
<dd class="notedate">Posted on February 17, 2015 - 23:14 (UTC)</dd>
 
<dd class="notedate">Posted on February 17, 2015 - 23:14 (UTC)</dd>
 
<dt class="note">[[User:DreadedEntity|DreadedEntity]]</dt>
 
<dt class="note">[[User:DreadedEntity|DreadedEntity]]</dt>
Line 110: Line 72:
 
'''(A3 1.38.128937)'''
 
'''(A3 1.38.128937)'''
 
</dd>
 
</dd>
</dl>
 
<!-- DISCONTINUE Notes -->
 
  
<!-- CONTINUE Notes -->
 
<dl class="command_description">
 
 
<dd class="notedate">Posted on March 25, 2017 - 20:47 (UTC)</dd>
 
<dd class="notedate">Posted on March 25, 2017 - 20:47 (UTC)</dd>
 
<dt class="note">[[User:Feint|Feint]]</dt>
 
<dt class="note">[[User:Feint|Feint]]</dt>
 
<dd class="note">
 
<dd class="note">
 
+
The [[hint]] sound is audible only when you have the music volume turned up above 0 in the audio settings.
The [[hint]] sound is audible only when you have the music volume turned up above 0 in the audio settings. Otherwise, it seems to act the same as [[hintSilent]].<br><br>
+
Otherwise, it seems to act the same as [[hintSilent]].<br>
 +
<br>
 
This is important because if you are running a [[hint]] that fires at 30 fps or more, the [[hint]] will slow down machines that have the music volume turned up but won't slow down machines that have the music volume turned off.<br>
 
This is important because if you are running a [[hint]] that fires at 30 fps or more, the [[hint]] will slow down machines that have the music volume turned up but won't slow down machines that have the music volume turned off.<br>
 
<br>
 
<br>
 
Best practice is to use [[hint]] for an alert to the player and use [[hintSilent]] for a makeshift display of data to the player that is updated fairly often.
 
Best practice is to use [[hint]] for an alert to the player and use [[hintSilent]] for a makeshift display of data to the player that is updated fairly often.
 
 
 
</dd>
 
</dd>
 
</dl>
 
</dl>
<!-- DISCONTINUE Notes -->
+
 
 +
<h3 style="display:none">Bottom Section</h3>
 +
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands ArmA|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Command_Group:_Interaction|{{uc:{{PAGENAME}}}}]]

Revision as of 00:03, 31 July 2019

Introduced with Operation Flashpoint version1.00
  Effects of this scripting command are not broadcasted over the network and remain local to the client the command is executed on

Click on the images for descriptions

Introduced in

Game:
Operation Flashpoint
Version:
1.00

Description

Description:
Outputs a hint message to the right of the screen (left of the screen in Operation Flashpoint) with a sound (except in Armed Assault). Use hintSilent for soundless hint. To split message in multiple lines either use Structured Text, endl or \n (in lower case).

Syntax

Syntax:
hint message
Parameters:
message: String or Structured Text - the message to display.
Return Value:
Nothing

Examples

Example 1:
// outputs the following: // Press W to move forward. // Press S to move backwards. hint "Press W to move forward.\nPress S to move backwards."
Example 2:
hint format ["Hello, %1!", name player];
Example 3:
hint str count allPlayers; sleep 10; hintSilent ""; // hides the previous hint display

Additional Information

Multiplayer:
-
Problems:
Introduced with Operation Flashpoint version1.00
Introduced with Armed Assault version1.00
Introduced with Arma 2 version1.00
Hint messages that exceed the screen may lead to crashes.
Introduced with Arma 3 version1.00
The game would not crash but suffer FPS drop / temporary freezing.
See also:
hintChintCadethintSilentdiag_log

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Posted on October 20, 2014 - 19:27 (UTC)
DreadedEntity
Be careful when using hints to visualize the effects of commands using the Debug Console. Hint can accept an undefined variable and neither the error nor the hint is shown, the command simply fails. Also notice how the hint command should be hint str _i;: for "_i" from 0 to 50 do { hint _i; }; tested in A3 1.32.127785

In a script, an "undefined variable" error will be shown as expected.
Posted on October 21, 2014 - 23:07 (UTC)
DreadedEntity
Contrary to previous games, Arma 3 will happily display hints that far exceed screen space.
However, as hints get longer, FPS suffers tremendously.
tested in Debug Console, A3 1.32.127785 with the following: hint str ((nearestObjects [player, ["BUILDING"], 100]) - [player]); [] spawn { sleep 5; systemChat str diag_fps; }; sleep 10; hint str ((nearestObjects [player, ["BUILDING"], 1000]) - [player]); [] spawn { sleep 5; systemChat str diag_fps; }; Results were: 59.7015 and 5.17297, respectively. Drawing a hint even longer than this, such as nearestObjects with a radius of 10,000 or 100,000 reduces your FPS so much Arma 3 appears to crash, though it doesn't.

Unrelated: Hints will stay on screen for 30 seconds, then fade away over the course of 5 seconds. Tested with: A3 1.32.127785
Posted on February 17, 2015 - 23:14 (UTC)
DreadedEntity
An open dialog will pause the 30-second hint fade timer. (A3 1.38.128937)
Posted on March 25, 2017 - 20:47 (UTC)
Feint
The hint sound is audible only when you have the music volume turned up above 0 in the audio settings. Otherwise, it seems to act the same as hintSilent.

This is important because if you are running a hint that fires at 30 fps or more, the hint will slow down machines that have the music volume turned up but won't slow down machines that have the music volume turned off.

Best practice is to use hint for an alert to the player and use hintSilent for a makeshift display of data to the player that is updated fairly often.

Bottom Section