FiveM Native Reference

https://docs.fivem.net/natives/
Admin
FiveM Native Reference is comprehensive documentation for all native functions available in FiveM, a...
Tokens:1,692,549
Snippets:11,930
Trust Score:9.9
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Lua example: list started resources

Source: https://docs.fivem.net/natives?_0x387246B7=

Lua example that iterates over all resources, collects the names of started resources, and prints them.

```lua
local resourceList = {}
for i = 0, GetNumResources(), 1 do
  local resource_name = GetResourceByFindIndex(i)
  if resource_name and GetResourceState(resource_name) == "started" then
    table.insert(resourceList, resource_name)
  end
end
print(table.unpack(resourceList))
```

--------------------------------

### C# example of START_PARTICLE_FX_NON_LOOPED_ON_ENTITY

Source: https://docs.fivem.net/natives?_0x0D53A3B8DA0809D2=

C# example using the native to start a particle effect on the player. It first requests the asset and sets it as the next call, then starts the effect with the specified parameters.

```csharp
Function.Call(Hash.REQUEST_NAMED_PTFX_ASSET, "scr_rcbarry2");                     Function.Call(Hash._SET_PTFX_ASSET_NEXT_CALL, "scr_rcbarry2");                             Function.Call(Hash.START_PARTICLE_FX_NON_LOOPED_ON_ENTITY, "scr_clown_appears", Game.Player.Character, 0.0, 0.0, -0.5, 0.0, 0.0, 0.0, 1.0, false, false, false);
```

--------------------------------

### NEW_LOAD_SCENE_START Lua example

Source: https://docs.fivem.net/natives?_0x212A8D0D2BABFAC2=

Lua example that starts a new load scene, waits for it to load, then stops it and sets focus. Uses a helper function to compute direction from a vector.

```lua
function func_8(vParam0)
    return (-(Sin(vParam0.z)) * Cos(vParam0.x)), (Cos(vParam0.z) * Cos(vParam0.x)), Sin(vParam0.x)
end

Citizen.CreateThread(function()
    local vLocal_43 = vector3(1691.228, 3251.785, 44.2574)
    local vLocal_44 = vector3(2.5652, 0, -4.1481)

    if NewLoadSceneStart(vLocal_43.x, vLocal_43.y, vLocal_43.z, func_8(vLocal_44), 4500.0, 0)) then
          SetPlayerControl(PlayerId(), false, 0)
          local gameTimer = GetGameTimer()

          while not IsNewLoadSceneLoaded() and (GetGameTimer() - gameTimer < 20) do
              Citizen.Wait(0)
          end

          NewLoadSceneStop()
          SetFocusPosAndVel(vLocal_43.x, vLocal_43.y, vLocal_43.z, func_8(vLocal_44))
    end
end)
```

--------------------------------

### Lua example: custom GPS multi-route

Source: https://docs.fivem.net/natives?_0x3D3D15AF7BCAAF83=

Lua example demonstrating how to clear an existing route, start a new multi-route, add waypoints, and render it.

```lua
-- Clear any old route first
ClearGpsMultiRoute()

-- Start a new route
StartGpsMultiRoute(6, false, true)

-- Add the points
AddPointToGpsMultiRoute(1638.2155761719, -2344.685546875, 95.610511779785)
AddPointToGpsMultiRoute(1653.0858154297, -2068.8654785156, 96.737915039063)
AddPointToGpsMultiRoute(1451.9561767578, -2113.5344238281, 56.082130432129)
AddPointToGpsMultiRoute(1540.6088867188, -2514.4519042969, 58.842422485352)
AddPointToGpsMultiRoute(1638.2155761719, -2344.685546875, 95.610511779785)

-- Set the route to render
SetGpsMultiRouteRender(true)
```

--------------------------------

### Lua example: start and stop a train with SET_TRAIN_CRUISE_SPEED

Source: https://docs.fivem.net/natives?_0x16469284DB8C62B5=

Lua example that creates a mission train and uses SET_TRAIN_CRUISE_SPEED to start and stop it. Setting speed to 20.0 starts the train, setting to 0.0 stops it.

```lua
local train = CreateMissionTrain(21, 40.2, -1201.3, 31.0, false)
SetTrainCruiseSpeed(train, 20.0) -- Can be used to 'start' the train
SetTrainCruiseSpeed(train, 0.0) -- Can be used to 'stop' the train
```

--------------------------------

### Lua example: Start a GPS custom route

Source: https://docs.fivem.net/natives?_0xDB34E8D56FC13B08=

Lua example that clears any old route, starts a new route with hudColor 6, displayOnFoot false, followPlayer true, adds five points, and renders the route with SetGpsCustomRouteRender(true, 16, 16).

```lua
-- Clear any old route first
ClearGpsCustomRoute()

-- Start a new route
StartGpsCustomRoute(6, false, true)

-- Add the points
AddPointToGpsCustomRoute(1638.2155761719, -2344.685546875, 95.610511779785)
AddPointToGpsCustomRoute(1653.0858154297, -2068.8654785156, 96.737915039063)
AddPointToGpsCustomRoute(1451.9561767578, -2113.5344238281, 56.082130432129)
AddPointToGpsCustomRoute(1540.6088867188, -2514.4519042969, 58.842422485352)
AddPointToGpsCustomRoute(1638.2155761719, -2344.685546875, 95.610511779785)

-- Set the route to render
SetGpsCustomRouteRender(true, 16, 16)
```

--------------------------------

### Lua example using SET_INTERIOR_PORTAL_ROOM_FROM

Source: https://docs.fivem.net/natives?_0x298FC783=

Lua example that gets the player's current interior, sets the room from for portal index 0 to 0, and refreshes the interior. The example checks that interiorId is not 0 before calling the native.

```lua
local playerPed = PlayerPedId()
local interiorId = GetInteriorFromEntity(playerPed)

if interiorId ~= 0 then
  local portalIndex = 0

  SetInteriorPortalRoomFrom(interiorId, portalIndex, 0)
  RefreshInterior(interiorId)
end
```

--------------------------------

### Lua example for SWITCH_TO_MULTI_SECONDPART

Source: https://docs.fivem.net/natives?_0xD8295AF639FD9CB8=

Lua example for FiveM that registers a command 'switchPlayer'. It checks if a player switch is in progress, gets the player ped, calls SwitchToMultiFirstPart, waits 5 seconds, then calls SwitchToMultiSecondPart to smoothly return the camera.

```lua
RegisterCommand("switchPlayer", function()
    if IsPlayerSwitchInProgress() then return end
    local ped = PlayerPedId()
    SwitchToMultiFirstPart(ped, 0, 1)
    Citizen.Wait(5000)
    SwitchToMultiSecondPart(ped)
end, false)
```

--------------------------------

### Lua example for GET_NO_LOADING_SCREEN

Source: https://docs.fivem.net/natives?_0x18C1270EA7F199BC=

Lua example showing how to set and get the no-loading-screen flag. The print statement will output true after setting it.

```lua
SetNoLoadingScreen(true)
print(GetNoLoadingScreen()) -- will return true
```

--------------------------------

### Lua example using SIN native

Source: https://docs.fivem.net/natives?_0x0BADBFA3B172435F=

Lua example that gets the heading of the player ped, computes the sine using the SIN native, and shows the equivalent using math.sin with degree-to-radian conversion.

```lua
-- Get the heading
local heading = GetEntityHeading(PlayerPedId())
local sin = Sin(heading)

-- equivalent in lua
local sinLua = math.sin(heading * (math.pi / 180))
```

--------------------------------

### Lua example for START_NETWORKED_PARTICLE_FX_NON_LOOPED_AT_COORD

Source: https://docs.fivem.net/natives?_0xF56B8137DF10135D=

Lua example showing how to load a particle effect asset, set its color, and start a networked non-looped particle effect at the player's coordinates. It includes cleanup with RemoveNamedPtfxAsset.

```lua
-- If the PtfxAsset hasn't been loaded yet, you'll need to load it first
if not HasNamedPtfxAssetLoaded("scr_indep_fireworks") then
	RequestNamedPtfxAsset("scr_indep_fireworks")
	while not HasNamedPtfxAssetLoaded("scr_indep_fireworks") do
		Wait(10)
	end
end

local CurrentPlayerCoords = GetEntityCoords(GetPlayerPed(-1))

UseParticleFxAssetNextCall("scr_indep_fireworks") -- Prepare the Particle FX for the next upcomming Particle FX call
SetParticleFxNonLoopedColour(1.0, 0.0, 0.0) -- Setting the color to Red (R, G, B)
StartNetworkedParticleFxNonLoopedAtCoord("scr_indep_firework_burst_spawn", CurrentPlayerCoords, 0.0, 0.0, 0.0, 1.0, false, false, false, false) -- Start the animation itself

RemoveNamedPtfxAsset("scr_indep_fireworks") -- Clean up
```

--------------------------------

### Lua example for _ARE_BOMB_BAY_DOORS_OPEN

Source: https://docs.fivem.net/natives?_0xD0917A423314BBA8=

Lua example that gets the player's current vehicle and prints whether the bomb bay doors are open or closed using AreBombBayDoorsOpen.

```lua
local vehicle = GetVehiclePedIsIn(PlayerPedId(), false)

if AreBombBayDoorsOpen(vehicle) then
    print("The doors are open!")
else
    print("The doors are closed!")
end

```

--------------------------------

### Lua example for SET_BOAT_ANCHOR

Source: https://docs.fivem.net/natives?_0x75DBEC174AEEAD10=

Lua example that gets the player's boat, checks if it can anchor, deploys the anchor, waits 10 seconds, then raises it. Prints a message if anchoring is not possible.

```lua
local boat = GetVehiclePedIsIn(PlayerPedId(), false)
if not boat or not IsThisModelABoat(GetEntityModel(boat)) then return end

-- Check if we can anchor the boat here
if CanAnchorBoatHere(boat) then
    -- Deploy the boat's anchor
    SetBoatAnchor(boat, true)
    
    -- Wait for 10 seconds
    Wait(10000)
    
    -- Raise the boat's anchor
    SetBoatAnchor(boat, false)
else
    print("Cannot anchor the boat at this location")
end
```

--------------------------------

### Lua example: iterate train doors and print open ratio

Source: https://docs.fivem.net/natives?_0x40B16551=

Lua example that gets the train door count, iterates each door, retrieves the open ratio, and prints it.

```lua
local doorCount = GetTrainDoorCount(train)
for doorIndex = 0, doorCount - 1 do
    local ratio = GetTrainDoorOpenRatio(train, doorIndex)
    print("Door " .. tostring(doorIndex) .. " is open by a ratio of " .. tostring(ratio))
end
```

--------------------------------

### OpenSequenceTask Lua example

Source: https://docs.fivem.net/natives?_0xE8854A4326B9E12B=

Example Lua code demonstrating the proper sequence: open a task sequence, add tasks (walk to a bench and sit), close and perform the sequence, then clear it. Only works if CloseSequenceTask and ClearSequenceTask are called, otherwise the sequence system may get stuck until client restart.

```lua
Citizen.CreateThread(function()
    local animDict = 'timetable@ron@ig_5_p3'

    RequestAnimDict(animDict)
    while not HasAnimDictLoaded(animDict) do
        Wait(0)
    end

    local ped = PlayerPedId()
    local pos = GetEntityCoords(ped)

    -- you can change the model, but you might have to change the offsets below.
    local objModelHash = `prop_bench_01a`

    local obj = GetClosestObjectOfType(pos.x, pos.y, pos.z, 5.0, objModelHash, false, false, false)
    if obj == 0 then
        print("No valid object within range!")
        return
    end

    local tgtPos = GetOffsetFromEntityInWorldCoords(obj, 0.0, -0.7, 0.0)

    -- open the task sequence so we can get our sequence id
    local sequence = OpenSequenceTask()

    -- set our desired heading to be the same as the objects
    local desiredHeading = GetEntityHeading(obj) - 180.0

    -- go to the entities offset
    TaskGoStraightToCoord(nil, tgtPos.x, tgtPos.y, tgtPos.z, 1.0, 4000, desiredHeading, 1.0)

    -- sit on the bench indefinitely (you can change -1 here to however long you want to sit)
    TaskPlayAnim(nil, animDict, 'ig_5_p3_base', 8.0, 8.0, -1, 1)

    -- close the sequence so we can perform it
    CloseSequenceTask(sequence)

    -- perform the sequence, this will not work if the sequence is still open.
    TaskPerformSequence(ped, sequence)

    -- free the sequence slot so it can be re-used
    ClearSequenceTask(sequence)

    -- cleanup the animation dict so the engine can remove it when its no longer needed
    RemoveAnimDict(animDict)
end)
```

--------------------------------

### Lua example: Get aircraft bomb count

Source: https://docs.fivem.net/natives?_0xEA12BD130D7569A1=

Lua example that gets the vehicle the player is in and prints the remaining bomb count using GetAircraftBombCount (old name for _GET_VEHICLE_BOMB_COUNT).

```lua
local vehicle = GetVehiclePedIsIn(PlayerPedId(), false)
print("This plane has " .. GetAircraftBombCount(vehicle) .. " bombs left.")
```

--------------------------------

### SYSTEM::START_NEW_SCRIPT_WITH_ARGS

Source: https://docs.fivem.net/natives?_0xE81651AD79516E48=

Starts a new script with arguments.

```APIDOC
## START_NEW_SCRIPT_WITH_ARGS

### Description
Starts a new script with arguments.

### Method
NATIVE

### Endpoint
SYSTEM::START_NEW_SCRIPT_WITH_ARGS

### Parameters
- **scriptName** (char*) - Required - The name of the script to start.
- **args** (Any*) - Required - Pointer to an array of arguments.
- **argCount** (int) - Required - Number of arguments.
- **stackSize** (int) - Required - The stack size for the new script.

### Return Value
int - Returns a script thread ID.

### Example
```c
int scriptId = SYSTEM::START_NEW_SCRIPT_WITH_ARGS("myScript", args, argCount, 1024);
```
```

--------------------------------

### Lua example: iterate KVPs with StartFindKvp

Source: https://docs.fivem.net/natives?_0xDD379006=

Lua example for START_FIND_KVP: sets three resource KVPs with a common prefix, then iterates over them using FindKvp and prints each key-value pair. If no KVPs match, prints 'No KVPs found'. The handle must be closed with EndFindKvp.

```lua
SetResourceKvp('mollis:2', 'should be taken with alcohol')
SetResourceKvp('mollis:1', 'vesuvius citrate')
SetResourceKvp('mollis:manufacturer', 'Betta Pharmaceuticals')

local kvpHandle = StartFindKvp('mollis:')

if kvpHandle ~= -1 then 
	local key
	
	repeat
		key = FindKvp(kvpHandle)

		if key then
			print(('%s: %s'):format(key, GetResourceKvpString(key)))
		end
	until not key

	EndFindKvp(kvpHandle)
else
	print('No KVPs found')
end
```

--------------------------------

### GET_ENTITY_HEALTH Lua example

Source: https://docs.fivem.net/natives?_0xEEF059FAD016D209=

Lua example that gets the health of the player ped and prints it.

```lua
local health = GetEntityHealth(PlayerPedId())
print(health)
```

--------------------------------

### Lua example: using ADD_TEXT_COMPONENT_SUBSTRING_PLAYER_NAME

Source: https://docs.fivem.net/natives?_0x6C188BE134E074AA=

Lua example showing how to add a text entry with a ~a~ placeholder and then draw it using AddTextComponentSubstringPlayerName to replace the placeholder with a string.

```lua
-- on initialization
AddTextEntry('TEST_LABEL', 'Label: ~a~')

-- when drawing
BeginTextCommandDisplayText('TEST_LABEL')
AddTextComponentSubstringPlayerName('Hello, World!')
EndTextCommandDisplayText(0.5, 0.5)
```

--------------------------------

### Lua example: get player ped eye color

Source: https://docs.fivem.net/natives?_0x76BBA2CEE66D47E9=

Lua example that calls the native to get the player ped's eye color and prints a message if it equals 7 (gray eyes).

```lua
local pedEyeColour = N_0x76bba2cee66d47e9(PlayerPedId())
if pedEyeColour == 7 then
  print("Gray eyes!")
end
```

--------------------------------

### Lua example: check if vehicle is electric

Source: https://docs.fivem.net/natives?_0x1FCB07FE230B6639=

Lua example that checks if the vehicle the player is in is electric. It first gets the vehicle the ped is in, returns if not in a vehicle, then gets the model and calls GetIsVehicleElectric to print the result.

```lua
local veh = GetVehiclePedIsIn(PlayerPedId(), false)
-- GetVehiclePedIsIn will return 0 if the ped isn't currently in a vehicle
if veh == 0 then return end
local model = GetEntityModel(veh)
if GetIsVehicleElectric(model) then
    print("This vehicle is electric")
else
    print("This vehicle is not electric")
end
```

--------------------------------

### UI_STARTED_END_USER_BENCHMARK

Source: https://docs.fivem.net/natives?_0x04456F95153C6BE4=

Starts an end-user benchmark from the UI.

```APIDOC
## UI_STARTED_END_USER_BENCHMARK

### Description
Starts an end-user benchmark from the UI.

### Method
N/A

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
#### Success Response (200)
- **void** - No return value.

#### Response Example
N/A
```

--------------------------------

### Lua example for GET_CONVERTIBLE_ROOF_STATE

Source: https://docs.fivem.net/natives?_0xF8C397922FC03F41=

Lua example that gets the vehicle the player is in and prints its convertible roof state.

```lua
local vehicle = GetVehiclePedIsIn(PlayerPedId())
print(GetConvertibleRoofState(vehicle))
```

--------------------------------

### Lua example using TASK_FOLLOW_POINT_ROUTE

Source: https://docs.fivem.net/natives?_0x595583281858626E=

Lua example showing how to use TASK_FOLLOW_POINT_ROUTE with TASK_FLUSH_ROUTE and TASK_EXTEND_ROUTE to make the player follow a point route.

```lua
TaskFlushRoute()
TaskExtendRoute(0.0, 0.0, 70.0)
TaskExtendRoute(10.0, 0.0, 70.0)
TaskExtendRoute(10.0, 10.0, 70.0)
TaskFollowPointRoute(PlayerPedId(), 1.0, 0)
```

--------------------------------

### Lua example using RequestResourceFileSet

Source: https://docs.fivem.net/natives?_0xE7490533=

Lua example showing how to define a file set in fxmanifest.lua and use RequestResourceFileSet in a command. It prints file contents before and after requesting the set, waiting until the request completes.

```lua
-- fxmanifest.lua
file_set 'dummies' {
    'dummy/**.txt',
    'potato.txt',
}

-- main script
local function PrintTest()
    local tests = { 'potato.txt', 'dummy/1.txt', 'dummy/b/2.txt' }

    for _, v in ipairs(tests) do
        local data = LoadResourceFile(GetCurrentResourceName(), v)
        print(v, data)
    end
end

RegisterCommand('fileset', function()
    PrintTest()

    while not RequestResourceFileSet('dummies') do
        Wait(100)
    end

    PrintTest()
end)
```

--------------------------------

### Lua example for DOES_VEHICLE_HAVE_ROOF

Source: https://docs.fivem.net/natives?_0x8AC862B0B32C5B80=

Lua example that gets the vehicle the player is in and prints whether it has a roof using DoesVehicleHaveRoof.

```lua
local vehicle = GetVehiclePedIsIn(PlayerPedId(), false)
if DoesVehicleHaveRoof(vehicle) then
    print("This vehicle has a roof.")
else
    print("This vehicle does not have a roof.")
end
```

--------------------------------

### Lua example for END_TEXT_COMMAND_DISPLAY_HELP

Source: https://docs.fivem.net/natives?_0x238FFE5C7B0498A6=

Lua example showing how to display a help message with text formatting and a floating help text using FLOATING_HELP_TEXT_1. Requires AddTextEntry to define the text, and SetFloatingHelpTextWorldPosition/Style for the floating variant.

```lua
-- Help texts support text formatting, check out https://docs.fivem.net/docs/game-references/text-formatting/
AddTextEntry('HelpMsg', 'Press ~INPUT_CONTEXT~ to do something.')

BeginTextCommandDisplayHelp('HelpMsg')
EndTextCommandDisplayHelp(0, false, true, -1)

-- Shows a floating help text which uses FLOATING_HELP_TEXT_1 hud component.
AddTextEntry('FloatingHelpText', 'Press E to show respect.')
SetFloatingHelpTextWorldPosition(0, vector3(100, 100, 100))
SetFloatingHelpTextStyle(0, true, 2, -1, 3, 0)
BeginTextCommandDisplayHelp('FloatingHelpText')
EndTextCommandDisplayHelp(1, false, false, -1)
```

--------------------------------

### Lua example for SetAircraftBombCount

Source: https://docs.fivem.net/natives?_0xF4B2ED59DEB5D774=

Lua example that gets the vehicle the player is in and sets its bomb count to 10 using SetAircraftBombCount.

```lua
local vehicle = GetVehiclePedIsIn(PlayerPedId(), false)
SetAircraftBombCount(vehicle, 10)
```

--------------------------------

### GET_INTERIOR_POSITION Lua example

Source: https://docs.fivem.net/natives?_0x77A435B0=

Lua example that gets the player's current interior and prints its position if inside an interior.

```lua
local playerPed = PlayerPedId()
local interiorId = GetInteriorFromEntity(playerPed)

if interiorId ~= 0 then
  local x, y, z = GetInteriorPosition(interiorId)
  print("current interior " .. interiorId .. " position is: " .. vec(x, y, z))
end
```

--------------------------------

### Get interior portal count in Lua

Source: https://docs.fivem.net/natives?_0xD05BB8B1=

Lua example that gets the interior ID from the player ped and prints the portal count.

```lua
local playerPed = PlayerPedId()
local interiorId = GetInteriorFromEntity(playerPed)

if interiorId ~= 0 then
  local count = GetInteriorPortalCount(interiorId)
  print("interior " .. interiorId .. "has " .. count .. " portals")
end
```

--------------------------------

### C# example using TERRAINGRID_SET_PARAMS

Source: https://docs.fivem.net/natives?_0x1C4FC5752BCD8E48=

C# example showing how to use TERRAINGRID_SET_PARAMS together with TERRAINGRID_ACTIVATE and TERRAINGRID_SET_COLOURS. The example toggles the grid on, sets the grid parameters, and defines the colors for min, normal, and max heights.

```csharp
N_0xa356990e161c9e65(true); // toggle on/off

// this native configures the location, size, rotation, normal height, and the difference ratio between min, normal and max.
N_0x1c4fc5752bcd8e48(-1114.121f, 220.789f, 63.78f, -1f, 0.85f, 0f, 15f, 15f, -1f, 20f, 40f, 63.78f, 0.2f);

// This native defines the colors (and alpha/opacity levels) for min, normal and max heights.
// (in this case: red for lower, white for normal, yellow for higher)
N_0x5ce62918f8d703c7(255, 0, 0, 64, 255, 255, 255, 5, 255, 255, 0, 64);
```

--------------------------------

### TASK_START_SCENARIO_IN_PLACE

Source: https://docs.fivem.net/natives?_0x126EF75F1E17ABE5=

Starts a scenario in place with time to leave and intro clip options.

```APIDOC
## TASK_START_SCENARIO_IN_PLACE

### Description
Starts a scenario in place with time to leave and intro clip options.

### Method
N/A (Native Function)

### Endpoint
TASK_START_SCENARIO_IN_PLACE

### Parameters
- **ped** (Ped) - Required - The ped to start the scenario.
- **scenarioName** (char*) - Required - Scenario name.
- **timeToLeave** (int) - Required - Time to leave in milliseconds.
- **playIntroClip** (BOOL) - Required - Whether to play intro clip.

### Response
No return value documented.
```

--------------------------------

### Lua example for _GET_VEHICLE_COUNTERMEASURE_COUNT

Source: https://docs.fivem.net/natives?_0xF846AA63DF56B804=

Lua example for _GET_VEHICLE_COUNTERMEASURE_COUNT. Gets the vehicle the player is in and prints the number of countermeasures remaining using GetAircraftCountermeasureCount.

```lua
local vehicle = GetVehiclePedIsIn(PlayerPedId(), false)
print("This plane has " .. GetAircraftCountermeasureCount(vehicle) .. " countermeasures left.")
```

--------------------------------

### Lua example for IS_VEHICLE_SIREN_AUDIO_ON

Source: https://docs.fivem.net/natives?_0xB5CC40FBCB586380=

Lua example that gets the player's current vehicle and prints a message if the siren audio is playing.

```lua
local vehicle = GetVehiclePedIsIn(PlayerPedId(), false)

if IsVehicleSirenAudioOn(vehicle) then
    print("Siren is audible")
end
```

--------------------------------

### SIMULATE_PLAYER_INPUT_GAIT C# Examples

Source: https://docs.fivem.net/natives?_0x477D5D63E63ECA5D=

Two C# examples: one makes the player walk forward for 100ms, the other makes the player walk straight forward forever until hitting walls or obstacles. Both use Game.Player.Handle as the player parameter.

```csharp
SimulatePlayerInputGait(Game.Player.Handle, 1f, 100, 1f, 1, 0); //Player will go forward for 100ms
SimulatePlayerInputGait(Game.Player.Handle, 1f, -1, 0f, 1, 0); //Player will go straight forward forever, stop when facing walls or obstacles.
```

--------------------------------

### SHOW_START_MISSION_INSTRUCTIONAL_BUTTON

Source: https://docs.fivem.net/natives?_0xDC38CC1E35B6A5D7=

Documentation for the SHOW_START_MISSION_INSTRUCTIONAL_BUTTON native function.

```APIDOC
## SHOW_START_MISSION_INSTRUCTIONAL_BUTTON

### Description
Shows start mission instructional button.

### Method
NATIVE

### Endpoint
SHOW_START_MISSION_INSTRUCTIONAL_BUTTON

### Parameters
- **p0** (BOOL) - Required - Unknown parameter.

### Response
No return value.
```

--------------------------------

### Lua example: GetEntityRotation

Source: https://docs.fivem.net/natives?_0xAFBD61CC738D9EB9=

Lua example that gets the rotation of the player ped with rotation order 2 and prints the resulting vector.

```lua
local playerRotation = GetEntityRotation(PlayerPedId(), 2)
print(playerRotation)
```

--------------------------------

### Lua example for GET_PED_HAIR_COLOR

Source: https://docs.fivem.net/natives?_0xA3EA2893=

Lua example that gets the primary hair color of the player ped and prints a message if it equals 18.

```lua
local primaryColour = GetPedHairColor(PlayerPedId())
if primaryColour == 18 then
  print("You have red hair!")
end
```

--------------------------------

### START_RESOURCE

Source: https://docs.fivem.net/natives?_0x12A330=

Documentation for the START_RESOURCE native function.

```APIDOC
## START_RESOURCE

### Description
Starts a resource.

### Method
N/A (Native function)

### Endpoint
START_RESOURCE

### Parameters
- **resourceName** (char*) - Required - The resource name.
```

--------------------------------

### RAISE_CONVERTIBLE_ROOF Lua example

Source: https://docs.fivem.net/natives?_0x8F5FB35D7E88FC70=

Lua example that gets the player's vehicle, checks if it is a convertible, and raises the roof without animation.

```lua
local vehicle = GetVehiclePedIsIn(PlayerPedId(), false)
if not IsVehicleAConvertible(vehicle, false) then return end
RaiseConvertibleRoof(vehicle, false)
```

--------------------------------

### Lua Example: Display and Handle Onscreen Keyboard

Source: https://docs.fivem.net/natives?_0x00DC833F2568DBF6=

Lua example showing how to add a text entry, display the keyboard, wait for user input, and handle the result (OK, cancel, or error). Uses AddTextEntry, DisplayOnscreenKeyboard, UpdateOnscreenKeyboard, and GetOnscreenKeyboardResult.

```lua
AddTextEntry("my_input_title", "Enter something cool:")

DisplayOnscreenKeyboard(0, "my_input_title", "", "", "", "", "", 30) -- Show the text input box

while UpdateOnscreenKeyboard() == 0 do Wait(0) end -- Wait for the user to stop editing

-- This block of code is reached after the user is done editing

local inputUpdate = UpdateOnscreenKeyboard()

if inputUpdate == 1 then -- User hit OK in the text input box
  local result = GetOnscreenKeyboardResult()
  print("You wrote this in the input box:", result)
elseif inputUpdate == 2 then
  print("You canceled the input!")
else -- -1 or 3
  print("An error has occurred")
end
```

--------------------------------

### Lua example for SET_HELI_TAIL_BOOM_CAN_BREAK_OFF

Source: https://docs.fivem.net/natives?_0x3EC8BF18AA453FE9=

Lua example that gets the player's current helicopter and enables the tail boom break-off feature.

```lua
local heli = GetVehiclePedIsIn(PlayerPedId(), false)
if heli == 0 or GetVehicleType(heli) ~= "heli" then return end

SetHeliTailBoomCanBreakOff(heli, true)
```

--------------------------------

### Lua example: create and cleanup rope

Source: https://docs.fivem.net/natives?_0xE832D760399EB220=

Lua example showing how to load rope textures, create a rope with AddRope, wait, and delete it. Includes cleanup function and error handling if rope creation fails.

```lua
local function cleanup_rope_textures()
	-- we only want to cleanup if there are no other ropes still left on the map
	-- otherwise we'll make them go invisible.
	if #GetAllRopes() == 0 then
		-- there are no ropes on the map, we're safe to unload the textures.
		RopeUnloadTextures()
	end
end

CreateThread(function()
	-- if textures aren't loaded then we need to load them
	if not RopeAreTexturesLoaded() then
		-- load the textures so we can see the rope
		RopeLoadTextures()
		while not RopeAreTexturesLoaded() do
			Wait(0)
		end
	end

	-- Create a rope and store the handle
	local rope = AddRope(-2096.096, -311.906, 14.51, 0.0, 0.0, 0.0, 10.0, 1, 10.0, 0.0, 1.0, false, false, false, 1.0, false, 0)
	-- Check if the rope exists.
	if not DoesRopeExist(rope) then
		cleanup_rope_textures()
		-- If the rope does not exist, end the execution of the code here.
		return
	end
	-- Let the rope exist for 3 seconds
	Wait(3000)
	-- Delete the rope!
	DeleteRope(rope)
	cleanup_rope_textures()
end)
```

--------------------------------

### TASK_START_SCENARIO_IN_PLACE

Source: https://docs.fivem.net/natives?_0x7285951DBF6B5A51=

Starts a scenario in place with optional intro clip.

```APIDOC
## TASK_START_SCENARIO_IN_PLACE

### Description
Starts a scenario in place with optional intro clip.

### Parameters
- **ped** (Ped) - The ped to assign the task.
- **scenarioName** (char*) - Scenario name.
- **timeToLeave** (int) - Time to leave.
- **playIntroClip** (BOOL) - Whether to play intro clip.
```

--------------------------------

### _START_BENCHMARK_RECORDING

Source: https://docs.fivem.net/natives?_0x04456F95153C6BE4=

Starts recording a benchmark for performance testing.

```APIDOC
## _START_BENCHMARK_RECORDING

### Description
Starts recording a benchmark for performance testing.

### Method
N/A

### Endpoint
N/A

### Parameters
None

### Request Example
N/A

### Response
#### Success Response (200)
- **void** - No return value.

#### Response Example
N/A
```

--------------------------------

### TASK_START_SCENARIO_IN_PLACE

Source: https://docs.fivem.net/natives?_0x62D2916F56B9CD2D=

Documentation for the TASK_START_SCENARIO_IN_PLACE native function.

```APIDOC
## TASK_START_SCENARIO_IN_PLACE

### Description
Starts a scenario in place for a ped.

### Method
NATIVE

### Parameters
- **ped** (Ped) - Required - The ped.
- **scenarioName** (char*) - Required - Scenario name.
- **timeToLeave** (int) - Required - Time to leave in milliseconds.
- **playIntroClip** (BOOL) - Required - Whether to play intro clip.

### Response
No return value.
```

--------------------------------

### GET_TIMECYCLE_MODIFIER_NAME_BY_INDEX Lua example

Source: https://docs.fivem.net/natives?_0x28CB8608=

Lua example that retrieves the current timecycle modifier index, checks it is not -1, gets the modifier name, and prints it.

```lua
local modifierIndex = GetTimecycleModifierIndex()

if modifierIndex ~= -1 then
  local modifierName = GetTimecycleModifierNameByIndex(modifierIndex)
  print("current timecycle name is " .. modifierName)
end
```

--------------------------------

### Lua example: GetVehicleDriveTrainType usage

Source: https://docs.fivem.net/natives?_0x1423725069EE1D14=

Example Lua code that loads a vehicle model, gets its drivetrain type, and prints the corresponding label.

```lua
local vehicleHash = GetHashKey("elegy")
RequestModel(vehicleHash)
repeat
    Wait(0)
until HasModelLoaded(vehicleHash)

local driveTrainType = GetVehicleDriveTrainType(vehicleHash)

if driveTrainType == 1 then
    -- FWD
    print(GetLabelText("FMMC_DT_FWD"))
elseif driveTrainType == 2 then
    -- RWD
    print(GetLabelText("FMMC_DT_RWD"))
elseif driveTrainType == 3 then
    -- AWD
    print(GetLabelText("FMMC_DT_AWD"))
else
    print("invalid")
end
```

--------------------------------

### BEGIN_TEXT_COMMAND_DISPLAY_HELP

Source: https://docs.fivem.net/natives?_0x311438A071DD9B1A=

Documentation for the BEGIN_TEXT_COMMAND_DISPLAY_HELP native function.

```APIDOC
## BEGIN_TEXT_COMMAND_DISPLAY_HELP

### Description
Begins a text command to display help.

### Method
N/A (Native function)

### Endpoint
BEGIN_TEXT_COMMAND_DISPLAY_HELP

### Parameters
- **inputType** (char*) - Required - The input type.

### Response
No return value.
```

--------------------------------

### START_PLAYER_TELEPORT

Source: https://docs.fivem.net/natives?_0x020E5F00CDA207BA=

Documentation for the START_PLAYER_TELEPORT native function.

```APIDOC
## START_PLAYER_TELEPORT

### Description
Starts teleporting the player to the specified coordinates.

### Method
N/A

### Endpoint
N/A

### Parameters
- **player** (Player) - Required - The player index.
- **x** (float) - Required - X coordinate.
- **y** (float) - Required - Y coordinate.
- **z** (float) - Required - Z coordinate.
- **heading** (float) - Required - Heading.
- **teleportWithVehicle** (BOOL) - Required - Whether to teleport with vehicle.
- **findCollisionLand** (BOOL) - Required - Whether to find collision land.
- **p7** (BOOL) - Required - Unknown parameter.

### Request Example
N/A

### Response
N/A
```

--------------------------------

### Lua example for GetWaterQuadAtCoords

Source: https://docs.fivem.net/natives?_0xF8E03DB8=

Lua example that gets the water quad index at the player's current position using GetWaterQuadAtCoords. Note that this example uses the 2D variant, not the 3D one documented above.

```lua
local currentPedPosition = GetEntityCoords(PlayerPedId())
local waterQuadIndex = GetWaterQuadAtCoords(currentPedPosition.x, currentPedPosition.y, currentPedPosition.z)
```

--------------------------------

### Lua example using GetScriptTaskStatus

Source: https://docs.fivem.net/natives?_0x77F1BEB8863288D5=

Lua example that starts a task and polls its status with GetScriptTaskStatus, printing the status and breaking when it returns 7 (finished).

```lua
local playerPed = PlayerPedId()
local coords = GetOffsetFromEntityInWorldCoords(playerPed, 0.0, 6.0, 0.0)
TaskGoStraightToCoord(playerPed, coords, 1.0, 5000, GetEntityHeading(playerPed), 0.15)

Citizen.CreateThread(function()
    while true do
        local taskStatus = GetScriptTaskStatus(PlayerPedId(), "SCRIPT_TASK_GO_STRAIGHT_TO_COORD")
        print(taskStatus)
        if taskStatus == 7 then print("task was finished!"); break end
        Citizen.Wait(250)
    end
end)
```

--------------------------------

### START_NEW_SCRIPT_WITH_ARGS

Source: https://docs.fivem.net/natives?_0x652D2EEEF1D3E62C=

Starts a new script with arguments and a specified stack size.

```APIDOC
## START_NEW_SCRIPT_WITH_ARGS

### Description
Starts a new script with arguments and a specified stack size.

### Method
N/A

### Endpoint
N/A

### Parameters
- **scriptName** (char*) - Required - The name of the script to start.
- **args** (Any*) - Required - Pointer to an array of arguments.
- **argCount** (int) - Required - Number of arguments.
- **stackSize** (int) - Required - The stack size for the new script.

### Request Example
N/A

### Response
#### Success Response
- **return** (int) - The script thread ID.

#### Response Example
N/A
```

--------------------------------

### GET_FILENAME_FOR_AUDIO_CONVERSATION Lua example

Source: https://docs.fivem.net/natives?_0x7B5280EBA9840C72=

Lua example showing how to get the audio conversation filename for the player's current vehicle model display name.

```lua
-- Get the vehicle in which the player is currently seated
local vehicle = GetVehiclePedIsIn(PlayerPedId(), false)

-- Get the model of the vehicle
local model = GetEntityModel(vehicle)

-- Get the display name of the vehicle model
local displayName = GetDisplayNameFromVehicleModel(model)

-- Get the label text for the audio conversation associated with the display name
local label = GetFilenameForAudioConversation(displayName)

-- Print the label text
print(label)
```

--------------------------------

### Lua example for checking help message display

Source: https://docs.fivem.net/natives?_0x0A24DA3A41B718F5=

Lua example showing how to create a text entry, display a help message, and then check if it is being displayed using BEGIN_TEXT_COMMAND_IS_THIS_HELP_MESSAGE_BEING_DISPLAYED and EndTextCommandIsThisHelpMessageBeingDisplayed.

```lua
-- Create new text entry
AddTextEntry('TEST_LABEL', 'Hello world.')

-- Draw help message
BeginTextCommandDisplayHelp('TEST_LABEL')
EndTextCommandDisplayHelp(0, false, true, -1)

-- Test if the message has been displayed
BeginTextCommandIsThisHelpMessageBeingDisplayed("TEST_LABEL")
local isDisplayed = EndTextCommandIsThisHelpMessageBeingDisplayed(0)
```

--------------------------------

### BEGIN_TEXT_COMMAND_DISPLAY_HELP

Source: https://docs.fivem.net/natives?_0x94CF4AC034C9C986=

Begins a text command to display help text.

```APIDOC
## BEGIN_TEXT_COMMAND_DISPLAY_HELP

### Description
Begins a text command to display help text.

### Method
N/A (Native Function)

### Endpoint
N/A

### Parameters
- **inputType** (char*) - Required - The input type string.

### Request Example
N/A

### Response
N/A
```

--------------------------------

### Lua example for IsVehicleSirenOn

Source: https://docs.fivem.net/natives?_0x4C9BF537BE2634B2=

Lua example that gets the vehicle the player is in and prints whether its siren is on. Note the missing closing parenthesis in the print call.

```lua
local veh = GetVehiclePedIsIn(PlayerPedId())
print(tostring(IsVehicleSirenOn(veh))
```

--------------------------------

### Lua example for GetWaterQuadAtCoords

Source: https://docs.fivem.net/natives?_0x17321452=

Lua example that gets the player ped's coordinates and then retrieves the water quad index at that position using GetWaterQuadAtCoords.

```lua
local currentPedPosition = GetEntityCoords(PlayerPedId())
local waterQuadIndex = GetWaterQuadAtCoords(currentPedPosition.x, currentPedPosition.y)
```

--------------------------------

### CREATE_SCRIPT_VEHICLE_GENERATOR usage example

Source: https://docs.fivem.net/natives?_0x9DEF883114668116=

Documentation for CREATE_SCRIPT_VEHICLE_GENERATOR, including parameter descriptions and an example call that creates an Adder at the player's position. Note the example contains a typo: '-1. -1' instead of '-1, -1'.

```text
Creates a script vehicle generator at the given coordinates. Most parameters after the model hash are unknown.  
Parameters:  
a/w/s - Generator position  
heading - Generator heading  
p4 - Unknown (always 5.0)  
p5 - Unknown (always 3.0)  
modelHash - Vehicle model hash  
p7/8/9/10 - Unknown (always -1)  
p11 - Unknown (usually TRUE, only one instance of FALSE)  
p12/13 - Unknown (always FALSE)  
p14 - Unknown (usally FALSE, only two instances of TRUE)  
p15 - Unknown (always TRUE)  
p16 - Unknown (always -1)  
Vector3 coords = GET_ENTITY_COORDS(PLAYER_PED_ID(), 0);	CREATE_SCRIPT_VEHICLE_GENERATOR(coords.x, coords.y, coords.z, 1.0f, 5.0f, 3.0f, GET_HASH_KEY("adder"), -1. -1, -1, -1, -1, true, false, false, false, true, -1);  
```

--------------------------------

### Lua example: GetPedDrawableCollectionLocalIndex

Source: https://docs.fivem.net/natives?_0x94EB1FE4=

Lua example showing how to get the local collection index from a global drawable ID and apply it with SetPedCollectionComponentVariation. Uses PlayerPedId() and GetPedDrawableCollectionName.

```lua
local ped = PlayerPedId()
-- Top for mp_f_freemode_01. From female_freemode_beach collection under index 1.
-- Global index is 17 because there is 16 top variations in the base game collection that goes before the female_freemode_beach collection.
local name = GetPedDrawableCollectionName(ped, 11, 17)
local index = GetPedDrawableCollectionLocalIndex(ped, 11, 17)
-- Equivalent to SetPedComponentVariation(ped, 11, 17, 0, 0)
SetPedCollectionComponentVariation(ped, 11, name, index, 0, 0)
```

--------------------------------

### Lua example: sit on bench using TaskPerformSequenceFromProgress

Source: https://docs.fivem.net/natives?_0x89221B16730234F0=

Lua example that makes the player walk to a nearby bench and sit on it using a task sequence. It loads the animation dict, finds a bench object, opens a sequence, adds movement and animation tasks, then calls TaskPerformSequenceFromProgress with progress1 set to 1 to skip the first task. Requires a bench object within 5.0 units; prints an error and returns if none is found.

```lua
Citizen.CreateThread(function()
    local animDict = 'timetable@ron@ig_5_p3'

    RequestAnimDict(animDict)
    while not HasAnimDictLoaded(animDict) do
        Wait(0)
    end

    local ped = PlayerPedId()
    local pos = GetEntityCoords(ped)

    -- you can change the model, but you might have to change the offsets below.
    local objModelHash = `prop_bench_01a`

    local obj = GetClosestObjectOfType(pos.x, pos.y, pos.z, 5.0, objModelHash, false, false, false)
    if obj == 0 then
        print("No valid object within range!")
        return
    end

    local tgtPos = GetOffsetFromEntityInWorldCoords(obj, 0.0, -0.7, 0.0)

    -- open the task sequence so we can get our sequence id
    local sequence = OpenSequenceTask()

    local desiredHeading = GetEntityHeading(obj) - 180.0

    -- go to the entities offset
    TaskGoStraightToCoord(nil, tgtPos.x, tgtPos.y, tgtPos.z, 1.0, 4000, desiredHeading, 1.0)

    -- sit on the bench indefinitely (you can change -1 here to however long you want to sit)
    TaskPlayAnim(nil, animDict, 'ig_5_p3_base', 8.0, 8.0, -1, 1)

    -- close the sequence so we can perform it
    CloseSequenceTask(sequence)

    -- perform the sequence, this will not work if the sequence is still open.
    -- note that progress1 is set to 1, this means it will skip the first sequence
    TaskPerformSequenceFromProgress(ped, sequence, 1, 1)

    -- free the sequence slot so it can be re-used
    ClearSequenceTask(sequence)

    -- cleanup the animation dict so the engine can remove it when its no longer needed
    RemoveAnimDict(animDict)
end)
```

--------------------------------

### _SHOW_PURCHASE_INSTRUCTIONAL_BUTTON

Source: https://docs.fivem.net/natives?_0xDC38CC1E35B6A5D7=

Documentation for the _SHOW_PURCHASE_INSTRUCTIONAL_BUTTON native function.

```APIDOC
## _SHOW_PURCHASE_INSTRUCTIONAL_BUTTON

### Description
Shows purchase instructional button.

### Method
NATIVE

### Endpoint
_SHOW_PURCHASE_INSTRUCTIONAL_BUTTON

### Parameters
- **toggle** (BOOL) - Required - Toggle value.

### Response
No return value.
```

--------------------------------

### Lua HTTP handler example

Source: https://docs.fivem.net/natives?_0xF5C6330C=

Lua example of SET_HTTP_HANDLER that responds to GET requests on the /ping path with 'pong' and a 200 status, otherwise returns a 404 with no data.

```lua
SetHttpHandler(function(request, response)
  if request.method == 'GET' and request.path == '/ping' then -- if a GET request was sent to the `/ping` path
      response.writeHead(200, { ['Content-Type'] = 'text/plain' }) -- set the response status code to `200 OK` and the body content type to plain text
      response.send('pong') -- respond to the request with `pong`
  else -- otherwise
      response.writeHead(404) -- set the response status code to `404 Not Found`
      response.send() -- respond to the request with no data
  end
end)
```

--------------------------------

### GET_ENTITY_MODEL Lua example

Source: https://docs.fivem.net/natives?_0x9F47B058362C84B5=

Lua example for GET_ENTITY_MODEL. It gets the model hash of the player ped and compares it to the male freemode model hash, printing a message if it matches.

```lua
local hash = GetEntityModel(PlayerPedId())

if hash == `mp_m_freemode_01` then
    print("This player is using the male freemode model.")
end
```
Tokens:
Raw