Difference between revisions of "hintC"

From Bohemia Interactive Community
Jump to navigation Jump to search
(Undo revision 88059 by CryLegend (talk) restored broken example)
(combined all syntaxes)
Line 9: Line 9:
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| Works the same way as [[hint]], except the text is also displayed in the middle of the screen.
+
| 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. |= Description
 +
____________________________________________________________________________________________
 +
 
 +
| '''hintC''' content |= Syntax
 +
|p1 =  content: [[String]]
 +
| [[Nothing]] |= Return value
 +
 
 +
____________________________________________________________________________________________
 +
 
 +
|s2= title '''hintC''' [content1, content2, ...] |= Syntax2
 +
 
 +
|p21= title: [[String]]: |= Parameter 1
 +
 
 +
|p22= [content1, content2, ...]: [[Array]] of [[String]]s or [[Structured Text]]s. |= Parameter 2
 +
 
 +
 
 +
|r2= [[Nothing]] |= Return value
 +
 
 +
____________________________________________________________________________________________
 +
 
 +
|s3= title '''hintC''' content |= Syntax3
 +
 
 +
|p41= title: [[String]] |= Parameter 1
 +
 
 +
|p42= content: [[Structured Text]] |= Parameter 2
  
The game is paused until the player presses "Continue". |= Description
+
|r3= [[Nothing]] |= Return value
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| '''hintC''' text |= Syntax
+
|s4= title '''hintC''' content |= Syntax3
|p1 = text: [[String]]
+
 
| [[Nothing]] |= Return value
+
|p61= title: [[String]] |= Parameter 1
 +
 
 +
|p62= content: [[String]] |= Parameter 2
 +
 
 +
|r4= [[Nothing]] |= Return value
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
 
|x1 = <code>[[hintC]] "Press W to move forward"; </code>
 
|x1 = <code>[[hintC]] "Press W to move forward"; </code>
Line 30: Line 58:
 
  [[Image:HintC.jpg|400px]]  
 
  [[Image:HintC.jpg|400px]]  
  
| [[hint]], [[hintCadet]], [[hintC array]], [[hintC structuredText]], [[hintC text]], [[hintSilent]] |= See also
+
|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> |= Example 1
 +
|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]]  |= Example 2
 +
 
 +
|x5= <code>_separator1 = [[parseText]] "<nowiki><br />------------------------<br /></nowiki>";
 +
_image = "\ca\ui\textures\aus_flag.paa";
 +
_txt = [[composeText]] <nowiki>[</nowiki>[[image]] _image, "Heading Text", _separator1, "Content"];
 +
[[hintC]] _txt;</code> |=Example 5
 +
 
 +
| [[hint]], [[hintCadet]], [[hintSilent]] |= See also
  
 
}}
 
}}
Line 36: Line 90:
 
<dl class="command_description">
 
<dl class="command_description">
 
<!-- Note Section BEGIN -->
 
<!-- Note Section BEGIN -->
<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.
+
<dt class="note">'''[[User:Str|Str]]'''
<dt class="note">'''[[User:ArmAtec|ArmAtec]]'''<dd class="note">
+
<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.
HintC can be used with formatting like this:
+
<dt class="note">'''[[User:Worldeater|Worldeater]]'''
HintC format["Hello %1",player]
+
<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.
<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 -->
 
<!-- 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>
 
</dl>
  

Revision as of 11:49, 19 March 2015

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

Syntax

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

Alternative Syntax

Syntax:
title hintC [content1, content2, ...]
Parameters:
title: String:
[content1, content2, ...]: Array of Strings or Structured Texts.
Return Value:
Nothing

Alternative Syntax 2

Syntax:
title hintC content
Parameters:
title: String
content: Structured Text
Return Value:
Nothing

Alternative Syntax 3

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

Examples

Example 1:
hintC "Press W to move forward";
Example 2:
Same as the above in Arma3 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 Arma3 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:
_separator1 = parseText "<br />------------------------<br />"; _image = "\ca\ui\textures\aus_flag.paa"; _txt = composeText [image _image, "Heading Text", _separator1, "Content"]; hintC _txt;

Additional Information

See also:
hinthintCadethintSilent

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].

Bottom Section