Ui::setLoadingPromptTextEntry: Difference between revisions

From RAGE Multiplayer Wiki
(yay)
No edit summary
Line 13: Line 13:
{{Ui_s_function_c}}
{{Ui_s_function_c}}
[[Category:Clientside API]]
[[Category:Clientside API]]
[[Category:UI API]]
[[Category:TODO: Example]]
[[Category:TODO: Example]]

Revision as of 14:57, 20 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