Difference between revisions of "hint"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (VBS2 scripting category removal)
m (Text replace - "</dt>" to "")
Line 38: Line 38:
 
<dl class="command_description">
 
<dl class="command_description">
 
<!-- Note Section BEGIN -->
 
<!-- Note Section BEGIN -->
<dt class="note">'''[[User:ArmAtec|ArmAtec]]'''</dt><dd class="note">
+
<dt class="note">'''[[User:ArmAtec|ArmAtec]]'''<dd class="note">
 
Hint can be used with formatting like this:
 
Hint can be used with formatting like this:
 
<pre>hint format["Hello %1",player]</pre></dd>
 
<pre>hint format["Hello %1",player]</pre></dd>
<dt class="note">'''[[User:pyro05x|pyro05x]]'''</dt>
+
<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.
 
<dd class="note">To remove the hint box from the screen, pass a null string (<tt>""</tt>) to the command.
 
<pre>hint ""</pre></dd>
 
<pre>hint ""</pre></dd>
<dt class="note">'''[[User:Worldeater|Worldeater]]'''</dt>
+
<dt class="note">'''[[User:Worldeater|Worldeater]]'''
 
<dd class="note">''hint'' happily accepts [[Structured_Text|structured text]]:
 
<dd class="note">''hint'' happily accepts [[Structured_Text|structured text]]:
 
<pre>_starL  = "<img image='\ca\ui\data\debr_star.paa' align='left'/>";
 
<pre>_starL  = "<img image='\ca\ui\data\debr_star.paa' align='left'/>";

Revision as of 13:29, 21 October 2011

Introduced with Operation Flashpoint version 1.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 on the left upper corner of the screen (in OFP with a ding sound). The text may contain several lines.

Syntax

Syntax:
hint text
Parameters:
text: String - the message to write on the screen may consist of any characters. \n indicates a line break.
Return Value:
Nothing

Examples

Example 1:
hint "Press W to move forward. \nPress S to move backwards."

outputs the following message:

Press W to move forward.
Press S to move backwards.
Known Problems: Avoid hint messages that exceed the screen, as this may lead to crashes.

Additional Information

Multiplayer:
-
See also:
hintChintCadethintC arrayhintC structuredTexthintC texthintSilent

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

ArmAtec
Hint can be used with formatting like this:
hint format["Hello %1",player]
pyro05x
To remove the hint box from the screen, pass a null string ("") to the command.
hint ""
Worldeater
hint happily accepts structured text:
_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);
(Tested with 1.14, 1.15 beta and 1.16 beta)

Bottom Section