hintC: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "[] spawn" to "0 spawn")
 
(81 intermediate revisions by 19 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|HINTC]]
{{RV|type=command
[[Category:Scripting Commands OFP 1.97|HINTC]]
[[Category:Scripting Commands OFP 1.46|HINTC]]
[[Category:Scripting Commands ArmA|HINTC]]


|game1= ofp
|version1= 1.00


<h2 style="color:#000066"> '''hintC ''text'''''</h2>
|game2= ofpe
|version2= 1.00


|game3= arma1
|version3= 1.00


'''Operand types:'''
|game4= arma2
|version4= 1.00


'''text:''' [[String]]
|game5= arma2oa
|version5= 1.50


'''Type of returned value:'''
|game6= tkoh
|version6= 1.00


[[Nothing]]
|game7= arma3
|version7= 0.50


'''Description:'''
|eff= local


Show hint text.
|gr1= Interaction


Text can contain several lines.
|gr2= Structured Text


An '''\n''' is used to indicate a new line.
|gr3= Strings


Hint must be confirmed.
|descr= Displays a very basic message dialog in the center of the screen. Player control is taken away until "Continue" is pressed. The message dialog can be dragged around on the screen. After "Continue" has been pressed, the content of the [[hintC]] is repeated in a normal [[hint]].
{{Feature|informative|In Singleplayer, the game is paused while the message dialog is visible.}}


|s1= [[hintC]] message


'''Example:'''
|p1= message: [[String]]


'''hintC''' "Press V for weapon sights"
|r1= [[Nothing]]
 
|s2= title [[hintC]] message
 
|p21= title: [[String]] - message title
 
|p22= message: [[String]], [[Structured Text]], [[Array]] of [[String]]s or [[Array]] of [[Structured Text]]
 
|r2= [[Nothing]]
 
|x1= <sqf>hintC "Press W to move forward";</sqf>
 
|x2= Same as the above in {{arma3}} but without second [[hint]] displayed:<br>[[File:HintC.jpg|400px|right]]
<sqf>
hintC "Press W to move forward";
hintC_EH = findDisplay 57 displayAddEventHandler ["Unload", {
_this spawn {
_this select 0 displayRemoveEventHandler ["Unload", hintC_EH];
hintSilent "";
};
}];
</sqf>
 
|x3= <sqf>
"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."
];
</sqf>
 
|x4= Same as the above in {{arma3}} but without second [[hint]] displayed:<br>[[File:HintC_array.jpg|400px|right]]
<sqf>
"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_EH = findDisplay 72 displayAddEventHandler ["Unload", {
_this spawn {
_this select 0 displayRemoveEventHandler ["Unload", hintC_EH];
hintSilent "";
};
}];
</sqf>
 
|x5= <sqf>
private _separator = parseText "<br/>------------------------<br/>";
private _image = "\ca\ui\textures\aus_flag.paa";
private _message = composeText [image _image, "Heading Text", _separator, "Content"];
"" hintC _message;
</sqf>
 
|seealso= [[hint]] [[hintCadet]] [[hintSilent]] [[BIS_fnc_guiMessage]]
}}
 
{{Note
|user= Str
|timestamp= 20060731181800
|text= 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.
}}
 
{{Note
|user= Worldeater
|timestamp= 20090515234200
|text= To display multiple messages after another you have to add a small delay in between. Otherwise only the first message will be displayed.
<sqf>hintC "foo"; sleep 0.1; hintC "bar"</sqf>
Without a [[sleep]] statement [[hintC]] will not suspend the script it has been called from.
}}
 
{{Note
|user= Killzone_Kid
|timestamp= 20150319095200
|text= "Titled" [[hintC]] uses {{hl|display #72}} while "untitled" one uses {{hl|display #57}}. If you are trying examples in Arma 3 debug console, add a little delay like this:
<sqf>0 spawn { sleep 0.5; /* your example code goes here*/ };</sqf> or no [[hintC]] will be displayed.
}}

Latest revision as of 21:24, 2 September 2024

Hover & click on the images for description

Description

Description:
Displays a very basic message dialog in the center of the screen. Player control is taken away until "Continue" is pressed. The message dialog can be dragged around on the screen. After "Continue" has been pressed, the content of the hintC is repeated in a normal hint.
In Singleplayer, the game is paused while the message dialog is visible.
Groups:
InteractionStructured TextStrings

Syntax

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

Alternative Syntax

Syntax:
title hintC message
Parameters:
title: String - message title
message: 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.jpg
hintC "Press W to move forward"; hintC_EH = findDisplay 57 displayAddEventHandler ["Unload", { _this spawn { _this select 0 displayRemoveEventHandler ["Unload", hintC_EH]; hintSilent ""; }; }];
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:
HintC array.jpg
"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_EH = findDisplay 72 displayAddEventHandler ["Unload", { _this spawn { _this select 0 displayRemoveEventHandler ["Unload", hintC_EH]; hintSilent ""; }; }];
Example 5:
private _separator = parseText "<br/>------------------------<br/>"; private _image = "\ca\ui\textures\aus_flag.paa"; private _message = composeText [image _image, "Heading Text", _separator, "Content"]; "" hintC _message;

Additional Information

See also:
hint hintCadet hintSilent BIS_fnc_guiMessage

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
Str - c
Posted on Jul 31, 2006 - 18:18 (UTC)
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 - c
Posted on May 15, 2009 - 23:42 (UTC)
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.
Killzone_Kid - c
Posted on Mar 19, 2015 - 09:52 (UTC)
"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:
0 spawn { sleep 0.5; /* your example code goes here*/ };
or no hintC will be displayed.