Ui::displayHelpTextFromStringLabel: Difference between revisions

Latest revision as of 06:07, 28 February 2019

p0 is always 0.
duration when set to -1, is around 3s. Can not be more than 5000ms.

Example:

void FloatingHelpText1(char* text) {
    BEGIN_TEXT_COMMAND_DISPLAY_HELP('STRING');
    ADD_TEXT_COMPONENT_SUBSTRING_PLAYER_NAME(text);
    END_TEXT_COMMAND_DISPLAY_HELP (0, 0, 1, -1);
}

Image:
- imgbin.org/images/26209.jpg

more inputs/icons: (scroll to line 377 and below)
- pastebin.com/nqNYWMSB

Used to be known as _DISPLAY_HELP_TEXT_FROM_STRING_LABEL

Syntax

mp.game.ui.displayHelpTextFromStringLabel(p0, loop, beep, duration);

Required Arguments

p0: unknown (to be checked)
loop: Boolean
beep: Boolean
duration: int

Return value

Undefined

Example

mp.game.ui.setTextComponentFormat('STRING');
mp.game.ui.addTextComponentSubstringPlayerName('Hit ~INPUT_CONTEXT~ to do something');
mp.game.ui.displayHelpTextFromStringLabel(0, true, true, -1);

@@ Line 1: / Line 1: @@
-shape goes from -1 to 50 (may be more).<br>p0 is always 0.<br><br>Example:<br>void FloatingHelpText1(char* text)<br>{<br>	BEGIN_TEXT_COMMAND_DISPLAY_HELP('STRING');<br>	ADD_TEXT_COMPONENT_SUBSTRING_PLAYER_NAME(text);<br>	END_TEXT_COMMAND_DISPLAY_HELP (0, 0, 1, -1);<br>}<br><br>Image:<br>- imgbin.org/images/26209.jpg<br><br>more inputs/icons: (scroll to line 377 and below)<br>- pastebin.com/nqNYWMSB<br><br>Used to be known as _DISPLAY_HELP_TEXT_FROM_STRING_LABEL
+p0 is always 0.<br>
+duration when set to -1, is around 3s. Can not be more than 5000ms.
+<br><br>Example:<br>
+<syntaxhighlight lang="javascript">
+void FloatingHelpText1(char* text) {
+    BEGIN_TEXT_COMMAND_DISPLAY_HELP('STRING');
+    ADD_TEXT_COMPONENT_SUBSTRING_PLAYER_NAME(text);
+    END_TEXT_COMMAND_DISPLAY_HELP (0, 0, 1, -1);
+}</syntaxhighlight>
+<br>Image:<br>- imgbin.org/images/26209.jpg<br><br>more inputs/icons: (scroll to line 377 and below)<br>- pastebin.com/nqNYWMSB<br><br>Used to be known as _DISPLAY_HELP_TEXT_FROM_STRING_LABEL
 ==Syntax==
-<syntaxhighlight lang="javascript">mp.game.ui.displayHelpTextFromStringLabel(p0, loop, beep, shape);</syntaxhighlight>
+<syntaxhighlight lang="javascript">mp.game.ui.displayHelpTextFromStringLabel(p0, loop, beep, duration);</syntaxhighlight>
 === Required Arguments ===
 *'''p0:''' unknown (to be checked)
 *'''loop:''' Boolean
 *'''beep:''' Boolean
-*'''shape:''' int
+*'''duration:''' int
 ===Return value===
 *'''Undefined'''
 ==Example==
 <syntaxhighlight lang="javascript">
-// todo
+mp.game.ui.setTextComponentFormat('STRING');
+mp.game.ui.addTextComponentSubstringPlayerName('Hit ~INPUT_CONTEXT~ to do something');
+mp.game.ui.displayHelpTextFromStringLabel(0, true, true, -1);
 </syntaxhighlight>
 ==See also==
 {{Ui_s_function_c}}
 [[Category:Clientside API]]
+[[Category:UI API]]
 [[Category:TODO: Example]]