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
- PLAYERBOOL
CAN_PLAYER_START_MISSION
Description not yet documented
0xDE7465A27D403C06 - PLAYERvoid
CHANGE_PLAYER_PED
Description not yet documented
0x048189FAC643DEEE - PLAYERvoid
CLEAR_PLAYER_HAS_DAMAGED_AT_LEAST_ONE_NON_ANIMAL_PED
Description not yet documented
0x4AACB96203D11A31 - PLAYERvoid
CLEAR_PLAYER_HAS_DAMAGED_AT_LEAST_ONE_PED
Description not yet documented
0xF0B67A4DE6AB5F98 - PLAYERvoid
CLEAR_PLAYER_PARACHUTE_MODEL_OVERRIDE
Description not yet documented
0x8753997EB5F6EE3F - PLAYERvoid
CLEAR_PLAYER_PARACHUTE_PACK_MODEL_OVERRIDE
Description not yet documented
0x10C54E4389C12B42 - PLAYERvoid
CLEAR_PLAYER_PARACHUTE_VARIATION_OVERRIDE
Description not yet documented
0x0F4CC924CF8C7B21 - PLAYERvoid
_CLEAR_PLAYER_RESERVE_PARACHUTE_MODEL_OVERRIDE
``` NativeDB Introduced: v2372 ```
0x290D248E25815AE8 - PLAYERvoid
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. ```
0xB302540597885499 - PLAYERvoid
DISABLE_PLAYER_FIRING
Inhibits the player from using any method of combat including melee and firearms.\ NOTE: Only disables the firing for one frame
0x5E6CC07646BBEAB8 - PLAYERvoid
DISABLE_PLAYER_VEHICLE_REWARDS
Disables vehicle rewards for the current frame.
0xC142BE3BB9CE125F - PLAYERvoid
DISPLAY_SYSTEM_SIGNIN_UI
``` Purpose of the BOOL currently unknown. Both, true and false, work ```
0x94DD7888C10A979E - PLAYERvoid
ENABLE_SPECIAL_ABILITY
``` NativeDB Added Parameter 3: Any p2 ```
0x181EC197DAEFE121 - PLAYERvoid
EXTEND_WORLD_BOUNDARY_FOR_PLAYER
``` Appears only 3 times in the scripts, more specifically in michael1.ysc - This can be used to prevent dying if you are "out of the world" ```
0x5006D96C995A5827 - PLAYERvoid
FORCE_CLEANUP
``` used with 1,2,8,64,128 in the scripts ```
0xBC8983F38F78ED51 - PLAYERvoid
FORCE_CLEANUP_FOR_ALL_THREADS_WITH_THIS_NAME
``` PLAYER::FORCE_CLEANUP_FOR_ALL_THREADS_WITH_THIS_NAME("pb_prostitute", 1); // Found in decompilation ```
0x4C68DDDDF0097317 - PLAYERvoid
FORCE_CLEANUP_FOR_THREAD_WITH_THIS_ID
Description not yet documented
0xF745B37630DF176B - PLAYERint
_GET_ACHIEVEMENT_PROGRESS
``` For Steam. Always returns 0 in retail version of the game. ```
0x1C186837D0619335 - PLAYERBOOL
GET_ARE_CAMERA_CONTROLS_DISABLED
Description not yet documented
0x7C814D2FB49F40C0 - PLAYERint
GET_CAUSE_OF_MOST_RECENT_FORCE_CLEANUP
Description not yet documented
0x9A41CF4674A12272 - PLAYERBOOL
GET_ENTITY_PLAYER_IS_FREE_AIMING_AT
``` Returns TRUE if it found an entity in your crosshair within range of your weapon. Assigns the handle of the target to the *entity that you pass it. Returns false if no entity found. ```
0x2975C866E6713290 - PLAYERBOOL
GET_IS_PLAYER_DRIVING_ON_HIGHWAY
Description not yet documented
0x5FC472C501CCADB3 - PLAYERint
GET_MAX_WANTED_LEVEL
``` Gets the maximum wanted level the player can get. Ranges from 0 to 5. ```
0x462E0DB9B137DC5F - PLAYERint
GET_NUMBER_OF_PLAYERS
``` Gets the number of players in the current session. If not multiplayer, always returns 1. ```
0x407C7F91DDB46C16 - PLAYERint
_GET_NUMBER_OF_PLAYERS_IN_TEAM
``` NativeDB Introduced: v1180 ```
0x1FC200409F10E6F1 - PLAYERfloat
GET_PLAYER_CURRENT_STEALTH_NOISE
Description not yet documented
0x2F395D61F3A1F877 - PLAYERint
GET_PLAYER_FAKE_WANTED_LEVEL
Description not yet documented
0x56105E599CAB0EFA - PLAYERint
GET_PLAYER_GROUP
``` Returns the group ID the player is member of. ```
0x0D127585F77030AF - PLAYERBOOL
GET_PLAYER_HAS_RESERVE_PARACHUTE
Description not yet documented
0x5DDFE2FF727F3CA3 - PLAYERfloat
_GET_PLAYER_HEALTH_RECHARGE_LIMIT
Description not yet documented
0x8BC515BAE4AAF8FF - PLAYERPlayer
GET_PLAYER_INDEX
``` Returns the same as PLAYER_ID and NETWORK_PLAYER_ID_TO_INT ```
0xA5EDC40EF369B48D - PLAYERBOOL
GET_PLAYER_INVINCIBLE
This native will only return true if a player was made invincible with [`SET_PLAYER_INVINCIBLE`](#\_0x239528EACDC3E7DE). You should use [`GET_PLAYER_INVINCIBLE_2`](#\_0xF2E3912B) to get both [`SET_PLAYER_INVINCIBLE`](#\_0x239528EACDC3E7DE) and [`SET_PLAYER_INVINCIBLE_KEEP_RAGDOLL_ENABLED`](#\_0x6BC97F4F4BB3C04B) invincibility state.
0xB721981B2B939E07 - PLAYERint
GET_PLAYER_MAX_ARMOUR
Description not yet documented
0x92659B4CE1863CB3 - PLAYERchar*
GET_PLAYER_NAME
Returns the players name from a specified player index
0x6D0DE6A7B5DA71F8 - PLAYERHash
_GET_PLAYER_PARACHUTE_MODEL_OVERRIDE
``` NativeDB Introduced: v2372 ```
0xC219887CA3E65C41 - PLAYERvoid
GET_PLAYER_PARACHUTE_PACK_TINT_INDEX
Description not yet documented
0x6E9C742F340CE5A2 - PLAYERvoid
GET_PLAYER_PARACHUTE_SMOKE_TRAIL_COLOR
Description not yet documented
0xEF56DBABD3CD4887 - PLAYERvoid
GET_PLAYER_PARACHUTE_TINT_INDEX
``` Tints: None = -1, Rainbow = 0, Red = 1, SeasideStripes = 2, WidowMaker = 3, Patriot = 4, Blue = 5, Black = 6, Hornet = 7, AirFocce = 8, Desert = 9, Shadow = 10, HighAltitude = 11, Airbone = 12, Sunrise = 13, ```
0x75D3F7A1B0D9B145 - PLAYERPed
GET_PLAYER_PED
Gets the ped for a specified player index. Note: For performance reasons, usage of [`PLAYER_PED_ID`](#\_0xD80958FC74E988A6) is recommended over the use of `GetPlayerPed(-1)` when wanting to acquire your local player ped. For more information, please refer to [this](https://forum.cfx.re/t/question-difference-between-getplayerped-1-and-playerpedid/539437/2) forum post.
0x43A66C31C68491C0 - PLAYERPed
GET_PLAYER_PED_SCRIPT_INDEX
``` Does the same like PLAYER::GET_PLAYER_PED ```
0x50FAC3A3E030A6E1
A living reference. Documentation coverage varies by native and source.