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
- CFXvoid
ACTIVATE_TIMECYCLE_EDITOR
Activates built-in timecycle editing tool.
0xEEB9B76A - CFXvoid
ADD_AUDIO_SUBMIX_OUTPUT
Adds an output for the specified audio submix.
0xAC6E290D - CFXvoid
ADD_AUTHORIZED_PARACHUTE_MODEL
Adds the given model name hash to the list of valid models for the player ped's parachute.
0x8AC7AE9 - CFXvoid
ADD_AUTHORIZED_PARACHUTE_PACK_MODEL
Adds the given model name hash to the list of valid models for the player ped's parachute pack.
0x2E86DEA5 - CFXBlip
_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. Example image:   (Native name is *likely* to actually be ADD_BLIP_FOR_AREA, but due to the usual reasons this can't be confirmed) **This is the server-side RPC native equivalent of the client native [\_ADD_BLIP_FOR_AREA](?\_0xCE5D0E5E315DB238).**
0x6228F159 - CFXBlip
ADD_BLIP_FOR_COORD
Creates a blip for the specified coordinates. You can use `SET_BLIP_` natives to change the blip. **This is the server-side RPC native equivalent of the client native [ADD_BLIP_FOR_COORD](?\_0x5A039BB0BCA604B6).**
0xC6F43D0E - CFXBlip
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:  **This is the server-side RPC native equivalent of the client native [ADD_BLIP_FOR_ENTITY](?\_0x5CDE92C702A8FCE7).**
0x30822554 - CFXBlip
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:  **This is the server-side RPC native equivalent of the client native [ADD_BLIP_FOR_RADIUS](?\_0x46818D79B1F7499A).**
0x4626756C - CFXint
ADD_CONVAR_CHANGE_LISTENER
Adds a listener for Console Variable changes. The function called expects to match the following signature: ```ts function ConVarChangeListener(conVarName: string, reserved: any); ``` * **conVarName**: The ConVar that changed. * **reserved**: Currently unused.
0xAB7F7241 - CFXvoid
ADD_HEALTH_CONFIG
Adds new health config.
0x9CBFD5C1 - CFXint
ADD_MINIMAP_OVERLAY
Loads a minimap overlay from a GFx file in the current resource. If you need to control the depth of overlay use [`ADD_MINIMAP_OVERLAY_WITH_DEPTH`](#\_0xED0935B5).
0x4AFD2499 - CFXint
ADD_MINIMAP_OVERLAY_WITH_DEPTH
Loads a minimap overlay from a GFx file in the current resource.
0xED0935B5 - CFXvoid
ADD_PED_DECORATION_FROM_HASHES
``` Applies an Item from a PedDecorationCollection to a ped. These include tattoos and shirt decals. collection - PedDecorationCollection filename hash overlay - Item name hash Example: Entry inside "mpbeach_overlays.xml" - <Item> <uvPos x="0.500000" y="0.500000" /> <scale x="0.600000" y="0.500000" /> <rotation value="0.000000" /> <nameHash>FM_Hair_Fuzz</nameHash> <txdHash>mp_hair_fuzz</txdHash> <txtHash>mp_hair_fuzz</txtHash> <zone>ZONE_HEAD</zone> <type>TYPE_TATTOO</type> <faction>FM</faction> <garment>All</garment> <gender>GENDER_DONTCARE</gender> <award /> <awardLevel /> </Item> Code: PED::_0x5F5D1665E352A839(PLAYER::PLAYER_PED_ID(), MISC::GET_HASH_KEY("mpbeach_overlays"), MISC::GET_HASH_KEY("fm_hair_fuzz")) ``` **This is the server-side RPC native equivalent of the client native [ADD_PED_DECORATION_FROM_HASHES](?\_0x5F5D1665E352A839).**
0x70559AC7 - CFXvoid
ADD_REPLACE_TEXTURE
Experimental natives, please do not use in a live environment.
0xA66F8F75 - CFXint
ADD_STATE_BAG_CHANGE_HANDLER
Adds a handler for changes to a state bag. The function called expects to match the following signature: ```ts function StateBagChangeHandler(bagName: string, key: string, value: any, reserved: number, replicated: boolean); ``` * **bagName**: The internal bag ID for the state bag which changed. This is usually `player:Source`, `entity:NetID` or `localEntity:Handle`. * **key**: The changed key. * **value**: The new value stored at key. The old value is still stored in the state bag at the time this callback executes. * **reserved**: Currently unused. * **replicated**: Whether the set is meant to be replicated. At this time, the change handler can't opt to reject changes. If bagName refers to an entity, use [GET_ENTITY_FROM_STATE_BAG_NAME](#\_0x4BDF1867) to get the entity handle If bagName refers to a player, use [GET_PLAYER_FROM_STATE_BAG_NAME](#\_0xA56135E0) to get the player handle
0x5BA35AAF - CFXvoid
ADD_TEXT_ENTRY
Description not yet documented
0x32CA01C3 - CFXvoid
ADD_TEXT_ENTRY_BY_HASH
Description not yet documented
0x289DA860 - CFXvoid
APPLY_FORCE_TO_ENTITY
```cpp enum eApplyForceTypes { APPLY_TYPE_FORCE = 0, APPLY_TYPE_IMPULSE = 1, APPLY_TYPE_EXTERNAL_FORCE = 2, APPLY_TYPE_EXTERNAL_IMPULSE = 3, APPLY_TYPE_TORQUE = 4, APPLY_TYPE_ANGULAR_IMPULSE = 5 } ``` **This is the server-side RPC native equivalent of the client native [APPLY_FORCE_TO_ENTITY](?\_0xC5F68BE9613E2D18).**
0xC1C0855A - CFXBOOL
APPLY_WEATHER_CYCLES
Description not yet documented
0x3422291C - CFXvoid
BREAK_OFF_VEHICLE_WHEEL
Break off vehicle wheel by index. The `leaveDebrisTrail` flag requires `putOnFire` to be true.
0xA274CADB - CFXBOOL
CALL_MINIMAP_SCALEFORM_FUNCTION
This is similar to the PushScaleformMovieFunction natives, except it calls in the `TIMELINE` of a minimap overlay.
0x4C89C0ED - CFXvoid
CANCEL_EVENT
Cancels the currently executing event.
0xFA29D35D - CFXBOOL
CAN_PLAYER_START_COMMERCE_SESSION
Returns whether or not the specified player has enough information to start a commerce session for.
0x429461C3 - CFXvoid
CLEAR_DRAW_ORIGIN
Resets the screen's draw-origin which was changed by the function [`SET_DRAW_ORIGIN`](#\_0xE10198D5) back to `x=0, y=0`. See [`SET_DRAW_ORIGIN`](#\_0xE10198D5) for further information.
0xDD76B263 - CFXvoid
CLEAR_PED_PROP
CLEAR_PED_PROP **This is the server-side RPC native equivalent of the client native [CLEAR_PED_PROP](?\_0x0943E5B8E078E76E).**
0x2D23D743 - CFXvoid
CLEAR_PED_SECONDARY_TASK
CLEAR_PED_SECONDARY_TASK **This is the server-side RPC native equivalent of the client native [CLEAR_PED_SECONDARY_TASK](?\_0x176CECF6F920D707).**
0xA635F451 - CFXvoid
CLEAR_PED_TASKS
Clear a ped's tasks. Stop animations and other tasks created by scripts. **This is the server-side RPC native equivalent of the client native [CLEAR_PED_TASKS](?\_0xE1EF3C1216AFF2CD).**
0xDE3316AB - CFXvoid
CLEAR_PED_TASKS_IMMEDIATELY
Immediately stops the pedestrian from whatever it's doing. The difference between this and [CLEAR_PED_TASKS](#\_0xE1EF3C1216AFF2CD) is that this one teleports the ped but does not change the position of the ped. **This is the server-side RPC native equivalent of the client native [CLEAR_PED_TASKS_IMMEDIATELY](?\_0xAAA34F8A7CB32098).**
0xBC045625 - CFXvoid
CLEAR_PLAYER_WANTED_LEVEL
``` This executes at the same as speed as PLAYER::SET_PLAYER_WANTED_LEVEL(player, 0, false); PLAYER::GET_PLAYER_WANTED_LEVEL(player); executes in less than half the time. Which means that it's worth first checking if the wanted level needs to be cleared before clearing. However, this is mostly about good code practice and can important in other situations. The difference in time in this example is negligible. ``` **This is the server-side RPC native equivalent of the client native [CLEAR_PLAYER_WANTED_LEVEL](?\_0xB302540597885499).**
0x54EA5BCC - CFXvoid
CLEAR_VEHICLE_XENON_LIGHTS_CUSTOM_COLOR
Removes vehicle xenon lights custom RGB color.
0x2867ED8C - CFXint
CLONE_TIMECYCLE_MODIFIER
Description not yet documented
0x54D636B3 - CFXvoid
COMMIT_RUNTIME_TEXTURE
Commits the backing pixels to the specified runtime texture.
0x19D81F4E - CFXint
CREATE_AUDIO_SUBMIX
Creates an audio submix with the specified name, or gets the existing audio submix by that name.
0x658D2BC8 - CFXint
CREATE_DRY_VOLUME
Creates a volume where water effects do not apply. Useful for preventing water collisions from flooding areas underneath them. This has no effect on waterquads, only water created from drawables and collisions. Don't create volumes when your local ped is swimming (e.g. use IS_PED_SWIMMING in your scripts before you call this)
0xEB1C6DD - CFXlong
CREATE_DUI
Creates a DUI browser. This can be used to draw on a runtime texture using CREATE_RUNTIME_TEXTURE_FROM_DUI_HANDLE.
0x23EAF899 - CFXEntity
CREATE_OBJECT
Creates an object (prop) with the specified model at the specified position, offset on the Z axis by the radius of the object's model. This object will initially be owned by the creating script as a mission entity, and the model should be loaded already (e.g. using REQUEST_MODEL). **This is the server-side RPC native equivalent of the client native [CREATE_OBJECT](?\_0x509D5878EB39E842).**
0x2F7AA05C - CFXEntity
CREATE_OBJECT_NO_OFFSET
Creates an object (prop) with the specified model centered at the specified position. This object will initially be owned by the creating script as a mission entity, and the model should be loaded already (e.g. using REQUEST_MODEL). **This is the server-side RPC native equivalent of the client native [CREATE_OBJECT_NO_OFFSET](?\_0x9A294B2138ABB884).**
0x58040420 - CFXEntity
CREATE_PED
Creates a ped (biped character, pedestrian, actor) with the specified model at the specified position and heading. This ped will initially be owned by the creating script as a mission entity, and the model should be loaded already (e.g. using REQUEST_MODEL). **This is the server-side RPC native equivalent of the client native [CREATE_PED](?\_0xD49F9B0955C367DE).**
0x389EF71 - CFXEntity
CREATE_PED_INSIDE_VEHICLE
CREATE_PED_INSIDE_VEHICLE **This is the server-side RPC native equivalent of the client native [CREATE_PED_INSIDE_VEHICLE](?\_0x7DD959874C1FD534).**
0x3000F092 - CFXlong
CREATE_RUNTIME_TEXTURE
Creates a blank runtime texture.
0xFEC3766D
A living reference. Documentation coverage varies by native and source.