The FiveM developer’s field guide
Know the native.
Build the world.
Engine functions, framework docs, and game assets.
One reference. From the first lookup to the last line.
knowledge base
Explore / FiveM
Native reference
- HUDvoid
0xEB81A3DADD503187
``` NativeDB Introduced: v1290 ```
0xEB81A3DADD503187 - HUDBOOL
0xF13FE2A80C05C561
Description not yet documented
0xF13FE2A80C05C561 - HUDAny
0xF284AC67940C6812
Description not yet documented
0xF284AC67940C6812 - HUDvoid
0xF83D0FEBE75E62C9
``` NativeDB Added Parameter 9: int hudColour NativeDB Introduced: v1290 ``` Sets the 'data' for a cone for a blip See [here](https://docs.fivem.net/docs/game-references/hud-colors/) for the hud colours for the cone Name in scripts: `SETUP_FAKE_CONE_DATA()` For people who don't know how to convert degrees to radians and the other way around: ``` degrees = radians * 180 / pi radians = degrees * pi / 180 ```
0xF83D0FEBE75E62C9 - HUDvoid
ACTIVATE_FRONTEND_MENU
Does stuff like this:\ gyazo.com/7fcb78ea3520e3dbc5b2c0c0f3712617\ Example:\ int GetHash = GET_HASH_KEY("fe_menu_version_corona_lobby");\ ACTIVATE_FRONTEND_MENU(GetHash, 0, -1);\ BOOL p1 is a toggle to define the game in pause.\ int p2 is unknown but -1 always works, not sure why though.\ \[30/03/2017] ins1de :\ the int p2 is actually a component variable. When the pause menu is visible, it opens the tab related to it.\ Example : Function.Call(Hash.ACTIVATE_FRONTEND_MENU,-1171018317, 0, 42);\ Result : Opens the "Online" tab without pausing the menu, with -1 it opens the map. Below is a list of all known Frontend Menu Hashes. * FE_MENU_VERSION_SP_PAUSE * FE_MENU_VERSION_MP_PAUSE * FE_MENU_VERSION_CREATOR_PAUSE * FE_MENU_VERSION_CUTSCENE_PAUSE * FE_MENU_VERSION_SAVEGAME * FE_MENU_VERSION_PRE_LOBBY * FE_MENU_VERSION_LOBBY * FE_MENU_VERSION_MP_CHARACTER_SELECT * FE_MENU_VERSION_MP_CHARACTER_CREATION * FE_MENU_VERSION_EMPTY * FE_MENU_VERSION_EMPTY_NO_BACKGROUND * FE_MENU_VERSION_TEXT_SELECTION * FE_MENU_VERSION_CORONA * FE_MENU_VERSION_CORONA_LOBBY * FE_MENU_VERSION_CORONA_JOINED_PLAYERS * FE_MENU_VERSION_CORONA_INVITE_PLAYERS * FE_MENU_VERSION_CORONA_INVITE_FRIENDS * FE_MENU_VERSION_CORONA_INVITE_CREWS * FE_MENU_VERSION_CORONA_INVITE_MATCHED_PLAYERS * FE_MENU_VERSION_CORONA_INVITE_LAST_JOB_PLAYERS * FE_MENU_VERSION_CORONA_RACE * FE_MENU_VERSION_CORONA_BETTING * FE_MENU_VERSION_JOINING_SCREEN * FE_MENU_VERSION_LANDING_MENU * FE_MENU_VERSION_LANDING_KEYMAPPING_MENU
0xEF01D36B9C9D0C7B - HUDBlip
_ADD_BLIP_FOR_AREA
Adds a rectangular blip for the specified coordinates/area. It is recommended to use [SET_BLIP_ROTATION](#\_0xF87683CDF73C3F6E) and [SET_BLIP_COLOUR](#\_0x03D7FB09E75D6B7E) to make the blip not rotate along with the camera. By default, the blip will show as a *regular* blip with the specified color/sprite if it is outside of the minimap view. (Native name is *likely* to actually be ADD_BLIP_FOR_AREA, but due to the usual reasons this can't be confirmed)
0xCE5D0E5E315DB238 - HUDBlip
ADD_BLIP_FOR_COORD
Creates a blip for the specified coordinates. You can use `SET_BLIP_` natives to change the blip.
0x5A039BB0BCA604B6 - HUDBlip
ADD_BLIP_FOR_ENTITY
Create a blip that by default is red (enemy), you can use [SET_BLIP_AS_FRIENDLY](#\_0xC6F43D0E) to make it blue (friend).\ Can be used for objects, vehicles and peds. Example of enemy:  Example of friend: 
0x5CDE92C702A8FCE7 - HUDBlip
ADD_BLIP_FOR_PICKUP
Description not yet documented
0xBE339365C863BD36 - HUDBlip
ADD_BLIP_FOR_RADIUS
Create a blip with a radius for the specified coordinates (it doesnt create the blip sprite, so you need to use [AddBlipCoords](#\_0xC6F43D0E)) Example image: 
0x46818D79B1F7499A - HUDvoid
ADD_NEXT_MESSAGE_TO_PREVIOUS_BRIEFS
Description not yet documented
0x60296AF4BA14ABC5 - HUDvoid
ADD_POINT_TO_GPS_CUSTOM_ROUTE
Description not yet documented
0x311438A071DD9B1A - HUDvoid
ADD_POINT_TO_GPS_MULTI_ROUTE
Description not yet documented
0xA905192A6781C41B - HUDvoid
ADD_TEXT_COMPONENT_FLOAT
Adds a float to a text component placeholder, replacing `~1~` in the current text command's text label. 
0xE7DCB5B874BCD96E - HUDvoid
ADD_TEXT_COMPONENT_FORMATTED_INTEGER
Description not yet documented
0x0E4C749FF9DE9CC4 - HUDvoid
ADD_TEXT_COMPONENT_INTEGER
Description not yet documented
0x03B504CF259931BC - HUDvoid
ADD_TEXT_COMPONENT_SUBSTRING_BLIP_NAME
Description not yet documented
0x80EAD8E2E1D5D52E - HUDvoid
ADD_TEXT_COMPONENT_SUBSTRING_KEYBOARD_DISPLAY
Certain characters like `<` will have to be escaped using html entities (e.g. `<`), otherwise the text wont display properly.
0x5F68520888E69014 - HUDvoid
ADD_TEXT_COMPONENT_SUBSTRING_PHONE_NUMBER
``` p1 was always -1 ```
0x761B77454205A61D - HUDvoid
ADD_TEXT_COMPONENT_SUBSTRING_PLAYER_NAME
Adds an arbitrary string as a text component placeholder, replacing `~a~` in the current text command's text label. See the documentation on text formatting for more information.
0x6C188BE134E074AA - HUDvoid
ADD_TEXT_COMPONENT_SUBSTRING_TEXT_LABEL
Description not yet documented
0xC63CD5D2920ACBE7 - HUDvoid
ADD_TEXT_COMPONENT_SUBSTRING_TEXT_LABEL_HASH_KEY
``` It adds the localized text of the specified GXT entry name. Eg. if the argument is GET_HASH_KEY("ES_HELP"), adds "Continue". Just uses a text labels hash key ```
0x17299B63C7683A2B - HUDvoid
ADD_TEXT_COMPONENT_SUBSTRING_TIME
Takes a time in milliseconds and converts it to a string. Use `~a~` to mark the position in your line of text where you want this substring inserted. ```cpp enum eTimeFormat { TEXT_FORMAT_MILLISECONDS = 1, TEXT_FORMAT_SECONDS = 2, TEXT_FORMAT_MINUTES = 4, TEXT_FORMAT_HOURS = 8, TEXT_FORMAT_DAYS = 16, // e.g. show 12:20 not 00:12:20 TEXT_FORMAT_HIDE_LEADING_UNITS_EQUAL_TO_ZERO = 32, // e.g. show 1:14 not 01:14 TEXT_FORMAT_HIDE_LEADING_ZEROS_ON_LEADING_UNITS = 64, // e.g. show 3m24s not 3:24 TEXT_FORMAT_SHOW_UNIT_DIVIDERS_AS_LETTERS = 128, // e.g. show 3m24 not 3m24s TEXT_FORMAT_HIDE_UNIT_LETTER_FOR_SMALLEST_UNITS = 256, // e.g. show 05:51 not 05:519 TEXT_FORMAT_HIDE_MILLISECONDS_UNITS_DIGIT = 512, // e.g. show 05:5 not 05:519 TEXT_FORMAT_HIDE_MILLISECONDS_TENS_DIGIT = 1024, // e.g. show 12.345 not 12:345 TEXT_FORMAT_USE_DOT_FOR_MILLISECOND_DIVIDER = 2048 } ```
0x1115F16B8AB9E8BF - HUDvoid
ADD_TEXT_COMPONENT_SUBSTRING_WEBSITE
``` This native (along with 0x5F68520888E69014 and 0x6C188BE134E074AA) do not actually filter anything. They simply add the provided text (as of 944) ```
0x94CF4AC034C9C986 - HUDvoid
ALLOW_DISPLAY_OF_MULTIPLAYER_CASH_TEXT
Before:  After: 
0xE67C6DFD386EA5E7 - HUDvoid
_ALLOW_PAUSE_MENU_WHEN_DEAD_THIS_FRAME
Allows opening the pause menu this frame, when the player is dead.
0xCC3FDDED67BCFC63 - HUDvoid
ALLOW_SONAR_BLIPS
Description not yet documented
0x60734CC207C9833C - HUDvoid
BEGIN_TEXT_COMMAND_BUSYSPINNER_ON
``` Initializes the text entry for the the text next to a loading prompt. All natives for for building UI texts can be used here BEGIN_TEXT_COMMAND_PRINT 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 ```
0xABA17D7CE615ADBF - HUDvoid
BEGIN_TEXT_COMMAND_CLEAR_PRINT
``` clears a print text command with this text ```
0xE124FA80A759019C - HUDvoid
BEGIN_TEXT_COMMAND_DISPLAY_HELP
``` Used to be known as _SET_TEXT_COMPONENT_FORMAT ```
0x8509B634FBE7DA11 - HUDvoid
BEGIN_TEXT_COMMAND_DISPLAY_TEXT
``` The following were found in the decompiled script files: STRING, TWOSTRINGS, NUMBER, PERCENTAGE, FO_TWO_NUM, ESMINDOLLA, ESDOLLA, MTPHPER_XPNO, AHD_DIST, CMOD_STAT_0, CMOD_STAT_1, CMOD_STAT_2, CMOD_STAT_3, DFLT_MNU_OPT, F3A_TRAFDEST, ES_HELP_SOC3 ESDOLLA ESMINDOLLA - cash (negative) Used to be known as _SET_TEXT_ENTRY ```
0x25FBB336DF1804CB - HUDvoid
_BEGIN_TEXT_COMMAND_GET_WIDTH
``` BEGIN_TEXT_COMMAND_* Example: _BEGIN_TEXT_COMMAND_GET_WIDTH("NUMBER"); ADD_TEXT_COMPONENT_FLOAT(69.420f, 2); float width = _END_TEXT_COMMAND_GET_WIDTH(1); ```
0x54CE8AC98E120CAB - HUDvoid
BEGIN_TEXT_COMMAND_IS_MESSAGE_DISPLAYED
``` nothin doin. BOOL Message(char* text) { BEGIN_TEXT_COMMAND_IS_MESSAGE_DISPLAYED("STRING"); ADD_TEXT_COMPONENT_SUBSTRING_PLAYER_NAME(text); return END_TEXT_COMMAND_IS_MESSAGE_DISPLAYED(); } ```
0x853648FD1063A213 - HUDvoid
BEGIN_TEXT_COMMAND_IS_THIS_HELP_MESSAGE_BEING_DISPLAYED
Description not yet documented
0x0A24DA3A41B718F5 - HUDvoid
_BEGIN_TEXT_COMMAND_LINE_COUNT
``` get's line count int GetLineCount(char *text, float x, float y) { _BEGIN_TEXT_COMMAND_LINE_COUNT("STRING"); ADD_TEXT_COMPONENT_SUBSTRING_PLAYER_NAME(text); return _END_TEXT_COMMAND_GET_LINE_COUNT(x, y); } ```
0x521FB041D93DD0E4 - HUDvoid
_BEGIN_TEXT_COMMAND_OBJECTIVE
Description not yet documented
0x23D69E0465570028 - HUDvoid
BEGIN_TEXT_COMMAND_OVERRIDE_BUTTON_TEXT
Description not yet documented
0x8F9EE5687F8EECCD - HUDvoid
BEGIN_TEXT_COMMAND_PRINT
``` Used to be known as _SET_TEXT_ENTRY_2 void ShowSubtitle(char *text) { BEGIN_TEXT_COMMAND_PRINT("STRING"); ADD_TEXT_COMPONENT_SUBSTRING_PLAYER_NAME(text); END_TEXT_COMMAND_PRINT(2000, 1); } ```
0xB87A37EEB7FAA67D - HUDvoid
BEGIN_TEXT_COMMAND_SET_BLIP_NAME
Starts a text command to change the name of a blip displayed in the pause menu. This should be paired with [`END_TEXT_COMMAND_SET_BLIP_NAME`](#\_0xBC38B49BCB83BC9B), once adding all required text components.
0xF9113A30DE5C6670 - HUDvoid
BEGIN_TEXT_COMMAND_THEFEED_POST
Declares the entry type of a notification, for example "STRING". int ShowNotification(char \*text) { BEGIN_TEXT_COMMAND_THEFEED_POST("STRING"); ADD_TEXT_COMPONENT_SUBSTRING_PLAYER_NAME(text); return \_DRAW_NOTIFICATION(1, 1); }
0x202709F4C58A0424
A living reference. Documentation coverage varies by native and source.