Ui::setLoadingPromptTextEntry: Difference between revisions

From RAGE Multiplayer Wiki
(yay)
 
(yay)
Line 1: Line 1:
Initializes the text entry for the the text next to a loading prompt. All natives for for building UI texts can be used here<br><br><br>e.g<br>void StartLoadingMessage(char *text, int spinnerType = 3)<br> {<br> _SET_LOADING_PROMPT_TEXT_ENTRY('STRING');<br> ADD_TEXT_COMPONENT_SUBSTRING_PLAYER_NAME(text);<br> _SHOW_LOADING_PROMPT(spinnerType);<br> }<br>/*OR*/<br> void ShowLoadingMessage(char *text, int spinnerType = 3, int timeMs = 10000)<br> {<br> _SET_LOADING_PROMPT_TEXT_ENTRY('STRING');<br> ADD_TEXT_COMPONENT_SUBSTRING_PLAYER_NAME(text);<br> _SHOW_LOADING_PROMPT(spinnerType);<br> WAIT(timeMs);<br> _REMOVE_LOADING_PROMPT();<br> }<br><br><br>These are some localized strings used in the loading spinner.<br>'PM_WAIT'                  = Please Wait<br>'CELEB_WPLYRS'              = Waiting For Players.<br>'CELL_SPINNER2'            = Scanning storage.<br>'ERROR_CHECKYACHTNAME' = Registering your yacht's name. Please wait.<br>'ERROR_CHECKPROFANITY'  = Checking your text for profanity. Please wait.<br>'FM_COR_AUTOD'                        = Just spinner no text<br>'FM_IHELP_WAT2'                        = Waiting for other players<br>'FM_JIP_WAITO'                            = Game options are being set<br>'FMMC_DOWNLOAD'                    = Downloading<br>'FMMC_PLYLOAD'                        = Loading<br>'FMMC_STARTTRAN'                    = Launching session<br>'HUD_QUITTING'                          =  Quiting session<br>'KILL_STRIP_IDM'                        = Waiting for to accept<br>'MP_SPINLOADING'                      = Loading
Initializes the text entry for the the text next to a loading prompt. All natives for for building UI texts can be used here<br><br><br>e.g<br>void StartLoadingMessage(char *text, int spinnerType = 3)<br> {<br> _SET_LOADING_PROMPT_TEXT_ENTRY('STRING');<br> ADD_TEXT_COMPONENT_SUBSTRING_PLAYER_NAME(text);<br> _SHOW_LOADING_PROMPT(spinnerType);<br> }<br>/*OR*/<br> void ShowLoadingMessage(char *text, int spinnerType = 3, int timeMs = 10000)<br> {<br> _SET_LOADING_PROMPT_TEXT_ENTRY('STRING');<br> ADD_TEXT_COMPONENT_SUBSTRING_PLAYER_NAME(text);<br> _SHOW_LOADING_PROMPT(spinnerType);<br> WAIT(timeMs);<br> _REMOVE_LOADING_PROMPT();<br> }<br><br><br>These are some localized strings used in the loading spinner.<br>'PM_WAIT'                  = Please Wait<br>'CELEB_WPLYRS'              = Waiting For Players.<br>'CELL_SPINNER2'            = Scanning storage.<br>'ERROR_CHECKYACHTNAME' = Registering your yacht's name. Please wait.<br>'ERROR_CHECKPROFANITY'  = Checking your text for profanity. Please wait.<br>'FM_COR_AUTOD'                        = Just spinner no text<br>'FM_IHELP_WAT2'                        = Waiting for other players<br>'FM_JIP_WAITO'                            = Game options are being set<br>'FMMC_DOWNLOAD'                    = Downloading<br>'FMMC_PLYLOAD'                        = Loading<br>'FMMC_STARTTRAN'                    = Launching session<br>'HUD_QUITTING'                          =  Quiting session<br>'KILL_STRIP_IDM'                        = Waiting for to accept<br>'MP_SPINLOADING'                      = Loading
==Syntax==
==Syntax==
<syntaxhighlight lang="javascript">ui.setLoadingPromptTextEntry(string);</syntaxhighlight>
<syntaxhighlight lang="javascript">mp.game.ui.setLoadingPromptTextEntry(string);</syntaxhighlight>
=== Required Arguments ===
=== Required Arguments ===
*'''string:''' String
*'''string:''' String
Line 8: Line 8:
==Example==
==Example==
<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
todo
// todo
</syntaxhighlight>
</syntaxhighlight>
==See also==
==See also==
{{Ui_function_c}}
{{Ui_s_function_c}}
[[Category:Clientside API]]
[[Category:Clientside API]]
[[Category:TODO: Example]]
[[Category:TODO: Example]]

Revision as of 21:33, 6 May 2017

Initializes the text entry for the the text next to a loading prompt. All natives for for building UI texts can be used here


e.g
void StartLoadingMessage(char *text, int spinnerType = 3)
{
_SET_LOADING_PROMPT_TEXT_ENTRY('STRING');
ADD_TEXT_COMPONENT_SUBSTRING_PLAYER_NAME(text);
_SHOW_LOADING_PROMPT(spinnerType);
}
/*OR*/
void ShowLoadingMessage(char *text, int spinnerType = 3, int timeMs = 10000)
{
_SET_LOADING_PROMPT_TEXT_ENTRY('STRING');
ADD_TEXT_COMPONENT_SUBSTRING_PLAYER_NAME(text);
_SHOW_LOADING_PROMPT(spinnerType);
WAIT(timeMs);
_REMOVE_LOADING_PROMPT();
}


These are some localized strings used in the loading spinner.
'PM_WAIT' = Please Wait
'CELEB_WPLYRS' = Waiting For Players.
'CELL_SPINNER2' = Scanning storage.
'ERROR_CHECKYACHTNAME' = Registering your yacht's name. Please wait.
'ERROR_CHECKPROFANITY' = Checking your text for profanity. Please wait.
'FM_COR_AUTOD' = Just spinner no text
'FM_IHELP_WAT2' = Waiting for other players
'FM_JIP_WAITO' = Game options are being set
'FMMC_DOWNLOAD' = Downloading
'FMMC_PLYLOAD' = Loading
'FMMC_STARTTRAN' = Launching session
'HUD_QUITTING' = Quiting session
'KILL_STRIP_IDM' = Waiting for to accept
'MP_SPINLOADING' = Loading

Syntax

mp.game.ui.setLoadingPromptTextEntry(string);

Required Arguments

  • string: String

Return value

  • Undefined

Example

// todo

See also

Retrieved from "https://wiki.rage.mp/w/index.php?title=Ui::setLoadingPromptTextEntry&oldid=3425"