Difference between revisions of "hint"

From Bohemia Interactive Community
Jump to navigation Jump to search
(added note)
(add a note and format command lines with <pre> tags)
Line 40: Line 40:
 
<dt class="note">'''[[User:ArmAtec|ArmAtec]]'''</dt><dd class="note">
 
<dt class="note">'''[[User:ArmAtec|ArmAtec]]'''</dt><dd class="note">
 
Hint can be used with formatting like this:
 
Hint can be used with formatting like this:
Hint format["Hello %1",player]</dd>
+
<pre>hint format["Hello %1",player]</pre></dd>
 +
<dt class="note">'''[[User:pyro05x|pyro05x]]'''</dt>
 +
<dd class="note">To remove the hint box from the screen, pass a null string (<tt>""</tt>) to the command.
 +
<pre>hint ""</pre></dd>
 
<!-- Note Section END -->
 
<!-- Note Section END -->
 
</dl>
 
</dl>

Revision as of 01:52, 13 February 2007

Introduced with Operation Flashpoint version 1.001.00Effects of this scripting command are not broadcasted over the network and remain local to the client the command is executed on
Hover & click on the images for descriptions

Description

Description:
Outputs a hint message on the left upper corner of the screen together with a clinging 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. \n\nUse the mouse to turn right or left."

outputs the following message:

Press W to move forward.
Press S to move backwards.

Use the mouse to turn right or left.
Known Problems Avoid hint messages that exceed the screen, as this may lead to crashes.

Additional Information

See also:
hintChintCadethintC arrayhintC structuredTexthintC text

Notes

i
Only post proven facts here. Report bugs on the feedback tracker. Use the Talk page or the Forums for discussions.

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 ""

Bottom Section