Difference between revisions of "hintC"

From Bohemia Interactive Community
Jump to navigation Jump to search
 
m (Text replacement - "\{\{( *)Informative( *)\|" to "{{$1Feature$2|$2Informative$2|")
 
(65 intermediate revisions by 18 users not shown)
Line 1: Line 1:
back to [[Scripting_Reference#H|COMREF]]
+
{{RV|type=command
  
<h2 style="color:#000066"> '''hintC ''text'''''</h2>
+
|game1= ofp
  
 +
|version1= 1.00
  
'''Operand types:'''
+
|eff= local
'''
 
text:''' [[String]]
 
  
'''Type of returned value:'''
+
|gr1= Interaction
  
[[Nothing]]
+
|gr2= Structured Text
  
'''Description:'''
+
|gr3= Strings
  
Show hint text.
+
|descr= Displays attractive hint in the center of the screen. Player control is taken away until "Continue" is pressed.
  
Text can contain several lines.
+
{{Feature | Informative | In Singleplayer, the game is paused as well.}}
  
An '''\n''' is used to indicate a new line.
+
After user confirmation, the content of the [[hintC]] is repeated again in a normal [[hint]]. This type of hint can also have a title. It is also possible to drag this type of hint around the screen.
  
Hint must be confirmed.
+
|s1= [[hintC]] content
  
 +
|p1=  content: [[String]]
  
'''Example:'''
+
|r1= [[Nothing]]
  
'''hintC''' "Press V for weapon sights"
+
|s2= title [[hintC]] content
 +
 
 +
|p21= title: [[String]] - message title
 +
|p22= content: [[String]], [[Structured Text]], [[Array]] of [[String]]s or [[Array]] of [[Structured Text]]
 +
 
 +
|r2= [[Nothing]]
 +
 
 +
|x1 = <code>[[hintC]] "Press W to move forward";</code>
 +
 
 +
|x2 = Same as the above in {{arma3}} but without second [[hint]] displayed:<code>[[hintC]] "Press W to move forward";
 +
hintC_EH = [[findDisplay]] 57 [[displayAddEventHandler]] ["unload", {
 +
0 = _this [[spawn]] {
 +
_this [[select]] 0 [[displayRemoveEventHandler]] ["unload", hintC_EH];
 +
[[hintSilent]] "";
 +
};
 +
}];</code>
 +
 
 +
[[Image:HintC.jpg|400px]]
 +
 
 +
|x3= <code>"Instructions" [[hintC]] [
 +
"Press W to move forward.",
 +
"Press S to move backwards.",
 +
"Use the mouse to turn right or left.",
 +
"Press V for weapon sights."
 +
];</code>
 +
 
 +
|x4= Same as the above in {{arma3}} but without second [[hint]] displayed: <code>"Instructions" [[hintC]] [
 +
"Press W to move forward.",
 +
"Press S to move backwards.",
 +
"Use the mouse to turn right or left.",
 +
"Press V for weapon sights."
 +
];
 +
hintC_arr_EH = [[findDisplay]] 72 [[displayAddEventHandler]] ["unload", {
 +
0 = _this [[spawn]] {
 +
_this [[select]] 0 [[displayRemoveEventHandler]] ["unload", hintC_arr_EH];
 +
[[hintSilent]] "";
 +
};
 +
}];</code>
 +
 
 +
[[Image:HintC_array.jpg|400px]]
 +
 
 +
|x5= <code>[[private]] _separator1 = [[parseText]] "<nowiki><br />------------------------<br /></nowiki>";
 +
[[private]] _image = "\ca\ui\textures\aus_flag.paa";
 +
[[private]] _txt = [[composeText]] [<nowiki/>[[image]] _image, "Heading Text", _separator1, "Content"];
 +
"" [[hintC]] _txt;</code>
 +
 
 +
|seealso= [[hint]], [[hintCadet]], [[hintSilent]]
 +
}}
 +
 
 +
<dl class="command_description">
 +
<!-- Note Section BEGIN -->
 +
 
 +
<dd class="notedate">
 +
<dt class="note">[[User:Str|Str]]</dt>
 +
<dd class="note">This command must be executed after mission start. If you place it into init.sqs or init field of some unit, it will not work. Just add a little delay (~0.001) and the place the command.
 +
 
 +
<dd class="notedate">
 +
<dt class="note">[[User:Worldeater|Worldeater]]</dt>
 +
<dd class="note">To display multiple messages after another you have to add a small delay in between. Otherwise only the first message will be displayed.
 +
<code>[[hintC]] "foo"; [[sleep]] 0.1; [[hintC]] "bar"</code>
 +
Without a [[sleep]] statement [[hintC]] will not suspend the script it has been called from.
 +
 
 +
<dd class="notedate">
 +
<dt class="note">[[User:ArmAtec|ArmAtec]]</dt>
 +
<dd class="note">HintC can be used with formatting like this: <code>[[hintC]] [[format]] ["Hello %1", [[player]]]</code>
 +
 
 +
<dd class="notedate">Posted on March 19, 2015 - 09:52 (UTC)</dd>
 +
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
 +
<dd class="note">"Titled" [[hintC]] uses <tt>display #72</tt> while "untitled" one uses <tt>display #57</tt>. If you are trying examples in Arma 3 debug console, add a little delay like this: <code>[] spawn {sleep 0.5; {{codecomment|/* your example code goes here*/}} };</code> or no [[hintC]] will be displayed.
 +
</dd>
 +
<!-- Note Section END -->
 +
</dl>
 +
 
 +
[[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|Scripting Commands OFP 1.99]]
 +
{{GameCategory|arma1|Scripting Commands}}
 +
{{GameCategory|arma2|Scripting Commands}}
 +
{{GameCategory|arma3|Scripting Commands}}
 +
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 00:10, 7 February 2021

Hover & click on the images for descriptions

Description

Description:
Displays attractive hint in the center of the screen. Player control is taken away until "Continue" is pressed.
In Singleplayer, the game is paused as well.
After user confirmation, the content of the hintC is repeated again in a normal hint. This type of hint can also have a title. It is also possible to drag this type of hint around the screen.

Syntax

Syntax:
hintC content
Parameters:
content: String
Return Value:
Nothing

Alternative Syntax

Syntax:
title hintC content
Parameters:
title: String - message title
content: String, Structured Text, Array of Strings or Array of Structured Text
Return Value:
Nothing

Examples

Example 1:
hintC "Press W to move forward";
Example 2:
Same as the above in Arma 3 but without second hint displayed:hintC "Press W to move forward"; hintC_EH = findDisplay 57 displayAddEventHandler ["unload", { 0 = _this spawn { _this select 0 displayRemoveEventHandler ["unload", hintC_EH]; hintSilent ""; }; }]; HintC.jpg
Example 3:
"Instructions" hintC [ "Press W to move forward.", "Press S to move backwards.", "Use the mouse to turn right or left.", "Press V for weapon sights." ];
Example 4:
Same as the above in Arma 3 but without second hint displayed: "Instructions" hintC [ "Press W to move forward.", "Press S to move backwards.", "Use the mouse to turn right or left.", "Press V for weapon sights." ]; hintC_arr_EH = findDisplay 72 displayAddEventHandler ["unload", { 0 = _this spawn { _this select 0 displayRemoveEventHandler ["unload", hintC_arr_EH]; hintSilent ""; }; }]; HintC array.jpg
Example 5:
private _separator1 = parseText "<br />------------------------<br />"; private _image = "\ca\ui\textures\aus_flag.paa"; private _txt = composeText [image _image, "Heading Text", _separator1, "Content"]; "" hintC _txt;

Additional Information

See also:
hinthintCadethintSilent
Groups:
InteractionStructured TextStrings

Notes

i
Only post proven facts here. Report bugs on the Feedback Tracker and discuss on the Arma Discord or on the Forums.
Str
This command must be executed after mission start. If you place it into init.sqs or init field of some unit, it will not work. Just add a little delay (~0.001) and the place the command.
Worldeater
To display multiple messages after another you have to add a small delay in between. Otherwise only the first message will be displayed. hintC "foo"; sleep 0.1; hintC "bar" Without a sleep statement hintC will not suspend the script it has been called from.
ArmAtec
HintC can be used with formatting like this: hintC format ["Hello %1", player]
Posted on March 19, 2015 - 09:52 (UTC)
Killzone Kid
"Titled" hintC uses display #72 while "untitled" one uses display #57. If you are trying examples in Arma 3 debug console, add a little delay like this: [] spawn {sleep 0.5; /* your example code goes here*/ }; or no hintC will be displayed.