hint: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "[] spawn" to "0 spawn")
 
(44 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| ofp |Game name=
|game1= ofp
|version1= 1.00


|1.00|Game version=
|game2= ofpe
|version2= 1.00


|eff= local |Effects in MP=
|game3= arma1
|version3= 1.00


|gr1= Interaction |GROUP1=
|game4= arma2
____________________________________________________________________________________________
|version4= 1.00


| 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]] or <tt>\n</tt> (in lower case).|DESCRIPTION=
|game5= arma2oa
____________________________________________________________________________________________
|version5= 1.50


| [[hint]] message |SYNTAX=
|game6= tkoh
|version6= 1.00


|p1= message: [[String]] or [[Structured Text]] - the message to display. |PARAMETER1=
|game7= arma3
|version7= 0.50


| [[Nothing]] |RETURNVALUE=
|eff= local
____________________________________________________________________________________________
 
 
|gr1= Interaction
|x1= <code>{{codecomment|// outputs the following:
 
|gr2= Structured Text
 
|gr3= Strings
 
|descr= Outputs a hint message to the right of the screen (left of the screen in {{ofp}}) with a sound (except in {{arma1}}).
To split message in multiple lines either use [[Structured Text]] or {{hl|\n}} (in lower case).
 
{{Feature|arma1|{{arma1}} hints are silent. For later titles, see [[hintSilent]].}}
 
|pr= {{GVI|ofp|1.00}} {{GVI|arma1|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.
 
|s1= [[hint]] message
 
|p1= message: [[String]] or [[Structured Text]] - the message to display.
 
|r1= [[Nothing]]
 
|x1= <sqf>
// outputs the following:
// Press W to move forward.
// Press W to move forward.
// Press S to move backwards.}}
// Press S to move backwards.
[[hint]] "Press W to move forward.\nPress S to move backwards."</code> |EXAMPLE1=
hint "Press W to move forward.\nPress S to move backwards."
 
</sqf>
|x2= <code>[[hint]] [[format]] ["Hello, %1!", [[name]] [[player]]];</code> |Example2=


|x3= <code>[[hint]] [[str]] [[count]] [[allPlayers]];
|x2= <sqf>hint format ["Hello, %1!", name player];</sqf>
[[sleep]] 10;
[[hintSilent]] ""; {{codecomment|// hides the previous hint display}}</code> |Example3=


|x4= <code>[[hint]] [[parseText]] "<t size='2.0'>Large text</t>";{{codecomment|// Displays text twice as large as the default one}}</code>|Example4=
|x3= <sqf>
____________________________________________________________________________________________
hint str count allPlayers;
sleep 10;
hintSilent ""; // hides the previous hint display
</sqf>


|pr= {{GVI|ofp|1.00}} {{GVI|arma|1.00}} {{GVI|arma2|1.00}} Hint messages that exceed the screen may lead to crashes.<br>
|x4= <sqf>hint parseText "<t size='2.0'>Large text</t>"; // displays text twice as large as the default one</sqf>
{{GVI|arma3|1.00}} The game would not crash but suffer FPS drop / temporary freezing. |Problem=


| [[hintC]], [[hintCadet]], [[hintSilent]], [[diag_log]] |SEEALSO=
|seealso= [[hintC]] [[hintCadet]] [[hintSilent]] [[diag_log]]
}}
}}


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= DreadedEntity
 
|timestamp= 20141020192700
<dd class="notedate">Posted on October 20, 2014 - 19:27 (UTC)</dd>
|text= 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 <sqf inline>hint str _i;</sqf>:
<dt class="note">[[User:DreadedEntity|DreadedEntity]]</dt>
<sqf>
<dd class="note">
for "_i" from 0 to 50 do
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]] {
hint _i;
[[hint]] _i;
};
};</code>
</sqf>
'''tested in A3 1.32.127785'''<br>
'''tested in A3 1.32.127785'''<br>
<br>
<br>
In a script, an "undefined variable" error will be shown as expected.
In a script, an "undefined variable" error will be shown as expected.
</dd>
}}


<dd class="notedate">Posted on October 21, 2014 - 23:07 (UTC)</dd>
{{Note
<dt class="note">[[User:DreadedEntity|DreadedEntity]]</dt>
|user= DreadedEntity
<dd class="note">
|timestamp= 20141021230700
Contrary to previous games, Arma 3 will happily display hints that far exceed screen space.<br>
|text= Contrary to previous games, Arma 3 will happily display hints that far exceed screen space.<br>
However, as hints get longer, FPS suffers tremendously.<br>
However, as hints get longer, FPS suffers tremendously.<br>
'''tested in Debug Console, A3 1.32.127785 with the following:'''
'''tested in Debug Console, A3 1.32.127785 with the following:'''
<code>[[hint]] [[str]] (([[nearestObjects]] [<nowiki/>[[player]], ["BUILDING"],  100]) - [<nowiki/>[[player]]]); [] [[spawn]] { [[sleep]] 5; [[systemChat]] [[str]] [[diag_fps]]; };
<sqf>
[[sleep]] 10;
hint str ((nearestObjects [player, ["BUILDING"],  100]) - [player]); 0 spawn { sleep 5; systemChat str diag_fps; };
[[hint]] [[str]] (([[nearestObjects]] [<nowiki/>[[player]], ["BUILDING"], 1000]) - [<nowiki/>[[player]]]); [] [[spawn]] { [[sleep]] 5; [[systemChat]] [[str]] [[diag_fps]]; };</code>
sleep 10;
hint str ((nearestObjects [player, ["BUILDING"], 1000]) - [player]); 0 spawn { sleep 5; systemChat str diag_fps; };
</sqf>
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>
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>
<br>
<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'''
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 class="notedate">Posted on February 17, 2015 - 23:14 (UTC)</dd>
{{Note
<dt class="note">[[User:DreadedEntity|DreadedEntity]]</dt>
|user= DreadedEntity
<dd class="note">
|timestamp= 20150217231400
An open dialog will pause the 30-second hint fade timer.
|text= An open dialog will pause the 30-second hint fade timer.
'''(A3 1.38.128937)'''
'''(A3 1.38.128937)'''
</dd>
}}


<dd class="notedate">Posted on March 25, 2017 - 20:47 (UTC)</dd>
{{Note
<dt class="note">[[User:Feint|Feint]]</dt>
|user= Feint
<dd class="note">
|timestamp= 20170325204700
The [[hint]] sound is audible only when you have the music volume turned up above 0 in the audio settings.
|text= 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>
Otherwise, it seems to act the same as [[hintSilent]].<br>
<br>
<br>
Line 86: Line 111:
<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>
}}
</dl>
 
<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 Armed Assault|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Interaction|{{uc:{{PAGENAME}}}}]]

Latest revision as of 21:24, 2 September 2024

Hover & click on the images for description

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). To split message in multiple lines either use Structured Text or \n (in lower case).
Armed Assault
Armed Assault hints are silent. For later titles, see hintSilent.
Problems:
Logo A0.png1.00 Logo A1 black.png1.00 Logo A2.png1.00 Hint messages that exceed the screen may lead to crashes.
Arma 3 logo black.png1.00 The game would not crash but suffer FPS drop / temporary freezing.
Groups:
InteractionStructured TextStrings

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
Example 4:
hint parseText "<t size='2.0'>Large text</t>"; // displays text twice as large as the default one

Additional Information

See also:
hintC hintCadet hintSilent diag_log

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
DreadedEntity - c
Posted on Oct 20, 2014 - 19:27 (UTC)
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.
DreadedEntity - c
Posted on Oct 21, 2014 - 23:07 (UTC)
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]); 0 spawn { sleep 5; systemChat str diag_fps; }; sleep 10; hint str ((nearestObjects [player, ["BUILDING"], 1000]) - [player]); 0 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
DreadedEntity - c
Posted on Feb 17, 2015 - 23:14 (UTC)
An open dialog will pause the 30-second hint fade timer. (A3 1.38.128937)
Feint - c
Posted on Mar 25, 2017 - 20:47 (UTC)
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.