CFX CFX Server Natives

ADD_AUTHORIZED_PARACHUTE_MODEL

Description: Adds the given model name hash to the list of valid models for the player ped's parachute.

Parameters

• modelNameHash (int) — Name hash of the model to allow to be used for the player ped's parachute

ADD_AUDIO_SUBMIX_OUTPUT

Description: Adds an output for the specified audio submix.

Parameters

• submixId (int) — The input submix.
• outputSubmixId (int) — The output submix. Use 0 for the master game submix.

ADD_MINIMAP_OVERLAY

Description: 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.

Parameters

• name (char*) — The path to a .gfx file in the current resource. It has to be specified as a file.

ADD_AUTHORIZED_PARACHUTE_PACK_MODEL

Description: Adds the given model name hash to the list of valid models for the player ped's parachute pack.

Parameters

• modelNameHash (int) — Name hash of the model to allow to be used for the player ped's parachute pack

ACTIVATE_TIMECYCLE_EDITOR

Description: Activates built-in timecycle editing tool.

ADD_HEALTH_CONFIG

Description: Adds new health config.

Parameters

• configName (char*) — Name of health config. Cannot be default game health config name.
• defaultHealth (float) — Default health value.
• defaultArmor (float) — Default armor value.
• defaultEndurance (float)
• fatiguedHealthThreshold (float) — Fatigued health threshold value.
• injuredHealthThreshold (float) — Injured health threshold value.
• dyingHealthThreshold (float) — Dying health threshold value.
• hurtHealthThreshold (float) — Hurt health threshold value.
• dogTakedownThreshold (float) — Dog takedown threshold value.
• writheFromBulletThreshold (float) — Writhe from bulled threshold value.
• meleeCardinalFatalAttack (BOOL) — Melee cardinal fatal attack check value.
• invincible (BOOL) — Invincible value.

ADD_TEXT_ENTRY

ADD_CONVAR_CHANGE_LISTENER

Description: Adds a listener for Console Variable changes.

The function called expects to match the following signature:

function ConVarChangeListener(conVarName: string, reserved: any);

• conVarName: The ConVar that changed.
• reserved: Currently unused.

Parameters

• conVarFilter (char*) — The Console Variable to listen for, this can be a pattern like "test:*", or null for any
• handler (func) — The handler function.

Examples

// listen for all convar changes
AddConvarChangeListener(null, (conVarName, reserved) => {
    print(GetConvarInt(conVarName))
})

// listen to convars that start with "script:"
AddConvarChangeListener("script:*", (conVarName, reserved) => {
    print(GetConvarInt(conVarName))
})

ADD_REPLACE_TEXTURE

Description: Experimental natives, please do not use in a live environment.

ADD_MINIMAP_OVERLAY_WITH_DEPTH

Description: Loads a minimap overlay from a GFx file in the current resource.

Parameters

• name (char*) — The path to a .gfx file in the current resource. It has to be specified as a file.
• depth (int) — The depth of new overlay on the minimap. Pass -1 for game to figure out the highest depth itself. Should not be greater than 0x7EFFFFFD.

CREATE_AUDIO_SUBMIX

Description: Creates an audio submix with the specified name, or gets the existing audio submix by that name.

Parameters

• name (char*) — The audio submix name.

CALL_MINIMAP_SCALEFORM_FUNCTION

Description: This is similar to the PushScaleformMovieFunction natives, except it calls in the TIMELINE of a minimap overlay.

Parameters

• miniMap (int) — The minimap overlay ID.
• fnName (char*) — A function in the overlay's TIMELINE.

CANCEL_EVENT

Description: Cancels the currently executing event.

ADD_STATE_BAG_CHANGE_HANDLER

Description: Adds a handler for changes to a state bag.

The function called expects to match the following signature:

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 to get the entity handle If bagName refers to a player, use GET_PLAYER_FROM_STATE_BAG_NAME to get the player handle

Parameters

• keyFilter (char*) — The key to check for, or null for no filter.
• bagFilter (char*) — The bag ID to check for such as entity:65535, or null for no filter.
• handler (func) — The handler function.

Examples

AddStateBagChangeHandler("blockTasks", null, async (bagName, key, value /* boolean */) => {
    let entity = GetEntityFromStateBagName(bagName);
    // Whoops, we don't have a valid entity!
    if (entity === 0) return;
    // We don't want to freeze the entity position if the entity collision hasn't loaded yet
    while (!HasCollisionLoadedAroundEntity(entity)) {
        // The entity went out of our scope before the collision loaded
        if (!DoesEntityExist(entity)) return;
        await Delay(250);
    }
    SetEntityInvincible(entity, value)
    FreezeEntityPosition(entity, value)
    TaskSetBlockingOfNonTemporaryEvents(entity, value)
})

AddStateBagChangeHandler("blockTasks", nil, function(bagName, key, value) 
    local entity = GetEntityFromStateBagName(bagName)
    -- Whoops, we don't have a valid entity!
    if entity == 0 then return end
    -- We don't want to freeze the entity position if the entity collision hasn't loaded yet
    while not HasCollisionLoadedAroundEntity(entity) do
        -- The entity went out of our scope before the collision loaded
        if not DoesEntityExist(entity) then return end
        Wait(250)
    end
    SetEntityInvincible(entity, value)
    FreezeEntityPosition(entity, value)
    TaskSetBlockingOfNonTemporaryEvents(entity, value)
end)

AddStateBagChangeHandler("blockTasks", null,
    new Action<string, string, object, int, bool>
    (async (bagName, key, value, res, rep) =>
    {
        bool val = (bool)value;

        var entity = GetEntityFromStateBagName(bagName);
        //-- Whoops, we don't have a valid entity!
        if (entity == 0) return;
        //-- We don't want to freeze the entity position if the entity collision hasn't loaded yet
        while (!HasCollisionLoadedAroundEntity(entity))
        {
            //--The entity went out of our scope before the collision loaded
            if (!DoesEntityExist(entity)) return;

            await Delay(250);
        }
        SetEntityInvincible(entity, val);
        FreezeEntityPosition(entity, val);
        TaskSetBlockingOfNonTemporaryEvents(entity, val);
    }));

BREAK_OFF_VEHICLE_WHEEL

Description: Break off vehicle wheel by index. The leaveDebrisTrail flag requires putOnFire to be true.

Parameters

• vehicle (Vehicle) — The vehicle handle.
• wheelIndex (int) — The wheel index.
• leaveDebrisTrail (BOOL) — Start "veh_debris_trail" ptfx.
• deleteWheel (BOOL) — True to delete wheel, otherwise detach.
• unknownFlag (BOOL) — Unknown flag.
• putOnFire (BOOL) — Set wheel on fire once detached.

Examples

local vehicle = GetVehiclePedIsIn(PlayerPedId())

if DoesEntityExist(vehicle) then
  for i = 0, 3 do
    BreakOffVehicleWheel(vehicle, i, true, false, true, false)
  end
end

APPLY_WEATHER_CYCLES

Parameters

• numEntries (int) — The number of cycle entries. Must be between 1 and 256
• msPerCycle (int) — The duration in milliseconds of each cycle. Must be between 1000 and 86400000 (24 hours)

Examples

-- Cycle between XMAS weather for 30 seconds (3 * 10000 milliseconds), and SMOG weather for 20 seconds (2 * 10000 milliseconds)
local success = SetWeatherCycleEntry(0, "XMAS", 3) and
                SetWeatherCycleEntry(1, "SMOG", 2) and
                ApplyWeatherCycles(2, 10000)

CAN_PLAYER_START_COMMERCE_SESSION

Description: Returns whether or not the specified player has enough information to start a commerce session for.

Parameters

• playerSrc (char*) — The player handle

CLONE_TIMECYCLE_MODIFIER

Parameters

• sourceModifierName (char*) — The source timecycle name.
• clonedModifierName (char*) — The clone timecycle name, must be unique.

Examples

local sourceName = "underwater"
local cloneName = "my_awesome_timecycle"

local clonedIndex = CloneTimecycleModifier(sourceName, cloneName)
if clonedIndex ~= -1 then
  SetTimecycleModifier(cloneName)
end

IS_HELI_TAIL_BOOM_BREAKABLE

Description: This is a getter for SET_HELI_TAIL_EXPLODE_THROW_DASHBOARD

Parameters

• heli (Vehicle) — The helicopter to check

ADD_TEXT_ENTRY_BY_HASH

CLEAR_DRAW_ORIGIN

Description: Resets the screen's draw-origin which was changed by the function SET_DRAW_ORIGIN back to x=0, y=0. See SET_DRAW_ORIGIN for further information.

CREATE_RUNTIME_TEXTURE_FROM_DUI_HANDLE

Description: Creates a runtime texture from a DUI handle.

Parameters

• txd (long) — A handle to the runtime TXD to create the runtime texture in.
• txn (char*) — The name for the texture in the runtime texture dictionary.
• duiHandle (char*) — The DUI handle returned from GET_DUI_HANDLE.

CLEAR_VEHICLE_XENON_LIGHTS_CUSTOM_COLOR

Description: Removes vehicle xenon lights custom RGB color.

Parameters

• vehicle (Vehicle) — The vehicle handle.

COMMIT_RUNTIME_TEXTURE

Description: Commits the backing pixels to the specified runtime texture.

Parameters

• tex (long) — The runtime texture handle.

CREATE_DRY_VOLUME

Description: 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)

Parameters

• xMin (float) — The min X component of the AABB volume where water does not affect the player.
• yMin (float) — The min Y component for the AABB volume.
• zMin (float) — The min Z component for the AABB volume.
• xMax (float) — The max X component for the AABB volume.
• yMax (float) — The max Y component for the AABB volume.
• zMax (float) — The max Z component for the AABB volume.

DOES_PLAYER_EXIST

Description: Returns whether or not the player exists

Examples

local deferralMessages = { "Isn't this just magical!", "We can defer all day!", "You'll get in eventually", "You're totally not going to sit here forever", "The Fruit Tree is a lie" }
AddEventHandler("playerConnecting", function(name, setKickReason, deferrals)
    local source = source
    deferrals.defer()

    Wait(0)


    local messageIndex = 0

    repeat
        Wait(2000)
        if messageIndex >= #deferralMessages then
            deferrals.done()
        else
            messageIndex = messageIndex + 1
        end
        deferrals.update(deferralMessages[messageIndex])
    until not DoesPlayerExist(source)
end)

CREATE_RUNTIME_TXD

Description: Creates a runtime texture dictionary with the specified name. Example:

local txd = CreateRuntimeTxd('meow')

Parameters

• name (char*) — The name for the runtime TXD.

CREATE_TIMECYCLE_MODIFIER

Description: Create a clean timecycle modifier. See SET_TIMECYCLE_MODIFIER_VAR to add variables.

Parameters

• modifierName (char*) — The new timecycle name, must be unique.

Examples

local modifierName = "my_awesome_timecycle"
local createdIndex = CreateTimecycleModifier(modifierName)

if createdIndex ~= -1 then
  SetTimecycleModifier(modifierName)
end

DELETE_ENTITY

Description: Deletes the specified entity.

NOTE: For trains this will only work if called on the train engine, it will not work on its carriages.

Parameters

• entity (Entity) — The entity to delete.

CREATE_DUI

Description: Creates a DUI browser. This can be used to draw on a runtime texture using CREATE_RUNTIME_TEXTURE_FROM_DUI_HANDLE.

Parameters

• url (char*) — The initial URL to load in the browser.
• width (int) — The width of the backing surface.
• height (int) — The height of the backing surface.

DISABLE_VEHICLE_PASSENGER_IDLE_CAMERA

Description: Disables the game's afk camera that starts panning around after 30 seconds of inactivity(While riding in a car as a passenger)

Parameters

• state (BOOL) — On/Off

DELETE_FUNCTION_REFERENCE

CREATE_RUNTIME_TEXTURE

Description: Creates a blank runtime texture.

Parameters

• txd (long) — A handle to the runtime TXD to create the runtime texture in.
• txn (char*) — The name for the texture in the runtime texture dictionary.
• width (int) — The width of the new texture.
• height (int) — The height of the new texture.

CREATE_RUNTIME_TEXTURE_FROM_IMAGE

Description: Creates a runtime texture from the specified file in the current resource or a base64 data URL.

Parameters

• txd (long) — A handle to the runtime TXD to create the runtime texture in.
• txn (char*) — The name for the texture in the runtime texture dictionary.
• fileName (char*) — The file name of an image to load or a base64 data URL. This should preferably be a PNG, and has to be specified as a file in the resource manifest.

DOES_PLAYER_OWN_SKU

Description: Requests whether or not the player owns the specified SKU.

Parameters

• playerSrc (char*) — The player handle
• skuId (int) — The ID of the SKU.

DESTROY_DUI

Description: Destroys a DUI browser.

Parameters

• duiObject (long) — The DUI browser handle.

DELETE_TRAIN

Description: Deletes the specified entity and any carriage its attached to, or that is attached to it.

Parameters

• entity (Entity) — The carriage to delete.

DISABLE_IDLE_CAMERA

Description: Disables the game's afk camera that starts panning around after 30 seconds of inactivity.

Parameters

• state (BOOL) — On/Off

DISABLE_RAW_KEY_THIS_FRAME

Description: Disables the specified rawKeyIndex, making it not trigger the regular IS_RAW_KEY_* natives.

Virtual key codes can be found here

Parameters

• rawKeyIndex (int) — Index of raw key from keyboard.

Examples

local KEY_SPACE = 32
DisableRawKeyThisFrame(KEY_SPACE)
-- This will not get triggered this frame
if IsRawKeyDown(KEY_SPACE) then
	print("unreachable :(")
end
-- this will get triggered
if IsDisabledRawKeyDown(KEY_SPACE) then
    print("Spacebar is down")
end

DOES_TIMECYCLE_MODIFIER_HAS_VAR

Parameters

• modifierName (char*) — The name of timecycle modifier.
• varName (char*) — The name of timecycle variable.

Examples

local modifierName = "superDARK"
local varName = "postfx_noise"

if DoesTimecycleModifierHasVar(modifierName, varName) then
  local success, value1, value2 = GetTimecycleModifierVar(modifierName, varName)

  if success then
    print(string.format("[%s] removed var %s with values: %f %f", modifierName, varName, value1, value2))
    RemoveTimecycleModifierVar(modifierName, varName)
  end
else
    SetTimecycleModifierVar(modifierName, varName, 1.0, 1.0)
    print(string.format("[%s] created var %s", modifierName, varName))
end

DOES_TRAIN_STOP_AT_STATIONS

Parameters

• train (Vehicle) — The train handle

DOES_VEHICLE_USE_FUEL

Description: Checks whether the vehicle consumes fuel. The check is done based on petrol tank volume and vehicle type. Bicycles and vehicles with petrol tank volume equal to zero (only bicycles by default) do not use fuel. All other vehicles do.

You can customize petrol tank volume using SET_HANDLING_FLOAT/SET_VEHICLE_HANDLING_FLOAT natives with fieldName equal to fPetrolTankVolume.

Parameters

• vehicle (Vehicle) — The vehicle handle.

DOES_ENTITY_EXIST

DISABLE_WORLDHORIZON_RENDERING

Description: Disables the game's world horizon lods rendering (see farlods.#dd). Using the island hopper natives might also affect this state.

Parameters

• state (BOOL) — On/Off

DOES_BOAT_SINK_WHEN_WRECKED

Parameters

• vehicle (Vehicle) — The target vehicle.

DRAW_POLY

DOOR_SYSTEM_GET_ACTIVE

Description: Returns a list of door system entries: a door system hash (see ADD_DOOR_TO_SYSTEM) and its object handle.

The data returned adheres to the following layout:

[{doorHash1, doorHandle1}, ..., {doorHashN, doorHandleN}]

DOES_PLAYER_OWN_SKU_EXT

Description: Requests whether or not the player owns the specified package.

Parameters

• playerSrc (char*) — The player handle
• skuId (int) — The package ID on Tebex.

DOES_TEXTURE_EXIST

Description: In compare to 0x31DC8D3F216D8509 return true if texture its created when 0x31DC8D3F216D8509 return true if you put there any id in valid range

Parameters

• textureId (int) — texture id created by 0xC5E7204F322E49EB.

DRAW_LINE

DOOR_SYSTEM_GET_SIZE

END_FIND_OBJECT

DRAW_BOX

FIND_FIRST_OBJECT

DROP_PLAYER

FIND_FIRST_PED

DRAW_CORONA

Description: Allows drawing advanced light effects, known as coronas, which support flares, volumetric lighting, and customizable glow properties.

Parameters

• posX (float) — The X position of the corona origin.
• posY (float) — The Y position of the corona origin.
• posZ (float) — The Z position of the corona origin.
• size (float) — The size of the corona.
• red (int) — The red component of the marker color, on a scale from 0-255.
• green (int) — The green component of the marker color, on a scale from 0-255.
• blue (int) — The blue component of the marker color, on a scale from 0-255.
• alpha (int) — The alpha component of the marker color, on a scale from 0-255.
• intensity (float) — The intensity of the corona.
• zBias (float) — zBias slightly shifts the depth of surfaces to make sure they don’t overlap or cause visual glitches when they are very close together. The zBias value are usually in the range of 0.0 to 1.0.
• dirX (float) — The X direction of the corona.
• dirY (float) — The Y direction of the corona.
• dirZ (float) — The Z direction of the corona.
• viewThreshold (float) — The view threshold is to determine the fading of the corona based on the distance.
• innerAngle (float) — The inner angle of the corona.
• outerAngle (float) — The outer angle of the corona.
• flags (int) — The corona flags.

Examples

local pedCoords = GetEntityCoords(PlayerPedId())
Citizen.CreateThread(function()
    while true do
        DrawCorona(pedCoords.x, pedCoords.y, pedCoords.z, 5.0, 255, 255, 255, 255, 4.0, 0.2, pedCoords.x, pedCoords.y, pedCoords.z, 1.0, 0.0, 90.0, 2)
        Wait(0)
    end
end)

DRAW_GLOW_SPHERE

Description: Draw a glow sphere this frame. Up to 256 per single frame.

Parameters

• posX (float) — Position X.
• posY (float) — Position Y.
• posZ (float) — Position Z.
• radius (float) — Sphere radius.
• colorR (int) — Red.
• colorG (int) — Green.
• colorB (int) — Blue.
• intensity (float) — Intensity.
• invert (BOOL) — Invert rendering.
• marker (BOOL) — Draw as a marker, otherwise as an overlay.

DUPLICATE_FUNCTION_REFERENCE

END_FIND_VEHICLE

DRAW_LINE_2D

Description: Like DRAW_RECT, but it's a line.

Parameters

• x1 (float) — First x.
• y1 (float) — First y.
• x2 (float) — Second x.
• y2 (float) — Second y.
• width (float) — Width of line.
• r (int) — Red.
• g (int) — Green.
• b (int) — Blue.
• a (int) — Alpha.

END_FIND_PICKUP

ENABLE_ENHANCED_HOST_SUPPORT

FIND_NEXT_PED

EXECUTE_COMMAND

Description: Depending on your use case you may need to use add_acl resource.<your_resource_name> command.<command_name> allow to use this native in your resource.

Examples

Citizen.CreateThread(function()
  -- stop the server after 1 minute
  Citizen.Wait(60000)
  ExecuteCommand("quit Shortlived")
end)

ENSURE_ENTITY_STATE_BAG

Description: Internal function for ensuring an entity has a state bag.

EXPERIMENTAL_LOAD_CLONE_CREATE

Description: This native is not implemented.

DRAW_RECT_ROTATED

Description: DRAW_RECT, but with a rotation. Seems to be broken.

FIND_NEXT_VEHICLE

GET_ALL_VEHICLE_MODELS

Description: Returns all registered vehicle model names, including non-dlc vehicles and custom vehicles in no particular order.

Example output

	["dubsta", "dubsta2", "dubsta3", "myverycoolcar", "sultan", "sultanrs", ...]

This native will not return vehicles that are unregistered (i.e from a resource being stopped) during runtime.

Examples

RegisterCommand("spawnrandomcar", function()
	local vehicles = GetAllVehicleModels()
	local veh = vehicles[math.random(1, #vehicles)]
	RequestModel(veh)
	repeat Wait(0) until HasModelLoaded(veh)
	local veh = CreateVehicle(veh, GetEntityCoords(PlayerPedId()), GetEntityHeading(PlayerPedId()), true, false)
	SetPedIntoVehicle(PlayerPedId(), veh, -1)
end)

GET_ALL_ROPES

Description: Returns all rope handles. The data returned adheres to the following layout:

[ 770, 1026, 1282, 1538, 1794, 2050, 2306, 2562, 2818, 3074, 3330, 3586, 3842, 4098, 4354, 4610, ...]

END_FIND_PED

EXPERIMENTAL_SAVE_CLONE_SYNC

Description: This native is not implemented.

EXPERIMENTAL_LOAD_CLONE_SYNC

Description: This native is not implemented.

FORCE_SNOW_PASS

Description: Forces the game snow pass to render.

Parameters

• enabled (BOOL) — Whether or not to force rendering to use a snow pass.

FIND_NEXT_OBJECT

FIND_FIRST_VEHICLE

FORMAT_STACK_TRACE

Description: An internal function for converting a stack trace object to a string.

GET_AIR_DRAG_MULTIPLIER_FOR_PLAYERS_VEHICLE

Parameters

• playerSrc (char*) — The player handle

FLAG_SERVER_AS_PRIVATE

GET_ASPECT_RATIO

Description: Gets the current aspect ratio

local ratio = GetAspectRatio()
print(string.format("%.2f", ratio))

FIND_FIRST_PICKUP

GET_CALMING_QUAD_BOUNDS

Parameters

• waterQuad (int) — The calming quad index
• minX (int*) — The minX coordinate
• minY (int*) — The minY coordinate
• maxX (int*) — The maxX coordinate
• maxY (int*) — The maxY coordinate

Examples

local success, minX, minY, maxX, maxY = GetCalmingQuadBounds(1)

GET_ACTIVE_PLAYERS

Description: Returns all player indices for 'active' physical players known to the client. The data returned adheres to the following layout:

[127, 42, 13, 37]

EXPERIMENTAL_SAVE_CLONE_CREATE

Description: This native is not implemented.

GET_CURRENT_GAME_NAME

Description: This native returns the currently used game's name.

GET_ALL_TRACK_JUNCTIONS

Description: Returns all track junctions on the client The data returned adheres to the following structure:

[1, 2, 4, 6, 69, 420]

GET_CONVAR_FLOAT

Description: This will have floating point inaccuracy.

Parameters

• varName (char*) — The console variable to get
• defaultValue (float) — The default value to set, if none are found.

GET_ALL_PEDS

Description: Returns all peds handles known to the server. The data returned adheres to the following layout:

[127, 42, 13, 37]

Examples

-- This example prints information of every ped that has an owner.

for i, ped in ipairs(GetAllPeds()) do
    local pedOwner = NetworkGetEntityOwner(ped)
    if pedOwner > 0 then
       local playerName = GetPlayerName(pedOwner)
       local pedModel = GetEntityModel(ped)
       local pedArmour = GetPedArmour(ped)
       print("Ped : "..ped.." | Owner name : "..playerName.." | Model : "..pedModel.." | Armour : "..pedArmour)
    end
end

GET_CALMING_QUAD_COUNT

Examples

local calmingQuadCount = GetCalmingQuadCount()

GET_AMBIENT_PED_RANGE_MULTIPLIER

Description: A getter for SET_AMBIENT_PED_RANGE_MULTIPLIER_THIS_FRAME.

GET_AMBIENT_VEHICLE_RANGE_MULTIPLIER

Description: A getter for SET_AMBIENT_VEHICLE_RANGE_MULTIPLIER_THIS_FRAME.

GET_CURRENT_SERVER_ENDPOINT

Description: Returns the peer address of the remote game server that the user is currently connected to.

GET_CLOSEST_TRACK_NODES

Description: Get all track nodes and their track ids within the radius of the specified coordinates.

Parameters

• position (Vector3) — Get track nodes at position
• radius (float) — Get track nodes within radius

GET_ALL_VEHICLES

Description: Returns all vehicle handles known to the server. The data returned adheres to the following layout:

[127, 42, 13, 37]

FIND_NEXT_PICKUP

GET_ENTITY_MODEL

GET_CALMING_QUAD_DAMPENING

Parameters

• waterQuad (int) — The calming quad index
• calmingQuadDampening (float*)

Examples

local success, dampening = GetCalmingQuadDampening(1)

GET_CAM_MATRIX

Description: Returns the world matrix of the specified camera. To turn this into a view matrix, calculate the inverse.

GET_ALL_OBJECTS

Description: Returns all object handles known to the server. The data returned adheres to the following layout:

[127, 42, 13, 37]

GET_CONSOLE_BUFFER

Description: Returns the current console output buffer.

GET_ENTITIES_IN_RADIUS

Description: ### Supported types

• [1] : Peds (including animals) and players.
• [2] : Vehicles.
• [3] : Objects (props), doors, and projectiles.

Coordinates need to be send unpacked (x,y,z)

-- Define the allowed model hashes
local allowedModelHashes = { GetHashKey("p_crate03x"), GetHashKey("p_crate22x") }

-- Get the player's current coordinates
local playerCoords = GetEntityCoords(PlayerPedId())

-- Retrieve all entities of type Object (type 3) within a radius of 10.0 units
-- that match the allowed model hashes
-- and sort output entities by distance
local entities = GetEntitiesInRadius(playerCoords.x, playerCoords.y, playerCoords.z, 10.0, 3, true, allowedModelHashes)

-- Iterate through the list of entities and print their ids
for i = 1, #entities do
    local entity = entities[i]
    print(entity)
end

Parameters

• x (float) — The X coordinate.
• y (float) — The Y coordinate.
• z (float) — The Z coordinate.
• radius (float) — Max distance from coordinate to entity
• entityType (int) — Entity types see list below
• sortByDistance (BOOL) — Sort output entites by distance from nearest to farthest
• models (object) — List of allowed models its also optional

GET_ENTITY_HEALTH

Description: Only works for vehicle and peds

Parameters

• entity (Entity) — The entity to check the health of

GET_CURRENT_RESOURCE_NAME

Description: Returns the name of the currently executing resource.

GET_ENTITY_ARCHETYPE_NAME

Description: Returns entity's archetype name, if available.

Parameters

• entity (Entity) — An entity handle.

GET_ENTITY_COLLISION_DISABLED

Parameters

• entity (Entity) — The target entity.

GET_CONVAR

Description: Can be used to get a console variable of type char*, for example a string.

Parameters

• varName (char*) — The console variable to look up.
• default_ (char*) — The default value to set if none is found.

Examples

if GetConvar('voice_useNativeAudio', 'false') == 'true' then
    Citizen.Trace('Native Audio is enabled.')
end

GET_CALMING_QUAD_AT_COORDS

Description: This native returns the index of a calming quad if the given point is inside its bounds.

Parameters

• x (float) — The X coordinate
• y (float) — The Y coordinate

Examples

local currentPedPosition = GetEntityCoords(PlayerPedId())
local calmingQuadIndex = GetCalmingQuadAtCoords(currentPedPosition.x, currentPedPosition.y)

GET_ENTITY_ATTACHED_TO

Description: Gets the entity that this entity is attached to.

Parameters

• entity (Entity) — The entity to check.

GET_CONVAR_INT

Description: Can be used to get a console variable casted back to int (an integer value).

Parameters

• varName (char*) — The console variable to look up.
• default_ (int) — The default value to set if none is found (variable not set using SET_CONVAR, or not accessible).

Examples

if GetConvarInt('remainingRounds', 0) < 900 then
    Citizen.Trace("Less than 900 rounds remaining...")
end

GET_CURRENT_SCREEN_RESOLUTION

Description: Gets the current screen resolution.

local  width, height = GetCurrentScreenResolution()
print(string.format("Current screen resolution: %dx%d", width, height))

GET_ENTITY_ROUTING_BUCKET

Description: Gets the routing bucket for the specified entity.

Routing buckets are also known as 'dimensions' or 'virtual worlds' in past echoes, however they are population-aware.

Parameters

• entity (Entity) — The entity to get the routing bucket for.

GET_CURRENT_PED_WEAPON

Description: Returns the hash of weapon the Ped is currently using.

Parameters

• ped (Ped) — The target ped.

GET_ENTITY_ROTATION

GET_GLOBAL_PASSENGER_MASS_MULTIPLIER

Description: A getter for SET_GLOBAL_PASSENGER_MASS_MULTIPLIER.

GET_CONVAR_BOOL

Description: Can be used to get a console variable casted back to bool.

Parameters

• varName (char*) — The console variable to look up.
• defaultValue (BOOL) — The default value to set if none is found.

Examples

if GetConvarBool('dev_mode', false) then
    print("Dev Mode is eanbled, load dev mode menus")
end

GET_ENTITY_COORDS

Description: Gets the current coordinates for a specified entity. This native is used server side when using OneSync.

See GET_ENTITY_COORDS for client side.

Parameters

• entity (Entity) — The entity to get the coordinates from.

Examples

local function ShowCoordinates()
    local player = source
    local ped = GetPlayerPed(player)
    local playerCoords = GetEntityCoords(ped)

    print(playerCoords) -- vector3(...)
end

RegisterNetEvent("myCoordinates")
AddEventHandler("myCoordinates", ShowCoordinates)

onNet('myCoordinates', () => {
  const player = global.source; // use (global as any).source for Typescript
  const ped = GetPlayerPed(player);
  const [playerX, playerY, playerZ] = GetEntityCoords(ped);

  console.log(`${playerX}, ${playerY}, ${playerZ}`);
});

using static CitizenFX.Core.Native.API;
// ...

// In class constructor
EventHandlers["myCoordinates"] += new Action<Player>(ShowCoordinates);

// Delegate method
private void ShowCoordinates([FromSource]Player player) {
    Vector3 playerCoords = GetEntityCoords(player.Character);

    // or the preferred use of C# wrapper
    Vector3 playerCoords = player.Character.Position;

    Debug.WriteLine($"{playerCoords}");
}

GET_GAME_NAME

Description: Returns the current game being executed.

Possible values:

GET_ENTITY_ADDRESS

Description: Experimental: This native may be altered or removed in future versions of CitizenFX without warning.

Returns the memory address of an entity.

This native is intended for singleplayer debugging, and may not be available during multiplayer.

Parameters

• entity (Entity) — The handle of the entity to get the address of.

GET_ENTITY_VELOCITY

GET_ENTITY_POPULATION_TYPE

Description: This native gets an entity's population type.

Parameters

• entity (Entity) — the entity to obtain the population type from

GET_ENTITY_SPEED

Description: Gets the current speed of the entity in meters per second.

To convert to MPH: speed * 2.236936
To convert to KPH: speed * 3.6

Parameters

• entity (Entity) — The entity to get the speed of

GET_ENTITY_FROM_STATE_BAG_NAME

Description: Returns the entity handle for the specified state bag name. For use with ADD_STATE_BAG_CHANGE_HANDLER.

Parameters

• bagName (char*) — An internal state bag ID from the argument to a state bag change handler.

Examples

AddStateBagChangeHandler("blockTasks", null, async (bagName, key, value /* boolean */) => {
    let entity = GetEntityFromStateBagName(bagName);
    // Whoops, we were don't have a valid entity!
    if (entity === 0) return;
    // We don't want to freeze the entity position if the entity collision hasn't loaded yet
    while (!HasCollisionLoadedAroundEntity(entity)) {
        // The entity went out of our scope before the collision loaded
        if (!DoesEntityExist(entity)) return;
        await Delay(250);
    }
    SetEntityInvincible(entity, value)
    FreezeEntityPosition(entity, value)
    TaskSetBlockingOfNonTemporaryEvents(entity, value)
})

AddStateBagChangeHandler("blockTasks", nil, function(bagName, key, value) 
    local entity = GetEntityFromStateBagName(bagName)
    -- Whoops, we don't have a valid entity!
    if entity == 0 then return end
    -- We don't want to freeze the entity position if the entity collision hasn't loaded yet
    while not HasCollisionLoadedAroundEntity(entity) do
        -- The entity went out of our scope before the collision loaded
        if not DoesEntityExist(entity) then return end
        Wait(250)
    end
    SetEntityInvincible(entity, value)
    FreezeEntityPosition(entity, value)
    TaskSetBlockingOfNonTemporaryEvents(entity, value)
end)

GET_ENTITY_MAX_HEALTH

Description: Currently it only works with peds.

GET_ENTITY_REMOTE_SYNCED_SCENES_ALLOWED

Parameters

• entity (Entity) — The entity to get the flag for.

GET_HOST_ID

GET_ENTITY_HEADING

GET_GAME_POOL

Description: Returns a list of entity handles (script GUID) for all entities in the specified pool - the data returned is an array as follows:

[ 770, 1026, 1282, 1538, 1794, 2050, 2306, 2562, 2818, 3074, 3330, 3586, 3842, 4098, 4354, 4610, ...]

Supported pools

• CPed: Peds (including animals) and players.
• CObject: Objects (props), doors, and projectiles.
• CNetObject: Networked objects
• CVehicle: Vehicles.
• CPickup: Pickups.

Parameters

• poolName (char*) — The pool name to get a list of entities from.

Examples

local vehiclePool = GetGamePool('CVehicle') -- Get the list of vehicles (entities) from the pool
for i = 1, #vehiclePool do -- loop through each vehicle (entity)
    if GetPedInVehicleSeat(vehiclePool[i], -1) == 0 then
        DeleteEntity(vehiclePool[i]) -- Delete vehicles (entities) that don't have a driver
    end
end

GET_ENTITY_TYPE

Description: Gets the entity type (as an integer), which can be one of the following defined down below:

The following entities will return type 1:

• Ped
• Player
• Animal (Red Dead Redemption 2)
• Horse (Red Dead Redemption 2)

The following entities will return type 2:

• Automobile
• Bike
• Boat
• Heli
• Plane
• Submarine
• Trailer
• Train
• DraftVeh (Red Dead Redemption 2)

The following entities will return type 3:

• Object
• Door
• Pickup

Otherwise, a value of 0 will be returned.

Parameters

• entity (Entity) — The entity to get the type of.

GET_ENTITY_ORPHAN_MODE

Parameters

• entity (Entity) — The entity to get the orphan mode of

GET_FUEL_CONSUMPTION_RATE_MULTIPLIER

GET_ENTITY_SCRIPT

GET_DUI_HANDLE

Description: Returns the NUI window handle for a specified DUI browser object.

Parameters

• duiObject (long) — The DUI browser handle.

GET_HELI_THROTTLE_CONTROL

Parameters

• heli (Vehicle) — The helicopter to check.

GET_HELI_PITCH_CONTROL

Parameters

• heli (Vehicle) — The helicopter to check.

GET_HELI_ENGINE_HEALTH

Description: Note This native will always return 1000.0 unless SET_VEHICLE_BODY_HEALTH, SET_VEHICLE_ENGINE_HEALTH, or SET_VEHICLE_PETROL_TANK_HEALTH have been called with a value greater than 1000.0.

Parameters

• heli (Vehicle) — The helicopter to check

GET_HELI_MAIN_ROTOR_DAMAGE_SCALE

Parameters

• heli (Vehicle) — The helicopter to check

GET_HELI_DISABLE_EXPLODE_FROM_BODY_DAMAGE

Description: This is a getter for SET_DISABLE_HELI_EXPLODE_FROM_BODY_DAMAGE

Parameters

• heli (Vehicle) — The helicopter to check

GET_FUEL_CONSUMPTION_STATE

GET_INTERIOR_PORTAL_ENTITY_FLAG

Parameters

• interiorId (int) — The target interior.
• portalIndex (int) — Interior portal index.
• entityIndex (int) — Portal entity index.

Examples

local playerPed = PlayerPedId()
local interiorId = GetInteriorFromEntity(playerPed)
local portalIndex = 0

if interiorId ~= 0 then
  local count = GetInteriorPortalEntityCount(interiorId, portalIndex)
  for i=0, count-1 do
    local flag = GetInteriorPortalEntityFlag(interiorId, portalIndex, i)
    print("portal " .. portalIndex .." entity " .. i .. " flag is: " .. flag)
  end
end

GET_GAME_TIMER

Description: Gets the current game timer in milliseconds.

GET_HELI_TAIL_ROTOR_DAMAGE_SCALE

Parameters

• heli (Vehicle) — The helicopter to check

GET_INTERIOR_PORTAL_ENTITY_ROTATION

Parameters

• interiorId (int) — The target interior.
• portalIndex (int) — Interior portal index.
• entityIndex (int) — Portal entity index.
• rotX (float*)
• rotY (float*)
• rotZ (float*)
• rotW (float*)

Examples

local playerPed = PlayerPedId()
local interiorId = GetInteriorFromEntity(playerPed)
local portalIndex = 0

if interiorId ~= 0 then
  local count = GetInteriorPortalEntityCount(interiorId, portalIndex)
  for i=0, count-1 do
    local x, y, z, w = GetInteriorPortalEntityRotation(interiorId, portalIndex, i)
    print("portal " .. portalIndex .." entity " .. i .. " rotation is: " .. vec4(x, y, z, w))
  end
end

GET_INTERIOR_ENTITIES_EXTENTS

Parameters

• interiorId (int) — The target interior.
• bbMinX (float*)
• bbMinY (float*)
• bbMinZ (float*)
• bbMaxX (float*)
• bbMaxY (float*)
• bbMaxZ (float*)

Examples

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

if interiorId ~= 0 then
  local minX, minY, minZ, maxX, maxY, maxZ = GetInteriorEntitiesExtents(interiorId, roomId)
  print("current entities extents is: " .. vec(minX, minY, minZ) .." / " .. vec(maxX, maxY, maxZ))
end

GET_HELI_BODY_HEALTH

Description: Note This native will always return 1000.0 unless SET_VEHICLE_BODY_HEALTH, SET_VEHICLE_ENGINE_HEALTH, or SET_VEHICLE_PETROL_TANK_HEALTH have been called with a value greater than 1000.0.

Parameters

• heli (Vehicle) — The helicopter to check

GET_GAME_BUILD_NUMBER

Description: Returns the internal build number of the current game being executed.

Possible values:

• FiveM
  • 1604
  • 2060
  • 2189
  • 2372
  • 2545
  • 2612
  • 2699
  • 2802
  • 2944
  • 3095
  • 3258
  • 3323
  • 3407
  • 3570
• RedM
  • 1311
  • 1355
  • 1436
  • 1491
• LibertyM
  • 43
• FXServer
  • 0

GET_HELI_REAR_ROTOR_DAMAGE_SCALE

Parameters

• heli (Vehicle) — The helicopter to check

GET_HELI_MAIN_ROTOR_HEALTH

Parameters

• vehicle (Vehicle) — The target vehicle.

GET_ENTITY_ROTATION_VELOCITY

GET_HASH_KEY

Description: This native converts the passed string to a hash.

GET_INTERIOR_PORTAL_ENTITY_ARCHETYPE

Parameters

• interiorId (int) — The target interior.
• portalIndex (int) — Interior portal index.
• entityIndex (int) — Portal entity index.

Examples

local playerPed = PlayerPedId()
local interiorId = GetInteriorFromEntity(playerPed)
local portalIndex = 0

if interiorId ~= 0 then
  local count = GetInteriorPortalEntityCount(interiorId, portalIndex)
  for i=0, count-1 do
    local archetype = GetInteriorPortalEntityArchetype(interiorId, portalIndex, i)
    print("portal " .. portalIndex .." entity " .. i .. " archetype is: " .. archetype)
  end
end

GET_HUD_COMPONENT_NAME

Parameters

• id (int) — The hud component id.

GET_INTERIOR_PORTAL_ROOM_FROM

Parameters

• interiorId (int) — The target interior.
• portalIndex (int) — Interior portal index.

Examples

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

if interiorId ~= 0 then
  local roomIndex = 0

  local portalRoomFrom = GetInteriorPortalRoomFrom(interiorId, 0)
  print("portal " .. roomIndex .. " room FROM is: " .. portalRoomFrom)
end

GET_HELI_YAW_CONTROL

Parameters

• heli (Vehicle) — The helicopter to check.

GET_HELI_TAIL_ROTOR_HEALTH

Description: Note: This native is deprecated, please use GET_HELI_REAR_ROTOR_HEALTH instead.

Parameters

• vehicle (Vehicle) — The target vehicle.

GET_HUD_COMPONENT_ALIGN

Description: See SET_SCRIPT_GFX_ALIGN for details about how gfx align works.

Parameters

• id (int) — The hud component id.
• horizontalAlign (int*)
• verticalAlign (int*)

GET_IS_HELI_ENGINE_RUNNING

Parameters

• heli (Vehicle) — The helicopter to check

GET_INTERIOR_PORTAL_CORNER_POSITION

Parameters

• interiorId (int) — The target interior.
• portalIndex (int) — Interior portal index.
• cornerIndex (int) — Portal's corner index.
• posX (float*)
• posY (float*)
• posZ (float*)

Examples

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

if interiorId ~= 0 then
  local portalIndex = 0
  local cornerIndex = 0

  local x, y, z = GetInteriorPortalCornerPosition(interiorId, portalIndex, cornerIndex)
  print("position of portal " .. portalIndex .. "corner index " .. cornerIndex .. " is: " .. vec(x, y, z))
end

GET_INTERIOR_PORTAL_ENTITY_COUNT

Parameters

• interiorId (int) — The target interior.
• portalIndex (int) — Interior portal index.

Examples

local playerPed = PlayerPedId()
local interiorId = GetInteriorFromEntity(playerPed)
local portalIndex = 0

if interiorId ~= 0 then
  local count = GetInteriorPortalEntityCount(interiorId, portalIndex)
  print("portal " .. portalIndex .." entity count is: " .. count)
end

GET_HELI_REAR_ROTOR_HEALTH

Description: This native is a getter for SET_HELI_TAIL_ROTOR_HEALTH

Parameters

• vehicle (Vehicle) — The target vehicle.

GET_INTERIOR_ROOM_FLAG

Parameters

• interiorId (int) — The target interior.
• roomIndex (int) — Interior room index.

Examples

local playerPed = PlayerPedId()
local interiorId = GetInteriorFromEntity(playerPed)
local roomHash = GetRoomKeyFromEntity(playerPed)
local roomId = GetInteriorRoomIndexByHash(interiorId, roomHash)

if roomId ~= -1 then
  local roomFlag = GetInteriorRoomFlag(interiorId, roomId)
  print("current room flag is: " .. roomFlag)
end

GET_INSTANCE_ID

GET_HUD_COMPONENT_SIZE

Parameters

• id (int) — The hud component id.

GET_IS_VEHICLE_ENGINE_RUNNING

GET_INTERIOR_POSITION

Parameters

• interiorId (int) — The target interior.
• posX (float*)
• posY (float*)
• posZ (float*)

Examples

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_ROOM_NAME

Parameters

• interiorId (int) — The target interior.
• roomIndex (int) — Interior room index.

Examples

local playerPed = PlayerPedId()
local interiorId = GetInteriorFromEntity(playerPed)
local roomHash = GetRoomKeyFromEntity(playerPed)
local roomId = GetInteriorRoomIndexByHash(interiorId, roomHash)

if roomId ~= -1 then
  local roomName = GetInteriorRoomName(interiorId, roomId)
  print("current room name is: " .. roomName)
end

GET_HELI_GAS_TANK_HEALTH

Description: Note This native will always return 1000.0 unless SET_VEHICLE_BODY_HEALTH, SET_VEHICLE_ENGINE_HEALTH, or SET_VEHICLE_PETROL_TANK_HEALTH have been called with a value greater than 1000.0.

Parameters

• heli (Vehicle) — The helicopter to check

GET_HELI_ROLL_CONTROL

Parameters

• heli (Vehicle) — The helicopter to check.

GET_INTERIOR_PORTAL_ENTITY_POSITION

Parameters

• interiorId (int) — The target interior.
• portalIndex (int) — Interior portal index.
• entityIndex (int) — Portal entity index.
• posX (float*)
• posY (float*)
• posZ (float*)

Examples

local playerPed = PlayerPedId()
local interiorId = GetInteriorFromEntity(playerPed)
local portalIndex = 0

if interiorId ~= 0 then
  local count = GetInteriorPortalEntityCount(interiorId, portalIndex)
  for i=0, count-1 do
    local x, y, z = GetInteriorPortalEntityPosition(interiorId, portalIndex, i)
    print("portal " .. portalIndex .." entity " .. i .. " position is: " .. vec3(x, y, z))
  end
end

GET_INTERIOR_ROOM_COUNT

Parameters

• interiorId (int) — The target interior.

Examples

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

if interiorId ~= 0 then
  local count = GetInteriorRoomCount(interiorId)
  print("interior " .. interiorId .. "has " .. count .. " rooms")
end

GET_INTERIOR_PORTAL_FLAG

Parameters

• interiorId (int) — The target interior.
• portalIndex (int) — Interior portal index.

Examples

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

if interiorId ~= 0 then
  local portalFlag = GetInteriorPortalFlag(interiorId, 0)
  print("portal 0 flag is: " .. portalRoomFrom)
end

GET_LANDING_GEAR_STATE

Description: See the client-side GET_LANDING_GEAR_STATE native for a description of landing gear states.

Parameters

• vehicle (Vehicle) — The vehicle to check.

GET_INTERIOR_ROOM_INDEX_BY_HASH

Parameters

• interiorId (int) — The target interior.
• roomHash (int) — Interior room hash.

Examples

local playerPed = PlayerPedId()
local interiorId = GetInteriorFromEntity(playerPed)
local roomHash = GetRoomKeyFromEntity(playerPed)
local roomId = GetInteriorRoomIndexByHash(interiorId, roomHash)

if roomId ~= -1 then
  print("current room index is: " .. roomId)
end

GET_INVOKING_RESOURCE

GET_NUI_CURSOR_POSITION

GET_INTERIOR_PORTAL_ROOM_TO

Parameters

• interiorId (int) — The target interior.
• portalIndex (int) — Interior portal index.

Examples

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

if interiorId ~= 0 then
  local roomIndex = 0

  local portalRoomTo = GetInteriorPortalRoomTo(interiorId, 0)
  print("portal " .. roomIndex .. " room TO is: " .. portalRoomTo)
end

GET_INTERIOR_ROOM_TIMECYCLE

Parameters

• interiorId (int) — The target interior.
• roomIndex (int) — Interior room index.

Examples

local playerPed = PlayerPedId()
local interiorId = GetInteriorFromEntity(playerPed)
local roomHash = GetRoomKeyFromEntity(playerPed)
local roomId = GetInteriorRoomIndexByHash(interiorId, roomHash)

if roomId ~= -1 then
  local roomTimecycle = GetInteriorRoomTimecycle(interiorId, roomId)
  print("current room timecycle hash is: " .. roomTimecycle)
end

GET_INTERIOR_ROTATION

Parameters

• interiorId (int) — The target interior.
• rotx (float*)
• rotY (float*)
• rotZ (float*)
• rotW (float*)

Examples

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

if interiorId ~= 0 then
  local x, y, z, w = GetInteriorRotation(interiorId)
  print("current interior " .. interiorId .. " rotation is: " .. vec(x, y, z, w))
end

GET_NUMBER_OF_PED_COLLECTION_TEXTURE_VARIATIONS

Description: An alternative to GET_NUMBER_OF_PED_TEXTURE_VARIATIONS that uses local collection indexing instead of the global one.

Parameters

• ped (Ped) — The target ped
• componentId (int) — One of the components from SET_PED_COMPONENT_VARIATION
• collection (char*) — Name of the collection. Empty string for the base game collection. See GET_PED_COLLECTION_NAME in order to list all available collections.
• drawableId (int) — Local drawable Id inside the given collection. Refer to GET_NUMBER_OF_PED_COLLECTION_DRAWABLE_VARIATIONS.

GET_NET_TYPE_FROM_ENTITY

Description: Gets the specific entity type (as an integer), which can be one of the following defined down below:

FiveM:

enum eNetObjEntityType
{
    Automobile = 0,
    Bike = 1,
    Boat = 2,
    Door = 3,
    Heli = 4,
    Object = 5,
    Ped = 6,
    Pickup = 7,
    PickupPlacement = 8,
    Plane = 9,
    Submarine = 10,
    Player = 11,
    Trailer = 12,
    Train = 13
};

RedM:

enum eNetObjEntityType
{
    Animal = 0,
    Automobile = 1,
    Bike = 2,
    Boat = 3,
    Door = 4,
    Heli = 5,
    Object = 6,
    Ped = 7,
    Pickup = 8,
    PickupPlacement = 9,
    Plane = 10,
    Submarine = 11,
    Player = 12,
    Trailer = 13,
    Train = 14,
    DraftVeh = 15,
    StatsTracker = 16,
    PropSet = 17,
    AnimScene = 18,
    GroupScenario = 19,
    Herd = 20,
    Horse = 21,
    WorldState = 22,
    WorldProjectile = 23,
    Incident = 24,
    Guardzone = 25,
    PedGroup = 26,
    CombatDirector = 27,
    PedSharedTargeting = 28,
    Persistent = 29
};

Parameters

• entity (Entity) — The entity to get the specific type of.

GET_INTERIOR_ROOM_EXTENTS

Parameters

• interiorId (int) — The target interior.
• roomIndex (int) — Interior room index.
• bbMinX (float*)
• bbMinY (float*)
• bbMinZ (float*)
• bbMaxX (float*)
• bbMaxY (float*)
• bbMaxZ (float*)

Examples

local playerPed = PlayerPedId()
local interiorId = GetInteriorFromEntity(playerPed)
local roomHash = GetRoomKeyFromEntity(playerPed)
local roomId = GetInteriorRoomIndexByHash(interiorId, roomHash)

if roomId ~= -1 then
  local minX, minY, minZ, maxX, maxY, maxZ = GetInteriorRoomExtents(interiorId, roomId)
  print("current room extents is: " .. vec(minX, minY, minZ) .." / " .. vec(maxX, maxY, maxZ))
end

GET_INTERIOR_PORTAL_COUNT

Parameters

• interiorId (int) — The target interior.

Examples

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

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

GET_LAST_PED_IN_VEHICLE_SEAT

Parameters

• vehicle (Vehicle) — The target vehicle.
• seatIndex (int) — See eSeatPosition declared in IS_VEHICLE_SEAT_FREE.

GET_NUMBER_OF_PED_COLLECTION_PROP_DRAWABLE_VARIATIONS

Description: An analogue of GET_NUMBER_OF_PED_PROP_DRAWABLE_VARIATIONS that returns number of prop variations inside a single collection instead of the total number across all collections.

Parameters

• ped (Ped) — The target ped
• anchorPoint (int) — One of the anchor points from SET_PED_PROP_INDEX
• collection (char*) — Name of the collection. Empty string for the base game collection. See GET_PED_COLLECTION_NAME in order to list all available collections.

GET_NUM_RESOURCES

GET_PARKED_VEHICLE_DENSITY_MULTIPLIER

Description: A getter for SET_PARKED_VEHICLE_DENSITY_MULTIPLIER_THIS_FRAME.

GET_IS_VEHICLE_PRIMARY_COLOUR_CUSTOM

GET_PAUSE_MAP_POINTER_WORLD_POSITION

Description: Returns the world position the pointer is hovering on the pause map.

GET_MAP_ZOOM_DATA_LEVEL

Description: Returns the zoom level data by index from mapzoomdata.meta file.

Parameters

• index (int) — Zoom level index.
• zoomScale (float*) — fZoomScale value.
• zoomSpeed (float*) — fZoomSpeed value.
• scrollSpeed (float*) — fScrollSpeed value.
• tilesX (float*) — vTiles X.
• tilesY (float*) — vTiles Y.

GET_NUMBER_OF_PED_COLLECTION_PROP_TEXTURE_VARIATIONS

Description: An alternative to GET_NUMBER_OF_PED_PROP_TEXTURE_VARIATIONS that uses local collection indexing instead of the global one.

Parameters

• ped (Ped) — The target ped
• anchorPoint (int) — One of the anchor points from SET_PED_PROP_INDEX
• collection (char*) — Name of the collection. Empty string for the base game collection. See GET_PED_COLLECTION_NAME in order to list all available collections.
• propIndex (int) — Local prop index inside the given collection. Refer to GET_NUMBER_OF_PED_COLLECTION_PROP_DRAWABLE_VARIATIONS.

GET_NUM_PLAYER_IDENTIFIERS

GET_PED_COLLECTION_NAME_FROM_DRAWABLE

Description: Gets collection name for the given global drawable ID. Together with GET_PED_COLLECTION_LOCAL_INDEX_FROM_DRAWABLE is used to get collection and local index (inside the given collection) of the drawable. The collection name and index are used in functions like SET_PED_COLLECTION_COMPONENT_VARIATION.

Parameters

• ped (Ped) — The target ped
• componentId (int) — One of the components from SET_PED_COMPONENT_VARIATION
• drawableId (int) — Global drawable ID. Same as set in SET_PED_COMPONENT_VARIATION. Global drawable ID points to drawables as if drawables from all collections for the given component are placed into one continuous array.

Examples

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)

GET_PED_DENSITY_MULTIPLIER

Description: A getter for SET_PED_DENSITY_MULTIPLIER_THIS_FRAME.

GET_IS_VEHICLE_SECONDARY_COLOUR_CUSTOM

GET_NUM_PLAYER_INDICES

GET_MINIMAP_TYPE

Description: Get the minimap type:

0 = Off,
1 = Regular,
2 = Expanded,
3 = Simple,

GET_NUMBER_OF_PED_COLLECTION_DRAWABLE_VARIATIONS

Description: An analogue of GET_NUMBER_OF_PED_DRAWABLE_VARIATIONS that returns number of drawable variations inside a single collection instead of the total number across all collections.

Parameters

• ped (Ped) — The target ped
• componentId (int) — One of the components from SET_PED_COMPONENT_VARIATION
• collection (char*) — Name of the collection. Empty string for the base game collection. See GET_PED_COLLECTION_NAME in order to list all available collections.

GET_NETWORK_WALK_MODE

GET_PED_CAUSE_OF_DEATH

GET_NUM_PLAYER_TOKENS

GET_PASSWORD_HASH

GET_PED_DESIRED_HEADING

Parameters

• ped (Ped) — The target ped

GET_PED_DRAWABLE_VARIATION_COLLECTION_LOCAL_INDEX

Description: An analogue to GET_PED_DRAWABLE_VARIATION that returns collection local drawable index (inside GET_PED_DRAWABLE_VARIATION_COLLECTION_NAME collection) instead of the global drawable index.

Parameters

• ped (Ped) — The target ped
• componentId (int) — One of the components from SET_PED_COMPONENT_VARIATION

GET_PED_EYE_COLOR

Description: A getter for _SET_PED_EYE_COLOR. Returns -1 if fails to get.

Parameters

• ped (Ped) — The target ped

Examples

local pedEyeColour = GetPedEyeColor(PlayerPedId())
if pedEyeColour == 7 then
  print("Gray eyes!")
end

GET_PED_COLLECTION_LOCAL_INDEX_FROM_PROP

Description: Gets local index inside a collection (which can be obtained using GET_PED_COLLECTION_NAME_FROM_PROP) for the given global prop index. The collection name and index are used in functions like SET_PED_COLLECTION_PROP_INDEX.

Parameters

• ped (Ped) — The target ped
• anchorPoint (int) — One of the anchor points from SET_PED_PROP_INDEX
• propIndex (int) — Global prop index. Same as set by drawableId in SET_PED_PROP_INDEX. Global prop index points to prop as if props from all collections for the given component are placed into one continuous array.

Examples

local ped = PlayerPedId()
-- Hat for mp_f_freemode_01. From female_freemode_beach collection under index 1.
-- Global index is 21 because there is 20 head prop variations in the base game collection that goes before the female_freemode_beach collection.
local name = GetPedPropCollectionName(ped, 0, 21)
local index = GetPedPropCollectionLocalIndex(ped, 0, 21)
-- Equivalent to SetPedPropIndex(ped, 0, 21, 0, false)
SetPedCollectionPropIndex(ped, 0, name, index, 0, false)

GET_PED_COLLECTION_NAME_FROM_PROP

Description: Gets collection name for the given global prop index. Together with GET_PED_COLLECTION_LOCAL_INDEX_FROM_PROP is used to get collection and local index (inside the given collection) of the prop. The collection name and index are used in functions like SET_PED_COLLECTION_PROP_INDEX.

Parameters

• ped (Ped) — The target ped
• anchorPoint (int) — One of the anchor points from SET_PED_PROP_INDEX
• propIndex (int) — Global prop index. Same as set by drawableId in SET_PED_PROP_INDEX. Global prop index points to prop as if props from all collections for the given component are placed into one continuous array.

Examples

local ped = PlayerPedId()
-- Hat for mp_f_freemode_01. From female_freemode_beach collection under index 1.
-- Global index is 21 because there is 20 head prop variations in the base game collection that goes before the female_freemode_beach collection.
local name = GetPedPropCollectionName(ped, 0, 21)
local index = GetPedPropCollectionLocalIndex(ped, 0, 21)
-- Equivalent to SetPedPropIndex(ped, 0, 21, 0, false)
SetPedCollectionPropIndex(ped, 0, name, index, 0, false)

GET_PED_COLLECTION_LOCAL_INDEX_FROM_DRAWABLE

Description: Gets local index inside a collection (which can be obtained using GET_PED_COLLECTION_NAME_FROM_DRAWABLE) for the given global drawable ID. The collection name and index are used in functions like SET_PED_COLLECTION_COMPONENT_VARIATION.

Parameters

• ped (Ped) — The target ped
• componentId (int) — One of the components from SET_PED_COMPONENT_VARIATION
• drawableId (int) — Global drawable ID. Same as set in SET_PED_COMPONENT_VARIATION. Global drawable ID points to drawables as if drawables from all collections for the given component are placed into one continuous array.

Examples

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)

GET_NUM_RESOURCE_METADATA

Description: Gets the amount of metadata values with the specified key existing in the specified resource's manifest. See also: Resource manifest

Parameters

• resourceName (char*) — The resource name.
• metadataKey (char*) — The key to look up in the resource manifest.

GET_PED_FACE_FEATURE

Description: A getter for _SET_PED_FACE_FEATURE. Returns 0.0 if fails to get.

Parameters

• ped (Ped) — The target ped
• index (int) — Face feature index

Examples

local noseWidth = GetPedFaceFeature(PlayerPedId(), 0)
if noseWidth == 1.0 then
  print("You have big nose!")
end

GET_PED_DRAWABLE_VARIATION_COLLECTION_NAME

Description: An analogue to GET_PED_DRAWABLE_VARIATION that returns collection name instead of the global drawable index.

Should be used together with GET_PED_DRAWABLE_VARIATION_COLLECTION_LOCAL_INDEX.

Parameters

• ped (Ped) — The target ped
• componentId (int) — One of the components from SET_PED_COMPONENT_VARIATION

GET_PED_COLLECTION_NAME

Description: Returns name of collection under given index for the given Ped.

Collections are groups of drawable components or props available for the given Ped. Usually collection corresponds to a certain DLC or the base game. See SET_PED_COLLECTION_COMPONENT_VARIATION, SET_PED_COLLECTION_PROP_INDEX, GET_NUMBER_OF_PED_COLLECTION_DRAWABLE_VARIATIONS etc natives for more details on how to work with collections.

GET_PED_COLLECTION_NAME can be used together with GET_PED_COLLECTIONS_COUNT to list all collections attached to Ped.

Parameters

• ped (Ped) — The target ped
• index (int) — The target collection index

Examples

local ped = PlayerPedId()
local count = GetPedCollectionsCount(ped)
for i = 0, count - 1 do
  print(GetPedCollectionName(ped, i))
end

GET_PED_DECORATIONS

Description: Returns a list of decorations applied to a ped.

The data returned adheres to the following layout:

[ [ collectionHash1, overlayHash1 ], ..., [c ollectionHashN, overlayHashN ] ]

This command will return undefined data if invoked on a remote player ped.

Parameters

• ped (Ped) — The ped you want to retrieve data for.

GET_PED_HAIR_COLOR

Description: A getter for _SET_PED_HAIR_COLOR. Returns -1 if fails to get.