Difference between revisions of "hint"

From Bohemia Interactive Community
Jump to navigation Jump to search
Line 1: Line 1:
[[Category:Scripting Commands|HINT]]
+
{{Command|= Comments
[[Category:Scripting Commands OFP 1.96|HINT]]
+
____________________________________________________________________________________________
[[Category:Scripting Commands OFP 1.46|HINT]]
+
 
[[Category:Scripting Commands ArmA|HINT]]
+
| ofp |= Game name
  
 +
|1.00|= Game version
  
<h2 style="color:#000066"> '''hint ''text'''''</h2>
+
|eff= local |= Effects in MP
 +
____________________________________________________________________________________________
  
 +
| Outputs a hint message on the left upper corner of the screen together with a clinging sound. The text may contain several lines. |= Description
 +
____________________________________________________________________________________________
  
'''Operand types:'''
+
| '''hint''' text |= Syntax
  
'''text:''' [[String]]
+
|p1= text: [[String]] - the message to write on the screen may consist of any characters. \n indicates a line break. |= Parameter 1
  
'''Type of returned value:'''
+
| [[Nothing]] |= Return value
 +
____________________________________________________________________________________________
 +
 
 +
|x1= <pre>hint "Press W to move forward. \nPress S to move backwards. \n\nUse the mouse to turn right or left."</pre>
  
[[Nothing]]
+
outputs the following message:
  
'''Description:'''
+
<pre>Press W to move forward.
 +
Press S to move backwards.
  
Show '''hint''' text.
+
Use the mouse to turn right or left.</pre>
  
Text can contain several lines.
+
Known Problems Avoid hint messages that exceed the screen, as this may lead to crashes. |= Example 1
 +
____________________________________________________________________________________________
  
An '''\n''' is used to indicate a new line.
+
| [[hintC]], [[hintCadet]] |= See also
  
 +
}}
  
'''Examples:'''
+
<h3 style="display:none">Notes</h3>
 +
<dl class="command_description">
 +
<!-- Note Section BEGIN -->
  
'''hint''' "Press W to move forward"
+
<!-- Note Section END -->
 +
</dl>
  
'''hint''' "Press W to move forward. '''\n'''Press S to move backwards. '''\n'''Use the mouse to turn right or left."
+
<h3 style="display:none">Bottom Section</h3>
 +
[[Category:Scripting Commands|HINT]]
 +
[[Category:Scripting Commands OFP 1.96|HINT]]
 +
[[Category:Scripting Commands OFP 1.46|HINT]]
 +
[[Category:Scripting Commands ArmA|HINT]]

Revision as of 01:29, 2 August 2006

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:
hintChintCadet

Notes

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

Notes

Bottom Section