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

_0xD21C7418C590BB40

Parameters

• p0 (Any)

Usage

Lua (Direct):

local result = _0xD21C7418C590BB40(p0)

Lua (Hash):

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

_SET_ENTITY_ROTATION_PARALLEL_TO_LINE

Description: Sets the entity's rotation so that it becomes parallel to the direction defined by the line between coords1 and coords2, without moving the entity from its current position.

This native does NOT make the entity face coords1 or coords2. Instead, it keeps the entity at its current world position and adjusts its orientation so that it is aligned parallel to the direction derived from the two coordinates

Usage

Lua (Direct):

SetEntityRotationParallelToLine(entity, coords1X, coords1Y, coords1Z, coords2X, coords2Y, coords2Z, p7)

Lua (Hash):

Citizen.InvokeNative(0xD45BB89B53FC0CFD, entity, coords1X, coords1Y, coords1Z, coords2X, coords2Y, coords2Z, p7)

_IS_MODEL_IN_NEED_OF_VEG_MODIFIER

Description: Checks whether the specified model can be handled through the vegetation modifier path. This is not limited strictly to foliage. Testing shows many natural world models can return TRUE, including rocks, trees, bushes, grass, crops, branches, roots, logs, debris, and similar environment assets.

Usage

Lua (Direct):

local result = IsModelInNeedOfVegModifier(modelHash)

Lua (Hash):

local result = Citizen.InvokeNative(0xD4636C2EDB0DEA8A, modelHash)

_0xD46BF94C4C66FAB0

Parameters

• p0 (Any)
• p1 (Any)
• p2 (Any)
• p3 (Any)

Usage

Lua (Direct):

local result = _0xD46BF94C4C66FAB0(p0, p1, p2, p3)

Lua (Hash):

local result = Citizen.InvokeNative(0xD46BF94C4C66FAB0, p0, p1, p2, p3)

_SET_ENTITY_PELT_TEXTURE

Description: Set the pelt texture to the entity, by albedo hash and inventory item hash Examples: object: P_CS_PELT_MEDLARGE albedo: a_c_boar_01_head_000_c0_000_ab, inventoryItem: PROVISION_BOAR_HIDE_POOR

Usage

Lua (Direct):

SetEntityPeltTexture(entity, inventoryItem, albedo, p3)

Lua (Hash):

Citizen.InvokeNative(0xDD03FC2089AD093C, entity, inventoryItem, albedo, p3)

_0xDF8E49EA89A01DB1

Description: Hardcoded to return zero/false.

Parameters

• p0 (Any)
• p1 (Any)
• p2 (Any)

Usage

Lua (Direct):

local result = _0xDF8E49EA89A01DB1(p0, p1, p2)

Lua (Hash):

local result = Citizen.InvokeNative(0xDF8E49EA89A01DB1, p0, p1, p2)

_GET_ENTITY_COLLISION_INTENSITY

Description: Returns a float that appears to represent the collision impact intensity between two entities.

Based on observed usage, this value becomes large when entity1 hits entity2 with enough force. In the example below, if the returned value is greater than 500.0f, the first entity is moving, the second entity is nearly stationary, and the second entity is not already ragdolled, then SET_PED_TO_RAGDOLL is triggered.

Usage

Lua (Direct):

local result = GetEntityCollisionIntensity(entity, entiy2)

Lua (Hash):

local result = Citizen.InvokeNative(0xDFC2B226D56D85F6, entity, entiy2)

_0xE19035EB65AB2932

Parameters

• p0 (Any)
• p1 (Any)

Usage

Lua (Direct):

_0xE19035EB65AB2932(p0, p1)

Lua (Hash):

Citizen.InvokeNative(0xE19035EB65AB2932, p0, p1)

_0xE31FC20319874CB3

Parameters

• p0 (Any)
• p1 (Any)
• p2 (Any)

Usage

Lua (Direct):

local result = _0xE31FC20319874CB3(p0, p1, p2)

Lua (Hash):

local result = Citizen.InvokeNative(0xE31FC20319874CB3, p0, p1, p2)

_0xE75EEA8DB59A9F39

Parameters

• p0 (Any)
• p1 (Any)
• p2 (Any)
• p3 (Any)
• p4 (Any)
• p5 (Any)

Usage

Lua (Direct):

_0xE75EEA8DB59A9F39(p0, p1, p2, p3, p4, p5)

Lua (Hash):

Citizen.InvokeNative(0xE75EEA8DB59A9F39, p0, p1, p2, p3, p4, p5)

_0xE9E7A0BAC7F57746

Parameters

• p0 (Any)
• p1 (Any)

Usage

Lua (Direct):

_0xE9E7A0BAC7F57746(p0, p1)

Lua (Hash):

Citizen.InvokeNative(0xE9E7A0BAC7F57746, p0, p1)

_ENABLE_STAIRS_STEP_FOR_VOLUME

Description: Re-enables normal stair stepping behavior within the specified volume. This restores proper step-by-step movement and foot placement for entities that was previously altered by _DISABLE_STAIRS_STEP_FOR_VOLUME

Usage

Lua (Direct):

EnableStairsStepForVolume(volumeId)

Lua (Hash):

Citizen.InvokeNative(0xEAB3D91D30A344F1, volumeId)

_0xEF259AA1E097E0AD

Parameters

• entity (Entity)
• p1 (Any)

Usage

Lua (Direct):

_0xEF259AA1E097E0AD(entity, p1)

Lua (Hash):

Citizen.InvokeNative(0xEF259AA1E097E0AD, entity, p1)

_GET_ENTITY_LOOTING_PED

Description: Returns the entity that is looting a ped but only while the looting is active

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = GetEntityLootingPed(entity)

Lua (Hash):

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

_0xF41E2979D5BC5370

Parameters

• p0 (Any)

Usage

Lua (Direct):

_0xF41E2979D5BC5370(p0)

Lua (Hash):

Citizen.InvokeNative(0xF41E2979D5BC5370, p0)

_0xF59FDE7B4D31A630

Parameters

• p0 (Any)

Usage

Lua (Direct):

local result = _0xF59FDE7B4D31A630(p0)

Lua (Hash):

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

SET_ENTITY_CAN_ONLY_BE_DAMAGED_BY_SCRIPT_PARTICIPANTS

Parameters

• EntityIndex (Entity)
• bOnlyDamagedWhenRunningScript (BOOL)

Usage

Lua (Direct):

SetEntityCanOnlyBeDamagedByScriptParticipants(EntityIndex, bOnlyDamagedWhenRunningScript)

Lua (Hash):

Citizen.InvokeNative(0xFF83AF534156B399, EntityIndex, bOnlyDamagedWhenRunningScript)

_0xFF9965C47FA404DA

Description: SET_ENTITY_LO*

Parameters

• entity (Entity)
• toggle (BOOL)

Usage

Lua (Direct):

_0xFF9965C47FA404DA(entity, toggle)

Lua (Hash):

Citizen.InvokeNative(0xFF9965C47FA404DA, entity, toggle)

_ADD_ENTITY_TRACKING_TRAILS

Parameters

• entity (Entity)

Usage

Lua (Direct):

AddEntityTrackingTrails(entity)

Lua (Hash):

Citizen.InvokeNative(0x1AD922AB5038DEF3, entity)

_CREATE_FOOTPATH_TRAIL

Parameters

• p0 (Any)
• waypointRecord (const char*)
• bUseSnowOffset (BOOL)
• p3 (float)
• p4 (float)
• p5 (Any)
• p6 (Any)
• p7 (Any)
• p8 (Any)
• p9 (Any)
• p10 (Any)
• bInit (BOOL)

Usage

Lua (Direct):

local result = CreateFootpathTrail(p0, waypointRecord, bUseSnowOffset, p3, p4, p5, p6, p7, p8, p9, p10, bInit)

Lua (Hash):

local result = Citizen.InvokeNative(0x29BA9F78321E5A6C, p0, waypointRecord, bUseSnowOffset, p3, p4, p5, p6, p7, p8, p9, p10, bInit)

_DELETE_CARRIABLE

Parameters

• entity (Entity*)

Usage

Lua (Direct):

DeleteCarriable(entity)

Lua (Hash):

Citizen.InvokeNative(0x0D0DB2B6AF19A987, entity)

_DOES_THREAD_OWN_THIS_ENTITY

Description: Returns true if calling script owns specified entity

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = DoesThreadOwnThisEntity(entity)

Lua (Hash):

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

_GET_CARRIABLE_FROM_ENTITY

Description: Returns a hash of an entity's name. (Alternative Name: _GET_ENTITY_PROMPT_NAME_HASH)

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = GetCarriableFromEntity(entity)

Lua (Hash):

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

_GET_ENTITIES_IN_VOLUME

Parameters

• volume (Volume)
• itemSet (ItemSet)
• entityType (int)

Usage

Lua (Direct):

local result = GetEntitiesInVolume(volume, itemSet, entityType)

Lua (Hash):

local result = Citizen.InvokeNative(0x886171A12F400B89, volume, itemSet, entityType)

_GET_ENTITIES_NEAR_POINT

Parameters

• x (float)
• y (float)
• z (float)
• radius (float)
• itemSet (ItemSet)
• p5 (int)

Usage

Lua (Direct):

local result = GetEntitiesNearPoint(x, y, z, radius, itemSet, p5)

Lua (Hash):

local result = Citizen.InvokeNative(0x59B57C4B06531E1E, x, y, z, radius, itemSet, p5)

_GET_ENTITY_ANIM_CURRENT_TIME

Description: Returns a normalized value between 0.0f and 1.0f. You can get the actual anim time by multiplying this by GET_ANIM_DURATION

Usage

Lua (Direct):

local result = GetEntityAnimCurrentTime(entity, animDict, animName)

Lua (Hash):

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

GET_ENTITY_CAN_BE_DAMAGED

Description: Old name: _GET_ENTITY_CAN_BE_DAMAGED

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = GetEntityCanBeDamaged(entity)

Lua (Hash):

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

_GET_ENTITY_CARRY_CONFIG

Description: Returns zero if the entity is not a carriable

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = GetEntityCarryConfig(entity)

Lua (Hash):

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

_GET_ENTITY_FORWARD_VECTOR_YX

Description: Gets the entity's forward vector in YX(Z) eulers. Similar to GET_ENTITY_FORWARD_VECTOR

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = GetEntityForwardVectorYx(entity)

Lua (Hash):

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

_GET_ENTITY_HEALTH_FLOAT

Description: Returns (CUR_HEALTH / MAX_HEALTH)

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = GetEntityHealthFloat(entity)

Lua (Hash):

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

_GET_ENTITY_SCRIPT

Parameters

• entity (Entity)
• argStruct (Any*)

Usage

Lua (Direct):

local result = GetEntityScript(entity, argStruct)

Lua (Hash):

local result = Citizen.InvokeNative(0x2A08A32B6D49906F, entity, argStruct)

_GET_ENTITY_THREAT_TIER

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = GetEntityThreatTier(entity)

Lua (Hash):

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

_GET_ENTITY_WORLD_POSITION_OF_DIMENSIONS

Parameters

• entity (Entity)
• minimum (Vector3*)
• maximum (Vector3*)

Usage

Lua (Direct):

GetEntityWorldPositionOfDimensions(entity, minimum, maximum)

Lua (Hash):

Citizen.InvokeNative(0xF3FDA9A617A15145, entity, minimum, maximum)

_GET_IS_BIRD

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = GetIsBird(entity)

Lua (Hash):

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

_GET_IS_CARRIABLE_PELT

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = GetIsCarriablePelt(entity)

Lua (Hash):

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

_GET_IS_PREDATOR

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = GetIsPredator(entity)

Lua (Hash):

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

_GET_PINNED_MAP_ENTITY

Parameters

• p0 (Any)

Usage

Lua (Direct):

local result = GetPinnedMapEntity(p0)

Lua (Hash):

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

_GET_SCRIPT_OVERRIDE_ENTITY_LOOT_TABLE_PERMANENT

Description: Returns false if entity is not a ped or object.

Parameters

• entity (Entity)
• lootTable (Hash*)

Usage

Lua (Direct):

local result = GetScriptOverrideEntityLootTablePermanent(entity, lootTable)

Lua (Hash):

local result = Citizen.InvokeNative(0x1E804EA9B12030A4, entity, lootTable)

_IS_CARRIABLE_MODEL

Parameters

• model (Hash)

Usage

Lua (Direct):

local result = IsCarriableModel(model)

Lua (Hash):

local result = Citizen.InvokeNative(0x5AFFA9DDC87846F8, model)

_IS_ENTITY_FROZEN

Description: Getter for FREEZE_ENTITY_POSITION

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = IsEntityFrozen(entity)

Lua (Hash):

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

_IS_ENTITY_FULLY_LOOTED

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = IsEntityFullyLooted(entity)

Lua (Hash):

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

_IS_ENTITY_ON_TRAIN_TRACK

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = IsEntityOnTrainTrack(entity)

Lua (Hash):

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

_IS_ENTITY_OWNED_BY_PERSISTENCE_SYSTEM

Parameters

• entity (Entity)

Usage

Lua (Direct):

local result = IsEntityOwnedByPersistenceSystem(entity)

Lua (Hash):

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

End of ENTITY natives part 5

_CHANGE_ENTITY_HEALTH

Description: Alters entity's health by 'amount'. Can be negative (to drain health). In the scripts entity2 and weaponHash are unused (zero).

Usage

Lua (Direct):

local result = ChangeEntityHealth(entity, amount, entity2, weaponHash)

Lua (Hash):

local result = Citizen.InvokeNative(0x835F131E7DC8F97A, entity, amount, entity2, weaponHash)

_DELETE_ENTITY_2

Description: [warning: This native isn't useful for RedM, you should refer to [native: DELETE_ENTITY] instead.]

Must be called from a background script, otherwise it will do nothing.

Note: flagged unused upstream — not referenced by any shipped R* script; behaviour is unverified.

Usage

Lua (Direct):

DeleteEntity2()

Lua (Hash):

Citizen.InvokeNative(0x5E94EA09E7207C16)

_GET_ENTITY_BY_DOORHASH

Description: Params: p1 = 0 in R* Scripts (GET_DOOR_ENTITY_FROM_ID) https://github.com/femga/rdr3_discoveries/blob/master/doorHashes/doorhashes.lua

Usage

Lua (Direct):

local result = GetEntityByDoorhash(doorHash, p1)

Lua (Hash):

local result = Citizen.InvokeNative(0xF7424890E4A094C0, doorHash, p1)

_GET_ENTITY_CARRYING_FLAG

Description: This native only works on Ped and Object entity types

Usage

Lua (Direct):

local result = GetEntityCarryingFlag()

Lua (Hash):

local result = Citizen.InvokeNative(0x808077647856DE62)

GET_ENTITY_PROOFS

Description: Note: this native was removed in 1232 but added back in 1311 Old name: _GET_ENTITY_PROOFS

Usage

Lua (Direct):

local result = GetEntityProofs(entity)

Lua (Hash):

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

_GET_OPTIMAL_CARRY_CONFIG

Description: Valid indices: 0 - 3 Index 1 always returns a hogtied config, doesn't matter the entity. It's for humans only and the ped must be resurrected first if it's dead.

Usage

Lua (Direct):

local result = GetOptimalCarryConfig(entity, index)

Lua (Hash):

local result = Citizen.InvokeNative(0x34F008A7E48C496B, entity, index)

_GET_PED_ANIMAL_TYPE

Description: Returns the ped's animal type hash: https://alloc8or.re/rdr3/doc/enums/eAnimalType.txt Combine this with GET_STRING_FROM_HASH_KEY to display localized entity names

Usage

Lua (Direct):

local result = GetPedAnimalType(ped)

Lua (Hash):

local result = Citizen.InvokeNative(0x964000D355219FC0, ped)