Difference between revisions of "hintC"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|PARAMETER1= |p22=" to "|PARAMETER21= |p22=")
m (Text replacement - "[[Category:Scripting Commands ArmA|" to "[[Category:Scripting Commands Armed Assault|")
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Command|Comments=
+
{{Command
____________________________________________________________________________________________
 
  
| ofp |Game name=
+
|game1= ofp
  
|1.00|Game version=
+
|version1= 1.00
  
|eff= local |Multiplayer Effects=
+
|eff= local
____________________________________________________________________________________________
 
  
| Displays attractive hint in the center of the screen. Player control is taken away until user presses "Continue". 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.|DESCRIPTION=
+
|descr= Displays attractive hint in the center of the screen. Player control is taken away until "Continue" is pressed.
___________________________________________________________________________________________
 
  
| '''hintC''' content |SYNTAX=
+
{{Informative | In Singleplayer, the game is paused as well.}}
|p1 =  content: [[String]]
 
| [[Nothing]]  |RETURNVALUE=
 
  
____________________________________________________________________________________________
+
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.
  
|s2= title '''hintC''' [content1, content2, ...] |SYNTAX=2
 
  
|p21= title: [[String]] |PARAMETER21=
+
|s1= [[hintC]] content
  
|p22= [content1, content2, ...]: [[Array]] of [[String]]s or [[Structured Text]]s. |PARAMETER2=
+
|p1= content: [[String]]
  
 +
|r1= [[Nothing]]
  
|r2= [[Nothing]] |RETURNVALUE=
 
  
____________________________________________________________________________________________
+
|s2= title [[hintC]] content
  
|s3= title '''hintC''' content |SYNTAX=3
+
|p21= title: [[String]] - message title
 +
|p22= content: [[String]], [[Structured Text]], [[Array]] of [[String]]s or [[Array]] of [[Structured Text]]
  
|p41= title: [[String]] |PARAMETER1=
+
|r2= [[Nothing]]
  
|p42= content: [[Structured Text]] |PARAMETER2=
 
  
|r3= [[Nothing]] |RETURNVALUE=
+
|x1 = <code>[[hintC]] "Press W to move forward";</code>
____________________________________________________________________________________________
 
  
|s4= title '''hintC''' content |SYNTAX=3
+
|x2 = Same as the above in {{arma3}} but without second [[hint]] displayed:<code>[[hintC]] "Press W to move forward";
 
 
|p61= title: [[String]] |PARAMETER1=
 
 
 
|p62= content: [[String]] |PARAMETER2=
 
 
 
|r4= [[Nothing]] |RETURNVALUE=
 
____________________________________________________________________________________________
 
|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", {
 
hintC_EH = [[findDisplay]] 57 [[displayAddEventHandler]] ["unload", {
 
0 = _this [[spawn]] {
 
0 = _this [[spawn]] {
Line 56: Line 39:
 
}];</code>
 
}];</code>
  
[[Image:HintC.jpg|400px]]  
+
[[Image:HintC.jpg|400px]]
  
|x3= <code>"Instructions" '''hintC''' [
+
|x3= <code>"Instructions" [[hintC]] [
 
"Press W to move forward.",
 
"Press W to move forward.",
 
"Press S to move backwards.",
 
"Press S to move backwards.",
 
"Use the mouse to turn right or left.",
 
"Use the mouse to turn right or left.",
 
"Press V for weapon sights."
 
"Press V for weapon sights."
];</code> |EXAMPLE1=
+
];</code> |EXAMPLE3=
|x4= Same as the above in Arma3 but without second [[hint]] displayed: <code>"Instructions" '''hintC''' [
+
 
 +
|x4= Same as the above in {{arma3}} but without second [[hint]] displayed: <code>"Instructions" [[hintC]] [
 
"Press W to move forward.",
 
"Press W to move forward.",
 
"Press S to move backwards.",
 
"Press S to move backwards.",
Line 77: Line 61:
 
}];</code>  
 
}];</code>  
  
  [[Image:HintC_array.jpg|400px]] |EXAMPLE2=
+
  [[Image:HintC_array.jpg|400px]]
  
|x5= <code>_separator1 = [[parseText]] "<nowiki><br />------------------------<br /></nowiki>";  
+
|x5= <code>[[private]] _separator1 = [[parseText]] "<nowiki><br />------------------------<br /></nowiki>";  
_image = "\ca\ui\textures\aus_flag.paa";  
+
[[private]] _image = "\ca\ui\textures\aus_flag.paa";  
_txt = [[composeText]] <nowiki>[</nowiki>[[image]] _image, "Heading Text", _separator1, "Content"];  
+
[[private]] _txt = [[composeText]] [<nowiki/>[[image]] _image, "Heading Text", _separator1, "Content"];  
"" [[hintC]] _txt;</code> |EXAMPLE5=
+
"" [[hintC]] _txt;</code>
  
| [[hint]], [[hintCadet]], [[hintSilent]] |SEEALSO=
+
|seealso= [[hint]], [[hintCadet]], [[hintSilent]]
 +
}}
  
}}
 
 
<h3 style="display:none">Notes</h3>
 
<h3 style="display:none">Notes</h3>
 
<dl class="command_description">
 
<dl class="command_description">
 
<!-- Note Section BEGIN -->
 
<!-- Note Section BEGIN -->
<dt class="note">'''[[User:Str|Str]]'''
+
 
 +
<dd class="notedate">
 +
<dt class="note">[[User:Str|Str]]
 
<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="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.
<dt class="note">'''[[User:Worldeater|Worldeater]]'''
 
<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. hintC "foo"; sleep 0.1; hintC "bar"; Without a [[sleep]] statement ''hintC'' will not suspend the script it has been called from.
 
<!-- Note Section END -->
 
<dt class="note">'''[[User:ArmAtec|ArmAtec]]'''
 
<dd class="note">HintC can be used with formatting like this: HintC format["Hello %1",player].
 
</dl>
 
  
<h3 style="display:none">Bottom Section</h3>
+
<dd class="notedate">
[[Category:Scripting Commands|HINTC]]
+
<dt class="note">[[User:Worldeater|Worldeater]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
+
<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.
[[Category:Scripting Commands OFP 1.96|HINTC]]
+
<code>[[hintC]] "foo"; [[sleep]] 0.1; [[hintC]] "bar"</code>
[[Category:Scripting Commands OFP 1.46|HINTC]]
+
Without a [[sleep]] statement [[hintC]] will not suspend the script it has been called from.
[[Category:Scripting Commands ArmA|HINTC]]
+
 
[[Category:Command_Group:_Interaction|{{uc:{{PAGENAME}}}}]]
+
<dd class="notedate">
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
+
<dt class="note">[[User:ArmAtec|ArmAtec]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
+
<dd class="note">HintC can be used with formatting like this: <code>[[hintC]] [[format]] ["Hello %1", [[player]]]</code>
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 
  
<!-- CONTINUE Notes -->
 
<dl class="command_description">
 
 
<dd class="notedate">Posted on March 19, 2015 - 09:52 (UTC)</dd>
 
<dd class="notedate">Posted on March 19, 2015 - 09:52 (UTC)</dd>
 
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
 
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
<dd class="note">
+
<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.
"Titled" [[hintC]] all use display #72 while "untitled" one uses display #57. If you are trying examples in Arma 3 debug console, add little delay like this: <code>[] spawn {sleep 0.5; ....your example code goes here ...};</code> or no [[hintC]] will be displayed.
 
 
</dd>
 
</dd>
 +
<!-- Note Section END -->
 
</dl>
 
</dl>
<!-- DISCONTINUE Notes -->
+
 
 +
<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|Scripting Commands OFP 1.99]]
 +
[[Category:Scripting Commands Armed Assault|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Command_Group:_Interaction|{{uc:{{PAGENAME}}}}]]

Revision as of 20:08, 3 June 2020

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

Notes

i
Only post proven facts here. Report bugs on the Feedback Tracker and discuss on the Arma Discord or on the Forums.

Notes

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.

Bottom Section