HUDClient

beginTextCommandBusyspinnerOn

BEGIN_TEXT_COMMAND_BUSYSPINNER_ON0xABA17D7CE615ADBF

The GTA V native BEGIN_TEXT_COMMAND_BUSYSPINNER_ON of the HUD namespace, as LS:MP client scripts call it: the global function beginTextCommandBusyspinnerOn, in JavaScript and in Lua.

SignatureJavaScript
beginTextCommandBusyspinnerOn(string: string): void
SignatureLua
beginTextCommandBusyspinnerOn(string: string)

Usage

JavaScript
beginTextCommandBusyspinnerOn(string);
Lua
beginTextCommandBusyspinnerOn(string)

Parameters

ParameterTypeJavaScriptLua
stringstringstringstring

Returns

Nothing. In JavaScript the call evaluates to undefined.

Notes

From the community native database. Names are LS:MP’s; samples may be written for C++ or another framework.

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

e.g

void StartLoadingMessage(char *text, int spinnerType = 3)
  {
     beginTextCommandBusyspinnerOn("STRING");
       addTextComponentSubstringPlayerName(text);
       endTextCommandBusyspinnerOn(spinnerType);
    }

/*OR*/

void ShowLoadingMessage(char *text, int spinnerType = 3, int timeMs = 10000)
 {
    beginTextCommandBusyspinnerOn("STRING");
      addTextComponentSubstringPlayerName(text);
      endTextCommandBusyspinnerOn(spinnerType);
       WAIT(timeMs);
    busyspinnerOff();
}

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

Reference

Namespace
HUD HUD
In the game
void BEGIN_TEXT_COMMAND_BUSYSPINNER_ON(const char* string)
Hash
0xABA17D7CE615ADBF
Formerly
_SET_LOADING_PROMPT_TEXT_ENTRY _BEGIN_TEXT_COMMAND_BUSY_STRING

Open in the interactive natives reference