ENTITY Natives - Part 1 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

APPLY_FORCE_TO_ENTITY

Parameters

• entity (Entity)
• forceFlags (int)
• x (float)
• y (float)
• z (float)
• offX (float)
• offY (float)
• offZ (float)
• boneIndex (int)
• isDirectionRel (BOOL)
• ignoreUpVec (BOOL)
• isForceRel (BOOL)
• p12 (BOOL)
• p13 (BOOL)

Usage

Lua (Direct):

ApplyForceToEntity(entity, forceFlags, x, y, z, offX, offY, offZ, boneIndex, isDirectionRel, ignoreUpVec, isForceRel, p12, p13)

Lua (Hash):

Citizen.InvokeNative(0xF15E8F5D333F09C4, entity, forceFlags, x, y, z, offX, offY, offZ, boneIndex, isDirectionRel, ignoreUpVec, isForceRel, p12, p13)

ATTACH_ENTITY_TO_ENTITY_PHYSICALLY

Parameters

• entity1 (Entity)
• entity2 (Entity)
• p2 (int)
• boneIndex (int)
• offsetX (float)
• offsetY (float)
• offsetZ (float)
• p7 (float)
• p8 (float)
• p9 (float)
• p10 (float)
• p11 (float)
• p12 (float)
• p13 (float)
• p14 (BOOL)
• p15 (BOOL)
• p16 (BOOL)
• p17 (BOOL)
• p18 (int)
• p19 (BOOL)
• p20 (float)
• p21 (float)

Usage

Lua (Direct):

AttachEntityToEntityPhysically(entity1, entity2, p2, boneIndex, offsetX, offsetY, offsetZ, p7, p8, p9, p10, p11, p12, p13, p14, p15, p16, p17, p18, p19, p20, p21)

Lua (Hash):

Citizen.InvokeNative(0xB629A43CA1643481, entity1, entity2, p2, boneIndex, offsetX, offsetY, offsetZ, p7, p8, p9, p10, p11, p12, p13, p14, p15, p16, p17, p18, p19, p20, p21)

CLEAR_ENTITY_LAST_DAMAGE_ENTITY

Parameters

• entity (Entity)

Usage

Lua (Direct):

ClearEntityLastDamageEntity(entity)

Lua (Hash):

Citizen.InvokeNative(0xBB19AC7D4DCEFD0F, entity)

CREATE_FORCED_OBJECT

Parameters

• x (float)
• y (float)
• z (float)
• p3 (Any)
• modelHash (Hash)
• p5 (BOOL)

Usage

Lua (Direct):

CreateForcedObject(x, y, z, p3, modelHash, p5)

Lua (Hash):

Citizen.InvokeNative(0x0961A905AFBC34C7, x, y, z, p3, modelHash, p5)

CREATE_MODEL_HIDE

Parameters

• x (float)
• y (float)
• z (float)
• radius (float)
• model (Hash)
• p5 (BOOL)

Usage

Lua (Direct):

CreateModelHide(x, y, z, radius, model, p5)

Lua (Hash):

Citizen.InvokeNative(0x069848B3FB3C4426, x, y, z, radius, model, p5)

CREATE_MODEL_HIDE_EXCLUDING_SCRIPT_OBJECTS

Parameters

• x (float)
• y (float)
• z (float)
• radius (float)
• model (Hash)
• p5 (BOOL)

Usage

Lua (Direct):

CreateModelHideExcludingScriptObjects(x, y, z, radius, model, p5)

Lua (Hash):

Citizen.InvokeNative(0xD136090A9AAAB17D, x, y, z, radius, model, p5)

CREATE_MODEL_SWAP

Description: Only works with objects!

Parameters

• x (float)
• y (float)
• z (float)
• radius (float)
• originalModel (Hash)
• newModel (Hash)
• p6 (BOOL)

Usage

Lua (Direct):

CreateModelSwap(x, y, z, radius, originalModel, newModel, p6)

Lua (Hash):

Citizen.InvokeNative(0x10B2218320B6F5AC, x, y, z, radius, originalModel, newModel, p6)

DELETE_ENTITY

Description: Deletes the specified entity, then sets the handle pointed to by the pointer to NULL.

Parameters

• entity (Entity*)

Usage

Lua (Direct):

DeleteEntity(entity)

Lua (Hash):

Citizen.InvokeNative(0x4CD38C78BD19A497, entity)

DETACH_ENTITY

Parameters

• entity (Entity)
• p1 (BOOL)
• collision (BOOL)

Usage

Lua (Direct):

DetachEntity(entity, p1, collision)

Lua (Hash):

Citizen.InvokeNative(0x64CDE9D6BF8ECAD3, entity, p1, collision)

DOES_ENTITY_BELONG_TO_THIS_SCRIPT

Parameters

• entity (Entity)
• p1 (BOOL)

Usage

Lua (Direct):

local result = DoesEntityBelongToThisScript(entity, p1)

Lua (Hash):

local result = Citizen.InvokeNative(0x622B1980CBE13332, entity, p1)

DOES_ENTITY_EXIST

Description: Checks if the Entity exists

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = DoesEntityExist(entity)

Lua (Hash):

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

DOES_ENTITY_HAVE_DRAWABLE

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = DoesEntityHaveDrawable(entity)

Lua (Hash):

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

DOES_ENTITY_HAVE_PHYSICS

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = DoesEntityHavePhysics(entity)

Lua (Hash):

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

FIND_ANIM_EVENT_PHASE

Parameters

• animDictionary (const char*)
• animName (const char*)
• p2 (const char*)
• p3 (Any*)
• p4 (Any*)

Usage

Lua (Direct):

local result = FindAnimEventPhase(animDictionary, animName, p2, p3, p4)

Lua (Hash):

local result = Citizen.InvokeNative(0x42718CC559BD7776, animDictionary, animName, p2, p3, p4)

FORCE_ENTITY_AI_AND_ANIMATION_UPDATE

Parameters

• entity (Entity)
• p1 (BOOL)

Usage

Lua (Direct):

ForceEntityAiAndAnimationUpdate(entity, p1)

Lua (Hash):

Citizen.InvokeNative(0x4C9E96473D4F1A88, entity, p1)

FREEZE_ENTITY_POSITION

Parameters

• entity (Entity)
• toggle (BOOL)

Usage

Lua (Direct):

FreezeEntityPosition(entity, toggle)

Lua (Hash):

Citizen.InvokeNative(0x7D9EFB7AD6B19754, entity, toggle)

GET_ANIM_DURATION

Parameters

• animDict (const char*)
• animName (const char*)

Usage

Lua (Direct):

local result = GetAnimDuration(animDict, animName)

Lua (Hash):

local result = Citizen.InvokeNative(0x9FFAF4940A54CC09, animDict, animName)

GET_ENTITY_ALPHA

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = GetEntityAlpha(entity)

Lua (Hash):

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

GET_ENTITY_ATTACHED_TO

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = GetEntityAttachedTo(entity)

Lua (Hash):

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

GET_ENTITY_BONE_INDEX_BY_NAME

Parameters

• entity (Entity)
• boneName (const char*)

Usage

Lua (Direct):

local result = GetEntityBoneIndexByName(entity, boneName)

Lua (Hash):

local result = Citizen.InvokeNative(0xBACA8FE9C76C124E, entity, boneName)

GET_ENTITY_COLLISION_DISABLED

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = GetEntityCollisionDisabled(entity)

Lua (Hash):

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

GET_ENTITY_FORWARD_VECTOR

Description: Gets the entity's forward vector in XY(Z) eulers.

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = GetEntityForwardVector(entity)

Lua (Hash):

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

GET_ENTITY_FORWARD_X

Description: Gets the X-component of the entity's forward vector.

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = GetEntityForwardX(entity)

Lua (Hash):

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

GET_ENTITY_FORWARD_Y

Description: Gets the Y-component of the entity's forward vector.

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = GetEntityForwardY(entity)

Lua (Hash):

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

GET_ENTITY_HEADING

Description: Returns the heading of the entity in degrees. Also know as the "Yaw" of an entity.

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = GetEntityHeading(entity)

Lua (Hash):

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

GET_ENTITY_HEALTH

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = GetEntityHealth(entity)

Lua (Hash):

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

GET_ENTITY_HEIGHT

Parameters

• entity (Entity)
• X (float)
• Y (float)
• Z (float)
• atTop (BOOL)
• inWorldCoords (BOOL)

Usage

Lua (Direct):

local result = GetEntityHeight(entity, X, Y, Z, atTop, inWorldCoords)

Lua (Hash):

local result = Citizen.InvokeNative(0x296DEBC84474B375, entity, X, Y, Z, atTop, inWorldCoords)

GET_ENTITY_HEIGHT_ABOVE_GROUND

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = GetEntityHeightAboveGround(entity)

Lua (Hash):

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

GET_ENTITY_LOD_DIST

Description: Returns the LOD distance of an entity.

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = GetEntityLodDist(entity)

Lua (Hash):

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

GET_ENTITY_MATRIX

Parameters

• entity (Entity)
• rightVector (Vector3*)
• forwardVector (Vector3*)
• upVector (Vector3*)
• position (Vector3*)

Usage

Lua (Direct):

GetEntityMatrix(entity, rightVector, forwardVector, upVector, position)

Lua (Hash):

Citizen.InvokeNative(0x3A9B1120AF13FBF2, entity, rightVector, forwardVector, upVector, position)

GET_ENTITY_MODEL

Description: Returns the model hash from the entity

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = GetEntityModel(entity)

Lua (Hash):

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

GET_ENTITY_PITCH

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = GetEntityPitch(entity)

Lua (Hash):

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

GET_ENTITY_POPULATION_TYPE

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = GetEntityPopulationType(entity)

Lua (Hash):

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

GET_ENTITY_ROTATION

Parameters

• entity (Entity)
• rotationOrder (int)

Usage

Lua (Direct):

local result = GetEntityRotation(entity, rotationOrder)

Lua (Hash):

local result = Citizen.InvokeNative(0xE09CAF86C32CB48F, entity, rotationOrder)

GET_ENTITY_SPEED

Description: Result is in meters per second (m/s)

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = GetEntitySpeed(entity)

Lua (Hash):

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

GET_ENTITY_SPEED_VECTOR

Parameters

• entity (Entity)
• relative (BOOL)

Usage

Lua (Direct):

local result = GetEntitySpeedVector(entity, relative)

Lua (Hash):

local result = Citizen.InvokeNative(0xF2DB09816A419DC5, entity, relative)

GET_ENTITY_SUBMERGED_LEVEL

Description: Get how much of the entity is submerged. 1.0f is whole entity.

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = GetEntitySubmergedLevel(entity)

Lua (Hash):

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

GET_ENTITY_TYPE

Description: Returns entityType: https://github.com/Halen84/RDR3-Native-Flags-And-Enums/tree/main/eEntityType

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = GetEntityType(entity)

Lua (Hash):

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

GET_ENTITY_UPRIGHT_VALUE

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = GetEntityUprightValue(entity)

Lua (Hash):

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

GET_IS_ANIMAL

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = GetIsAnimal(entity)

Lua (Hash):

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

GET_MATCHING_ENTITIES

Parameters

• volume (Volume)
• itemSet (ItemSet)
• entityType (int)
• p3 (Any)
• p4 (Hash)
• p5 (const char*)

Usage

Lua (Direct):

local result = GetMatchingEntities(volume, itemSet, entityType, p3, p4, p5)

Lua (Hash):

local result = Citizen.InvokeNative(0x84CCF9A12942C83D, volume, itemSet, entityType, p3, p4, p5)

GET_NEAREST_PARTICIPANT_TO_ENTITY

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = GetNearestParticipantToEntity(entity)

Lua (Hash):

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

GET_NEAREST_PLAYER_TO_ENTITY

Parameters

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

Usage

Lua (Direct):

local result = GetNearestPlayerToEntity(entity, playerPedToIgnore, flags)

Lua (Hash):

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

End of ENTITY natives part 1

APPLY_FORCE_TO_ENTITY_CENTER_OF_MASS

Description: p6/relative - makes the xyz force not relative to world coords, but to something else p7/highForce - setting false will make the force really low

Usage

Lua (Direct):

ApplyForceToEntityCenterOfMass(entity, forceType, x, y, z, component, isDirectionRel, isForceRel, p8)

Lua (Hash):

Citizen.InvokeNative(0x31DA7CEC5334DB37, entity, forceType, x, y, z, component, isDirectionRel, isForceRel, p8)

ATTACH_ENTITY_TO_ENTITY

Description: Attaches entity1 to bone (boneIndex) of entity2.

boneIndex - this is different to boneID, use GET_PED_BONE_INDEX to get the index from the ID. use the index for attaching to specific bones. entity1 will be attached to entity2's centre if bone index given doesn't correspond to bone indexes for that entity type. https://github.com/femga/rdr3_discoveries/tree/master/boneNames

useSoftPinning - if set to false attached entity will not detach when fixed collision - controls collision between the two entities (FALSE disables collision). isPed - pitch doesn't work when false and roll will only work on negative numbers (only peds) vertexIndex - position of vertex fixedRot - if false it ignores entity vector

Parameters

• entity1 (Entity) — Entity to attach.
• entity2 (Entity) — Entity to attach entity1 with.
• boneIndex (int) — This is different to boneID, use 'GET_PED_BONE_INDEX' to get the index from the ID. use the index for attaching to specific bones. entity1 will be attached to the center of entity2 if bone index given doesn't correspond to bone indexes for that entity type.
• xPos (float) — X-axis offset from the center of entity2.
• yPos (float) — Y-axis offset from the center of entity2.
• zPos (float) — Z-axis offset from the center of entity2.
• xRot (float) — X-axis rotation.
• yRot (float) — Y-axis rotation.
• zRot (float) — Z-axis rotation.
• p9 (BOOL) — Unknown. Does not seem to have any effect.
• useSoftPinning (BOOL) — If set to false attached entity will not detach when fixed.
• collision (BOOL) — Controls collision between the two entities (FALSE disables collision).
• isPed (BOOL) — Pitch doesnt work when false and roll will only work on negative numbers (only peds)
• rotationOrder (int) — The order in which the rotation is applied. See GET_ENTITY_ROTATION
• syncRot (BOOL) — If false it ignores entity rotation.

Usage

Lua (Direct):

AttachEntityToEntity(entity1, entity2, boneIndex, xPos, yPos, zPos, xRot, yRot, zRot, p9, useSoftPinning, collision, isPed, rotationOrder, syncRot)

Lua (Hash):

Citizen.InvokeNative(0x6B9BBD38AB0796DF, entity1, entity2, boneIndex, xPos, yPos, zPos, xRot, yRot, zRot, p9, useSoftPinning, collision, isPed, rotationOrder, syncRot)

GET_CARRIABLE_ENTITY_STATE

Description: enum eCarriableState { CARRIABLE_STATE_NONE, CARRIABLE_STATE_TRANSITIONING_TO_HOGTIED, CARRIABLE_STATE_CARRIABLE_INTRO, CARRIABLE_STATE_CARRIABLE, CARRIABLE_STATE_BEING_PICKED_UP_FROM_GROUND, CARRIABLE_STATE_CARRIED_BY_HUMAN, CARRIABLE_STATE_BEING_PLACED_ON_GROUND, CARRIABLE_STATE_CARRIED_BY_MOUNT, CARRIABLE_STATE_BEING_PLACED_ON_MOUNT, CARRIABLE_STATE_BEING_PICKED_UP_FROM_MOUNT, CARRIABLE_STATE_BEING_CUT_FREE, CARRIABLE_STATE_BEING_PLACED_ON_GROUND_ESCAPE, CARRIABLE_STATE_BEING_PLACED_IN_VEHICLE };

Usage

Lua (Direct):

local result = GetCarriableEntityState(entity)

Lua (Hash):

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

GET_ENTITY_COORDS

Description: Gets the current coordinates for a specified entity. entity = The entity to get the coordinates from. alive = Unused by the game, potentially used by debug builds in order to assert whether or not an entity was alive.

If entity is a ped and it's in a vehicle or on a mount the coords of that entity are returned. Set 'realCoords' to true when you need the true ped coords.

Usage

Lua (Direct):

local result = GetEntityCoords(entity, alive, realCoords)

Lua (Hash):

local result = Citizen.InvokeNative(0xA86D5F069399F44D, entity, alive, realCoords)

GET_ENTITY_MAX_HEALTH

Description: ``` Return an integer value of entity's maximum health.
Example:

• Player = 200

### Usage

**Lua (Direct):**
```lua
local result = GetEntityMaxHealth(entity)

Lua (Hash):

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

GET_ENTITY_ROLL

Description: Displays the current ROLL axis of the entity [-180.0000/180.0000+] (Sideways Roll) such as a vehicle tipped on its side

Usage

Lua (Direct):

local result = GetEntityRoll(entity)

Lua (Hash):

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

GET_ENTITY_VELOCITY

Usage

Lua (Direct):

local result = GetEntityVelocity(entity)

Lua (Hash):

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