ENTITY Natives - Part 2 of 6

Red Dead Redemption 3 Native Functions Reference

Namespace: ENTITY
Natives in this file: 50
Total natives in namespace: 268
Generated from: RDR3natives JSON data

GET_NEAREST_PLAYER_TO_ENTITY_ON_TEAM

Parameters

• entity (Entity)
• team (int)
• playerPedToIgnore (Ped)
• flags (int)

Usage

Lua (Direct):

local result = GetNearestPlayerToEntityOnTeam(entity, team, playerPedToIgnore, flags)

Lua (Hash):

local result = Citizen.InvokeNative(0xB2C30C3B4AFF718C, entity, team, playerPedToIgnore, flags)

GET_OBJECT_INDEX_FROM_ENTITY_INDEX

Description: Simply returns whatever is passed to it (Regardless of whether the handle is valid or not).

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = GetObjectIndexFromEntityIndex(entity)

Lua (Hash):

local result = Citizen.InvokeNative(0x280BBE5601EAA983, entity)

GET_OFFSET_FROM_ENTITY_GIVEN_WORLD_COORDS

Parameters

• entity (Entity)
• posX (float)
• posY (float)
• posZ (float)

Usage

Lua (Direct):

local result = GetOffsetFromEntityGivenWorldCoords(entity, posX, posY, posZ)

Lua (Hash):

local result = Citizen.InvokeNative(0x497C6B1A2C9AE69C, entity, posX, posY, posZ)

GET_PED_INDEX_FROM_ENTITY_INDEX

Description: Simply returns whatever is passed to it (Regardless of whether the handle is valid or not).

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = GetPedIndexFromEntityIndex(entity)

Lua (Hash):

local result = Citizen.InvokeNative(0x0F16D042BD640EA3, entity)

GET_VEHICLE_INDEX_FROM_ENTITY_INDEX

Description: Simply returns whatever is passed to it (Regardless of whether the handle is valid or not).

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = GetVehicleIndexFromEntityIndex(entity)

Lua (Hash):

local result = Citizen.InvokeNative(0xDF1E5AAC561AFC59, entity)

HAS_ANIM_EVENT_FIRED

Parameters

• entity (Entity)
• actionHash (Hash)

Usage

Lua (Direct):

local result = HasAnimEventFired(entity, actionHash)

Lua (Hash):

local result = Citizen.InvokeNative(0x5851CC48405F4A07, entity, actionHash)

HAS_COLLISION_LOADED_AROUND_ENTITY

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = HasCollisionLoadedAroundEntity(entity)

Lua (Hash):

local result = Citizen.InvokeNative(0xBEB1600952B9CF5C, entity)

HAS_COLLISION_LOADED_AROUND_POSITION

Description: Old name: _HAS_COLLISION_LOADED_AT_COORDS

Parameters

• xPos (float)
• yPos (float)
• zPos (float)

Usage

Lua (Direct):

local result = HasCollisionLoadedAroundPosition(xPos, yPos, zPos)

Lua (Hash):

local result = Citizen.InvokeNative(0x6BFBDC46139C45AB, xPos, yPos, zPos)

HAS_ENTITY_ANIM_FINISHED

Parameters

• entity (Entity)
• animDict (const char*)
• animName (const char*)
• p3 (int)

Usage

Lua (Direct):

local result = HasEntityAnimFinished(entity, animDict, animName, p3)

Lua (Hash):

local result = Citizen.InvokeNative(0xAEB40615337EF1E3, entity, animDict, animName, p3)

HAS_ENTITY_BEEN_DAMAGED_BY_ANY_OBJECT

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = HasEntityBeenDamagedByAnyObject(entity)

Lua (Hash):

local result = Citizen.InvokeNative(0x73BB763880CD23A6, entity)

HAS_ENTITY_BEEN_DAMAGED_BY_ANY_PED

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = HasEntityBeenDamagedByAnyPed(entity)

Lua (Hash):

local result = Citizen.InvokeNative(0x9934E9C42D52D87E, entity)

HAS_ENTITY_BEEN_DAMAGED_BY_ANY_VEHICLE

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = HasEntityBeenDamagedByAnyVehicle(entity)

Lua (Hash):

local result = Citizen.InvokeNative(0x695D7C26DE65C423, entity)

HAS_ENTITY_BEEN_DAMAGED_BY_ENTITY

Parameters

• entity1 (Entity)
• entity2 (Entity)
• p2 (BOOL)
• p3 (BOOL)

Usage

Lua (Direct):

local result = HasEntityBeenDamagedByEntity(entity1, entity2, p2, p3)

Lua (Hash):

local result = Citizen.InvokeNative(0x7B6E7BEC1143AC86, entity1, entity2, p2, p3)

HAS_ENTITY_CLEAR_LOS_TO_COORD

Parameters

• entity (Entity)
• x (float)
• y (float)
• z (float)
• flags (int)

Usage

Lua (Direct):

local result = HasEntityClearLosToCoord(entity, x, y, z, flags)

Lua (Hash):

local result = Citizen.InvokeNative(0x0C9DBF48C6BA6E4C, entity, x, y, z, flags)

HAS_ENTITY_CLEAR_LOS_TO_ENTITY_IN_FRONT

Description: Has the entity1 got a clear line of sight to the other entity2 from the direction entity1 is facing.

Parameters

• entity1 (Entity)
• entity2 (Entity)
• traceType (int)

Usage

Lua (Direct):

local result = HasEntityClearLosToEntityInFront(entity1, entity2, traceType)

Lua (Hash):

local result = Citizen.InvokeNative(0xE88F19660651D566, entity1, entity2, traceType)

HAS_ENTITY_COLLIDED_WITH_ANYTHING

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = HasEntityCollidedWithAnything(entity)

Lua (Hash):

local result = Citizen.InvokeNative(0xDF18751EC74F90FF, entity)

IS_AN_ENTITY

Parameters

• handle (ScrHandle)

Usage

Lua (Direct):

local result = IsAnEntity(handle)

Lua (Hash):

local result = Citizen.InvokeNative(0x27CFF3E5A286D3DF, handle)

IS_ENTITY_AN_OBJECT

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = IsEntityAnObject(entity)

Lua (Hash):

local result = Citizen.InvokeNative(0x0A27A546A375FDEF, entity)

IS_ENTITY_ATTACHED

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = IsEntityAttached(entity)

Lua (Hash):

local result = Citizen.InvokeNative(0xEE6AD63ABF59C0B7, entity)

IS_ENTITY_ATTACHED_TO_ANY_OBJECT

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = IsEntityAttachedToAnyObject(entity)

Lua (Hash):

local result = Citizen.InvokeNative(0x306C1F6178F01AB3, entity)

IS_ENTITY_ATTACHED_TO_ANY_PED

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = IsEntityAttachedToAnyPed(entity)

Lua (Hash):

local result = Citizen.InvokeNative(0xC841153DED2CA89A, entity)

IS_ENTITY_ATTACHED_TO_ANY_VEHICLE

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = IsEntityAttachedToAnyVehicle(entity)

Lua (Hash):

local result = Citizen.InvokeNative(0x12DF6E0D2E736749, entity)

IS_ENTITY_ATTACHED_TO_ENTITY

Parameters

• from (Entity)
• to (Entity)

Usage

Lua (Direct):

local result = IsEntityAttachedToEntity(from, to)

Lua (Hash):

local result = Citizen.InvokeNative(0x154A3C529497053E, from, to)

IS_ENTITY_A_MISSION_ENTITY

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = IsEntityAMissionEntity(entity)

Lua (Hash):

local result = Citizen.InvokeNative(0x138190F64DB4BBD1, entity)

IS_ENTITY_A_PED

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = IsEntityAPed(entity)

Lua (Hash):

local result = Citizen.InvokeNative(0xCF8176912DDA4EA5, entity)

IS_ENTITY_A_VEHICLE

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = IsEntityAVehicle(entity)

Lua (Hash):

local result = Citizen.InvokeNative(0xC3D96AF45FCCEC4C, entity)

IS_ENTITY_DEAD

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = IsEntityDead(entity)

Lua (Hash):

local result = Citizen.InvokeNative(0x7D5B1F88E7504BBA, entity)

IS_ENTITY_IN_VOLUME

Parameters

• entity (Entity)
• volume (ScrHandle)
• p2 (BOOL)
• p3 (int)

Usage

Lua (Direct):

local result = IsEntityInVolume(entity, volume, p2, p3)

Lua (Hash):

local result = Citizen.InvokeNative(0x5A5526BC09C06623, entity, volume, p2, p3)

IS_ENTITY_IN_WATER

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = IsEntityInWater(entity)

Lua (Hash):

local result = Citizen.InvokeNative(0xDDE5C125AC446723, entity)

IS_ENTITY_OCCLUDED

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = IsEntityOccluded(entity)

Lua (Hash):

local result = Citizen.InvokeNative(0x140188E884645624, entity)

IS_ENTITY_ON_SCREEN

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = IsEntityOnScreen(entity)

Lua (Hash):

local result = Citizen.InvokeNative(0x613C15D5D8DB781F, entity)

IS_ENTITY_PLAYING_ANIM

Usage

Lua (Direct):

local result = IsEntityPlayingAnim(entity, animDict, animName, animType)

Lua (Hash):

local result = Citizen.InvokeNative(0xDEE49D5CA6C49148, entity, animDict, animName, animType)

IS_ENTITY_STATIC

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = IsEntityStatic(entity)

Lua (Hash):

local result = Citizen.InvokeNative(0x86468ADFA0F6B861, entity)

IS_ENTITY_TOUCHING_ENTITY

Parameters

• entity (Entity)
• targetEntity (Entity)

Usage

Lua (Direct):

local result = IsEntityTouchingEntity(entity, targetEntity)

Lua (Hash):

local result = Citizen.InvokeNative(0x9A2304A64C3C8423, entity, targetEntity)

IS_ENTITY_TOUCHING_MODEL

Parameters

• entity (Entity)
• modelHash (Hash)

Usage

Lua (Direct):

local result = IsEntityTouchingModel(entity, modelHash)

Lua (Hash):

local result = Citizen.InvokeNative(0x2AE3EBC8DEB9768B, entity, modelHash)

IS_ENTITY_UPRIGHT

Parameters

• entity (Entity)
• angle (float)

Usage

Lua (Direct):

local result = IsEntityUpright(entity, angle)

Lua (Hash):

local result = Citizen.InvokeNative(0xF6F6AFD8D4FB2658, entity, angle)

IS_ENTITY_UPSIDEDOWN

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = IsEntityUpsidedown(entity)

Lua (Hash):

local result = Citizen.InvokeNative(0x109DE3DA41AAD94A, entity)

IS_ENTITY_VISIBLE

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = IsEntityVisible(entity)

Lua (Hash):

local result = Citizen.InvokeNative(0xFFC96ECB7FA404CA, entity)

IS_ENTITY_VISIBLE_TO_SCRIPT

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = IsEntityVisibleToScript(entity)

Lua (Hash):

local result = Citizen.InvokeNative(0xF213C724E77F321A, entity)

IS_ENTITY_WAITING_FOR_WORLD_COLLISION

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = IsEntityWaitingForWorldCollision(entity)

Lua (Hash):

local result = Citizen.InvokeNative(0x5E1CC2E8DC3111DD, entity)

IS_MAP_ENTITY_PINNED

Parameters

• p0 (Any)

Usage

Lua (Direct):

local result = IsMapEntityPinned(p0)

Lua (Hash):

local result = Citizen.InvokeNative(0x1FF441D7954F8709, p0)

PIN_CLOSEST_MAP_ENTITY

Parameters

• modelHash (Hash)
• x (float)
• y (float)
• z (float)
• flags (int)

Usage

Lua (Direct):

local result = PinClosestMapEntity(modelHash, x, y, z, flags)

Lua (Hash):

local result = Citizen.InvokeNative(0x6F3068258A499E52, modelHash, x, y, z, flags)

End of ENTITY natives part 2

GET_OFFSET_FROM_ENTITY_IN_WORLD_COORDS

Description: ``` Offset values are relative to the entity.
x = left/right
y = forward/backward
z = up/down

### Usage

**Lua (Direct):**
```lua
local result = GetOffsetFromEntityInWorldCoords(entity, offsetX, offsetY, offsetZ)

Lua (Hash):

local result = Citizen.InvokeNative(0x1899F328B0E12848, entity, offsetX, offsetY, offsetZ)

GET_WORLD_POSITION_OF_ENTITY_BONE

Description: Returns the coordinates of an entity-bone. https://github.com/femga/rdr3_discoveries/tree/master/boneNames

Usage

Lua (Direct):

local result = GetWorldPositionOfEntityBone(entity, boneIndex)

Lua (Hash):

local result = Citizen.InvokeNative(0x82CFA50E34681CA5, entity, boneIndex)

HAS_ENTITY_CLEAR_LOS_TO_ENTITY

Description: Checks if entity1 has a clear line of sight to entity2. So a simple raycast which if it collides with any of the given colliderTypes returns false.

The direction of the check matters with for example bushes, so checking from inside to outside a bush with traceType 256 returns true, but the other way around returns false.

Parameters

• entity1 (Entity) — Entity to start from
• entity2 (Entity) — Entity to check to
• flags (int) — A bit mask with bits 1, 2, 4, etc, relating to collider types (see: START_EXPENSIVE_SYNCHRONOUS_SHAPE_TEST_LOS_PROBE). 17 is most common in GTA scripts.

Usage

Lua (Direct):

local result = HasEntityClearLosToEntity(entity1, entity2, flags)

Lua (Hash):

local result = Citizen.InvokeNative(0xFCDFF7B72D23A1AC, entity1, entity2, flags)

IS_ENTITY_AT_COORD

Description: Checks if entity is within x/y/zSize distance of x/y/z.

Last three are unknown ints, almost always p7 = 0, p8 = 1, p9 = 0

Usage

Lua (Direct):

local result = IsEntityAtCoord(entity, xPos, yPos, zPos, xSize, ySize, zSize, p7, p8, p9)

Lua (Hash):

local result = Citizen.InvokeNative(0x5E58342602E94718, entity, xPos, yPos, zPos, xSize, ySize, zSize, p7, p8, p9)

IS_ENTITY_AT_ENTITY

Description: Checks if entity1 is within the box defined by x/y/zSize of entity2.

Last three parameters are almost always p5 = 0, p6 = 1, p7 = 0

Usage

Lua (Direct):

local result = IsEntityAtEntity(entity1, entity2, xSize, ySize, zSize, p5, p6, p7)

Lua (Hash):

local result = Citizen.InvokeNative(0xC057F02B837A27F6, entity1, entity2, xSize, ySize, zSize, p5, p6, p7)

IS_ENTITY_IN_AIR

Usage

Lua (Direct):

local result = IsEntityInAir(entity)

Lua (Hash):

local result = Citizen.InvokeNative(0x886E37EC497200B6, entity)

IS_ENTITY_IN_ANGLED_AREA

Description: Creates a spherical cone at origin that extends to surface with the angle specified. Then returns true if the entity is inside the spherical cone

Angle is measured in degrees.

Usage

Lua (Direct):

local result = IsEntityInAngledArea(entity, originX, originY, originZ, edgeX, edgeY, edgeZ, angle, p8, p9, p10)

Lua (Hash):

local result = Citizen.InvokeNative(0xD3151E53134595E5, entity, originX, originY, originZ, edgeX, edgeY, edgeZ, angle, p8, p9, p10)

IS_ENTITY_IN_AREA

Description: [warning: You should probably use your own AABB testing as it might be faster]

Usage

Lua (Direct):

local result = IsEntityInArea()

Lua (Hash):

local result = Citizen.InvokeNative(0x0C2634C40A16193E)