@nativewrappers/redm-codegen 0.0.2

package/dist/classes/Entity.d.ts

@@ -0,0 +1,1101 @@
+import type { eCarryingFlags } from '../enums/eCarryingFlags';
+import type { eWeaponHash } from '../enums/eWeaponHash';
+import type { Ped } from '../classes/Ped';
+import type { Player } from '../classes/Player';
+import type { Prop } from '../classes/Prop';
+import type { Vehicle } from '../classes/Vehicle';
+import { Vector3 } from '../types/Vector3';
+import { Vector4 } from '../types/Vector4';
+import { IHandle } from '../types/IHandle';
+export declare class Entity implements IHandle {
+    handle: number;
+    constructor(handle: number);
+    static fromHandle(handle: number): Entity | null;
+    /**
+     * @param targetEntity
+     * @returns
+     */
+    isTouchingEntity(targetEntity: Entity): boolean;
+    deleteCarriable(): void;
+    /**
+     * Returns a normalized value between 0.0f and 1.0f. You can get the actual anim time by multiplying this by GET_ANIM_DURATION
+     *
+     * @param animDict
+     * @param animName
+     * @returns
+     */
+    getAnimCurrentTime(animDict: string | null, animName: string | null): number;
+    /**
+     * @param entity2
+     * @param thisFrameOnly
+     */
+    setNoCollisionEntity(entity2: Entity, thisFrameOnly: boolean): void;
+    /**
+     * Result is in meters per second (m/s)
+     *
+     * @returns
+     */
+    getSpeed(): number;
+    /**
+     * @param bOnlyDamagedWhenRunningScript
+     */
+    setCanOnlyBeDamagedByScriptParticipants(bOnlyDamagedWhenRunningScript: boolean): void;
+    /**
+     * @returns
+     */
+    isTrackedVisible(): any;
+    /**
+     * @param p1
+     * @param collision
+     */
+    detachEntity(p1: boolean, collision: boolean): void;
+    /**
+     * @returns
+     */
+    isVisibleToScript(): boolean;
+    /**
+     * @param entity2
+     * @param traceType
+     * @returns
+     */
+    hasClearLosToEntity(entity2: Entity, traceType: number): boolean;
+    /**
+     * Used in Script Function GENERIC_ITEM_HAS_ANIM_COMPLETED
+     * *GET_ENTITY**
+     *
+     * @param animDict
+     * @param animClip
+     * @returns
+     */
+    N_0x8E46E18AA828334F(animDict: string | null, animClip: string | null): number;
+    /**
+     * @param playerPedToIgnore
+     * @param flags
+     * @returns
+     */
+    getNearestPlayerToEntity(playerPedToIgnore: Ped, flags: number): Player | null;
+    /**
+     * Gets the Y-component of the entity's forward vector.
+     *
+     * @returns
+     */
+    getForwardY(): number;
+    /**
+     * @param pitch
+     * @param roll
+     * @param yaw
+     * @param rotationOrder
+     * @param p5
+     */
+    setRotation(pitch: number, roll: number, yaw: number, rotationOrder: number, p5: boolean): void;
+    /**
+     * @param p1
+     * @param relationshipGroup
+     */
+    setOnlyDamagedByRelationshipGroup(p1: boolean, relationshipGroup: string | number): void;
+    /**
+     * https://github.com/femga/rdr3_discoveries/tree/master/AI/ENTITY_PROOFS
+     * BOOL p2: handles an additional special proofs flag, so it simply indicates whether it should be enabled or disabled, not sure what exactly it proofs the entity from though
+     *
+     * @param proofsBitset
+     * @param specialFlag
+     */
+    setProofs(proofsBitset: number, specialFlag: boolean): void;
+    /**
+     * @returns
+     */
+    hasCollisionLoadedAroundEntity(): boolean;
+    /**
+     * @returns
+     */
+    getIsCarriablePelt(): any;
+    /**
+     * @param p1
+     * @returns
+     */
+    getVelocity(p1: number): Vector3;
+    /**
+     * @param toggle
+     */
+    setCanAutoVaultOnEntity(toggle: boolean): void;
+    /**
+     * Sets the loot table an entity will carry. Returns true if loot table has been successfully set. Returns false if entity is not a ped or object.
+     * https://github.com/femga/rdr3_discoveries/blob/master/AI/EVENTS/loot_rewards.lua
+     *
+     * @param lootTable
+     * @returns
+     */
+    scriptOverrideLootTablePermanent(lootTable: string | number): any;
+    /**
+     * @returns argStruct
+     */
+    getScript(): [string | number, number];
+    /**
+     * @param actionHash
+     * @returns
+     */
+    hasAnimEventFired(actionHash: string | number): boolean;
+    /**
+     * @param p1
+     */
+    N_0xEF259AA1E097E0AD(p1: any): void;
+    /**
+     * Getter for FREEZE_ENTITY_POSITION
+     *
+     * @returns
+     */
+    isFrozen(): any;
+    /**
+     * Returns the entity that is looting a ped but only while the looting is active
+     *
+     * @returns
+     */
+    getLootingPed(): Ped | null;
+    /**
+     * @returns
+     */
+    isWaitingForWorldCollision(): boolean;
+    /**
+     * Gets the X-component of the entity's forward vector.
+     *
+     * @returns
+     */
+    getForwardX(): number;
+    /**
+     * @returns
+     */
+    isAPed(): boolean;
+    /**
+     * @returns
+     */
+    getPitch(): number;
+    /**
+     * @returns
+     */
+    isStatic(): boolean;
+    /**
+     * Returns the model hash from the entity
+     *
+     * @returns
+     */
+    getModel(): string | number;
+    /**
+     * Deletes the specified entity, then sets the handle pointed to by the pointer to NULL.
+     */
+    deleteEntity(): void;
+    /**
+     * @param team
+     * @param playerPedToIgnore
+     * @param flags
+     * @returns
+     */
+    getNearestPlayerToOnTeam(team: number, playerPedToIgnore: Ped, flags: number): Player | null;
+    /**
+     * @param p1
+     */
+    N_0x80FDEB3A9E9AA578(p1: boolean): void;
+    /**
+     * Makes the specified entity (ped, vehicle or object) persistent. Persistent entities will not automatically be removed by the engine.
+     *
+     * @param p1
+     * @param p2
+     */
+    setAsMissionEntity(p1: boolean, p2: boolean): void;
+    /**
+     * Gets the entity's forward vector in XY(Z) eulers.
+     *
+     * @returns
+     */
+    getForwardVector(): Vector3;
+    /**
+     * @param modelHash
+     * @returns
+     */
+    isTouchingModel(modelHash: string | number): boolean;
+    /**
+     * Sets the entity's health. healthAmount sets the health value to that, and sets the maximum health core value. Setting healthAmount to 0 will kill the entity. entityKilledBy parameter can also be 0
+     *
+     * @param healthAmount
+     * @param entityKilledBy
+     */
+    setHealth(healthAmount: number, entityKilledBy: Entity): void;
+    /**
+     * @param toggle
+     */
+    setRenderScorched(toggle: boolean): void;
+    /**
+     * @param heading
+     */
+    setHeading(heading: number): void;
+    /**
+     * @returns
+     */
+    getCollisionDisabled(): boolean;
+    /**
+     * Displays the current ROLL axis of the entity [-180.0000/180.0000+]
+     * (Sideways Roll) such as a vehicle tipped on its side
+     *
+     * @returns
+     */
+    getRoll(): number;
+    /**
+     * @returns
+     */
+    getNearestParticipantToEntity(): Player | null;
+    /**
+     * 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
+     * };
+     *
+     * @returns
+     */
+    getCarriableState(): number;
+    /**
+     * @param value
+     */
+    setMaxHealth(value: number): void;
+    /**
+     * Params: p1 (probably animType) = 1, 0
+     *
+     * @param p1
+     * @returns
+     */
+    isPlayingAnyAnim(p1: number): boolean;
+    /**
+     * @param enabled
+     */
+    setLightsEnabled(enabled: boolean): void;
+    /**
+     * Offset values are relative to the entity. x = left/right
+     * y = forward/backward
+     * z = up/down
+     *
+     * @param offset
+     * @returns
+     */
+    getOffsetFromInWorldCoords(offset: Vector3): Vector3;
+    /**
+     * 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
+     *
+     * @param entity2
+     * @param xSize
+     * @param ySize
+     * @param zSize
+     * @param p5
+     * @param p6
+     * @param p7
+     * @returns
+     */
+    isAtEntity(entity2: Entity, xSize: number, ySize: number, zSize: number, p5: boolean, p6: boolean, p7: number): boolean;
+    /**
+     * @param toggle
+     */
+    setVisible(toggle: boolean): void;
+    /**
+     * Old name: _SET_ENTITY_CLEANUP_BY_ENGINE
+     *
+     * @param toggle
+     */
+    setShouldFreezeWaitingOnCollision(toggle: boolean): void;
+    /**
+     * Note: this native was removed in 1232 but added back in 1311
+     * Old name: _GET_ENTITY_PROOFS
+     *
+     * @returns
+     */
+    getProofs(): number;
+    /**
+     * skin - everything alpha except skin
+     * Set entity alpha level. Ranging from 0 to 255 but changes occur after every 20 percent (after every 51).
+     *
+     * @param alphaLevel
+     * @param skin
+     */
+    setAlpha(alphaLevel: number, skin: boolean): void;
+    /**
+     * @returns
+     */
+    getThreatTier(): number;
+    /**
+     * @returns
+     */
+    isUpsidedown(): boolean;
+    /**
+     * @param p1
+     * @returns
+     */
+    doesBelongToThisScript(p1: boolean): boolean;
+    /**
+     * Returns a hash of an entity's name. (Alternative Name: _GET_ENTITY_PROMPT_NAME_HASH)
+     *
+     * @returns
+     */
+    getCarriableFromEntity(): string | number;
+    /**
+     * @param toggle
+     * @param keepPhysics
+     */
+    setCollision(toggle: boolean, keepPhysics: boolean): void;
+    /**
+     * @param p1
+     * @returns
+     */
+    placeOnGroundProperly(p1: boolean): any;
+    /**
+     * @returns
+     */
+    isInWater(): boolean;
+    /**
+     * @returns Returns `true` if the entity exists
+     */
+    doesExist(): boolean;
+    /**
+     * @returns
+     */
+    getAlpha(): number;
+    /**
+     * This native only works on `Ped` and `Object` entity types
+     *
+     * @param flagId Refer to [enum: eCarryingFlags]
+     * @returns
+     */
+    getCarryingFlag(flagId: eCarryingFlags): number;
+    /**
+     * @param p1
+     */
+    forceAiAndAnimationUpdate(p1: boolean): void;
+    /**
+     * Axis - Invert Axis Flags
+     *
+     * @param pos
+     * @param xAxis
+     * @param yAxis
+     * @param zAxis
+     */
+    setCoordsNoOffset(pos: Vector3, xAxis: boolean, yAxis: boolean, zAxis: boolean): void;
+    /**
+     * Returns (CUR_HEALTH / MAX_HEALTH)
+     *
+     * @returns
+     */
+    getHealthFloat(): number;
+    /**
+     * @returns
+     */
+    getIsBird(): any;
+    /**
+     * Gets the entity's forward vector in YX(Z) eulers. Similar to GET_ENTITY_FORWARD_VECTOR
+     *
+     * @returns
+     */
+    getForwardVectorYx(): Vector3;
+    /**
+     * @param pos
+     * @param xAxis
+     * @param yAxis
+     * @param zAxis
+     * @param clearArea
+     */
+    setCoords(pos: Vector3, xAxis: boolean, yAxis: boolean, zAxis: boolean, clearArea: boolean): void;
+    /**
+     * @param boneName
+     * @returns
+     */
+    getBoneIndexByName(boneName: string | null): number;
+    /**
+     * @param pause
+     */
+    pauseTracking(pause: boolean): void;
+    /**
+     * @param toggle
+     */
+    setLoadCollisionFlag(toggle: boolean): void;
+    /**
+     * Changes type and quality of skins
+     * type hashes: https://pastebin.com/C1WvQjCy
+     *
+     * @param type
+     */
+    setCarcassType(type: string | number): void;
+    /**
+     * @param toggle
+     */
+    setHasGravity(toggle: boolean): void;
+    /**
+     * @param relative
+     * @returns
+     */
+    getSpeedVector(relative: boolean): Vector3;
+    /**
+     * @param entity2
+     * @param p2
+     * @param p3
+     * @returns
+     */
+    hasBeenDamagedByEntity(entity2: Entity, p2: boolean, p3: boolean): boolean;
+    /**
+     * @returns
+     */
+    isFullyLooted(): any;
+    /**
+     * @returns
+     */
+    isOccluded(): boolean;
+    /**
+     * @param toggle
+     */
+    setCanBeDamaged(toggle: boolean): void;
+    /**
+     * @param forceFlags
+     * @param pos
+     * @param offset
+     * @param boneIndex
+     * @param isDirectionRel
+     * @param ignoreUpVec
+     * @param isForceRel
+     * @param p12
+     * @param p13
+     */
+    applyForceToEntity(forceFlags: number, pos: Vector3, offset: Vector3, boneIndex: number, isDirectionRel: boolean, ignoreUpVec: boolean, isForceRel: boolean, p12: boolean, p13: boolean): void;
+    /**
+     * @returns
+     */
+    isDead(): boolean;
+    /**
+     * @param pos1
+     * @param pos2
+     * @param p7
+     * @param p8
+     * @param p9
+     * @returns
+     */
+    isInArea(pos1: Vector3, pos2: Vector3, p7: boolean, p8: boolean, p9: any): boolean;
+    /**
+     * Returns the coordinates of an entity-bone.
+     * https://github.com/femga/rdr3_discoveries/tree/master/boneNames
+     *
+     * @param boneIndex
+     * @returns
+     */
+    getWorldPositionOfBone(boneIndex: number): Vector3;
+    /**
+     * https://github.com/femga/rdr3_discoveries/tree/master/animations
+     *
+     * @param animName
+     * @param animDict
+     * @param p3
+     * @param loop
+     * @param stayInAnim
+     * @param p6
+     * @param delta
+     * @param bitset
+     * @returns
+     */
+    playAnim(animName: string | null, animDict: string | null, p3: number, loop: boolean, stayInAnim: boolean, p6: boolean, delta: number, bitset: any): boolean;
+    /**
+     * Returns false if entity is not a ped or object.
+     *
+     * @returns lootTable
+     */
+    getScriptOverrideLootTablePermanent(): [any, number];
+    /**
+     * @param animDict
+     * @param animName
+     * @param p3
+     * @returns
+     */
+    hasAnimFinished(animDict: string | null, animName: string | null, p3: number): boolean;
+    /**
+     * @param bCanBeDamaged
+     * @param relGroup
+     */
+    setCanBeDamagedByRelationshipGroup(bCanBeDamaged: boolean, relGroup: string | number): void;
+    /**
+     * @returns
+     */
+    getUprightValue(): number;
+    /**
+     * @param pos
+     * @param heading
+     * @param xAxis
+     * @param yAxis
+     * @param zAxis
+     */
+    setCoordsAndHeading(pos: Vector3, heading: number, xAxis: boolean, yAxis: boolean, zAxis: boolean): void;
+    /**
+     * Returns zero if the entity is not a carriable
+     *
+     * @returns
+     */
+    getCarryConfig(): string | number;
+    /**
+     * tier: https://github.com/Halen84/RDR3-Native-Flags-And-Enums/tree/main/eEntityThreatTier
+     *
+     * @param tier
+     * @param p2
+     */
+    setThreatTier(tier: number, p2: boolean): void;
+    /**
+     * Returns the heading of the entity in degrees. Also know as the "Yaw" of an entity.
+     *
+     * @returns
+     */
+    getHeading(): number;
+    /**
+     * Returns the LOD distance of an entity.
+     *
+     * @returns
+     */
+    getLodDist(): number;
+    /**
+     * @returns
+     */
+    doesHaveDrawable(): boolean;
+    /**
+     * @param xyzw
+     */
+    setQuaternion(xyzw: Vector4): void;
+    /**
+     * @returns
+     */
+    isAttachedToAnyObject(): boolean;
+    /**
+     * Sets a ped or an object totally invincible. It doesn't take any kind of damage. Peds will not ragdoll on explosions.
+     *
+     * @param toggle
+     */
+    setInvincible(toggle: boolean): void;
+    /**
+     * 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
+     *
+     * @param entity2
+     * @param boneIndex
+     * @param pos
+     * @param rot
+     * @param p9
+     * @param useSoftPinning
+     * @param collision
+     * @param isPed
+     * @param vertexIndex
+     * @param fixedRot
+     * @param p15
+     * @param p16
+     */
+    attachToEntity(entity2: Entity, boneIndex: number, pos: Vector3, rot: Vector3, p9: boolean, useSoftPinning: boolean, collision: boolean, isPed: boolean, vertexIndex: number, fixedRot: boolean, p15: boolean, p16: boolean): void;
+    /**
+     * @returns
+     */
+    getIsAnimal(): any;
+    /**
+     * 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
+     *
+     * @param forceType
+     * @param pos
+     * @param component
+     * @param isDirectionRel
+     * @param isForceRel
+     * @param p8
+     */
+    applyForceToCenterOfMass(forceType: number, pos: Vector3, component: number, isDirectionRel: boolean, isForceRel: boolean, p8: boolean): void;
+    /**
+     * Old name: _GET_ENTITY_CAN_BE_DAMAGED
+     *
+     * @returns
+     */
+    getCanBeDamaged(): any;
+    /**
+     * Seems to return true if entity is burned / scorched
+     * *GET_ENTITY**
+     *
+     * @returns
+     */
+    N_0x37B01666BAE8F7EF(): any;
+    /**
+     * @param toggle
+     */
+    setRequiresMoreExpensiveRiverCheck(toggle: boolean): void;
+    /**
+     * @param boneIndex
+     * @returns Returns the offset from the entity for the selected bone index.
+     */
+    getOffsetFromBone(boneIndex: number): Vector3;
+    N_0x9C6906EF8CB20C5F(): void;
+    /**
+     * Simply returns whatever is passed to it (Regardless of whether the handle is valid or not).
+     *
+     * @returns
+     */
+    getPedIndexFromIndex(): Ped | null;
+    /**
+     * Sets whether the entity can be targeted without being in line-of-sight.
+     *
+     * @param toggle
+     */
+    setCanBeTargetedWithoutLos(toggle: boolean): void;
+    /**
+     * @returns
+     */
+    isOnScreen(): boolean;
+    /**
+     * Old name: _SET_ENTITY_DECALS_DISABLED
+     *
+     * @param toggle
+     */
+    setNoweapondecals(toggle: boolean): void;
+    /**
+     * @returns
+     */
+    getHealth(): number;
+    /**
+     * sets the fill in state for some objects like for the stew, coffee mug ,poker chips, jugs ? P1 is either 0 or 2 p2 seems to be a label/name p3 is the fill in state, max seems to be for some 3.0 (most is 1.0) - 0.0
+     * heres some of the labels/names found
+     * tumbler_fill, Canvas, Stew_Fill, from Chip01_Ctrl to Chip10_Ctrl, from empty_jug01_Ctrl to empty_jug20_Ctrl, from full_jug01_Ctrl to full_jug20_Ctrl, CTRL_cupFill, Food_DOF_Fill, from WhiteChip_Ctrl_0 to WhiteChip_Ctrl_10, from BlueChip_Ctrl_0 to BlueChip_Ctrl_10, from BlackChip_Ctrl_0 to BlackChip_Ctrl_10, from RedChip_Ctrl_0 to RedChip_Ctrl_10,
+     *
+     * @param p1
+     * @param p2
+     * @param fill
+     */
+    setFillInStateForEntity(p1: number, p2: string | null, fill: number): void;
+    /**
+     * @returns
+     */
+    doesHavePhysics(): boolean;
+    /**
+     * Returns true if calling script owns specified entity
+     *
+     * @returns
+     */
+    doesThreadOwnThisEntity(): any;
+    /**
+     * Attach an entity to coordinates physically better name may be perfered? seems to be used with boats `p_skiff02x` ? The last 6 params are always 0 everywhere in the base code. p7 = 500.0 some kind of time? p8 =1
+     *
+     * @param pos
+     * @param offset
+     * @param p7
+     * @param p8
+     * @param p9
+     * @param p10
+     * @param p11
+     * @param p12
+     * @param p13
+     * @param p14
+     */
+    attachToCoordsPhysically(pos: Vector3, offset: Vector3, p7: number, p8: boolean, p9: number, p10: number, p11: number, p12: number, p13: number, p14: number): void;
+    /**
+     * *REMOVE_DECALS** - _REMOVE_FORCED*
+     */
+    N_0x5826EFD6D73C4DE5(): void;
+    /**
+     * @param toggle
+     */
+    freezePosition(toggle: boolean): void;
+    /**
+     * Alters entity's health by 'amount'. Can be negative (to drain health).
+     * In the scripts entity2 and weaponHash are unused (zero).
+     *
+     * @param amount
+     * @param entity2
+     * @param weaponHash Refer to [enum: eWeaponHash]
+     * @returns
+     */
+    changeHealth(amount: number, entity2: Entity, weaponHash: eWeaponHash): any;
+    /**
+     * @returns
+     */
+    getAttachedTo(): Entity | null;
+    /**
+     * @param toggle
+     */
+    setOnlyDamagedByPlayer(toggle: boolean): void;
+    /**
+     * @param p1
+     * @param p2
+     */
+    setIsTargetPriority(p1: boolean, p2: number): void;
+    /**
+     * @param pos
+     * @param flags
+     * @returns
+     */
+    hasClearLosToCoord(pos: Vector3, flags: number): any;
+    /**
+     * @param flagId Refer to [enum: eCarryingFlags]
+     * @param value
+     */
+    setCarryingFlag(flagId: eCarryingFlags, value: boolean): void;
+    /**
+     * @returns
+     */
+    getIsPredator(): any;
+    /**
+     * Returns entityType: https://github.com/Halen84/RDR3-Native-Flags-And-Enums/tree/main/eEntityType
+     *
+     * @returns
+     */
+    getType(): number;
+    /**
+     * @returns
+     */
+    isOwnedByPersistenceSystem(): any;
+    /**
+     * @param animDict
+     * @param animName
+     * @param animType
+     * @returns
+     */
+    isPlayingAnim(animDict: string | null, animName: string | null, animType: number): boolean;
+    /**
+     * Marks the specified entity (ped, vehicle or object) as no longer needed, allowing the game engine to delete it whenever it sees fit.
+     */
+    setAsNoLongerNeeded(): void;
+    /**
+     * @returns
+     */
+    hasBeenDamagedByAnyVehicle(): boolean;
+    /**
+     * @param animDict
+     * @param animName
+     * @param speedMultiplier
+     */
+    setAnimSpeed(animDict: string | null, animName: string | null, speedMultiplier: number): void;
+    unpinMapEntity(): void;
+    /**
+     * Get how much of the entity is submerged. 1.0f is whole entity.
+     *
+     * @returns
+     */
+    getSubmergedLevel(): number;
+    /**
+     * @returns
+     */
+    isAttached(): boolean;
+    /**
+     * SET_ENTITY_A*
+     *
+     * @param p1
+     */
+    N_0xC0EDEF16D90661EE(p1: number): void;
+    /**
+     * @param looted
+     */
+    setFullyLooted(looted: boolean): void;
+    /**
+     * @returns
+     */
+    isAttachedToAnyVehicle(): boolean;
+    /**
+     * @param p1
+     */
+    N_0xA48E4801DEBDF7E4(p1: boolean): void;
+    /**
+     * @param toggle
+     * @param keepPhysics
+     */
+    setCompletelyDisableCollision(toggle: boolean, keepPhysics: boolean): void;
+    /**
+     * @param p1
+     */
+    N_0xCDB682BB47C02F0A(p1: string | number): void;
+    /**
+     * @param volume
+     * @param p2
+     * @param p3
+     * @returns
+     */
+    isInVolume(volume: number, p2: boolean, p3: number): boolean;
+    /**
+     * @returns rightVector; forwardVector; upVector; position
+     */
+    getMatrix(): [Vector3, Vector3, Vector3, Vector3];
+    /**
+     * Called if entity is in water and submerged level is larger than 1f. If CARRYING_FLAG_FORCE_ALLOW_WARP_TO_SAFE_GROUND_LOCATION is true, it gets disabled as well.
+     */
+    N_0x371D179701D9C082(): void;
+    /**
+     * @param p1
+     * @returns
+     */
+    getMaxHealth(p1: boolean): number;
+    /**
+     * @param animDict
+     * @param animName
+     * @param time
+     */
+    setAnimCurrentTime(animDict: string | null, animName: string | null, time: number): void;
+    /**
+     * 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.
+     *
+     * @param alive
+     * @param realCoords
+     * @returns
+     */
+    getCoords(alive: boolean, realCoords: boolean): Vector3;
+    /**
+     * @returns
+     */
+    isAnObject(): boolean;
+    /**
+     * Used in Script Function DUELING_DID_PLAYER_DISARM_OPPONENT
+     *
+     * @param entity2
+     * @param p2
+     * @param p3
+     * @returns
+     */
+    N_0x3EC28DA1FFAC9DDD(entity2: Entity, p2: any, p3: any): boolean;
+    /**
+     * Must be called from a background script, otherwise it will do nothing.
+     */
+    delete2(): void;
+    /**
+     * @param p1
+     * @returns
+     */
+    isInAir(p1: any): boolean;
+    /**
+     * @returns
+     */
+    isAMissionEntity(): boolean;
+    /**
+     * @returns
+     */
+    isAttachedToAnyPed(): boolean;
+    /**
+     * @param to
+     * @returns
+     */
+    isAttachedToEntity(to: Entity): boolean;
+    /**
+     * @returns
+     */
+    hasBeenDamagedByAnyObject(): boolean;
+    /**
+     * @param rotationOrder
+     * @returns
+     */
+    getRotation(rotationOrder: number): Vector3;
+    /**
+     * @param toggle
+     */
+    setMotionBlur(toggle: boolean): void;
+    resetAlpha(): void;
+    /**
+     * 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
+     *
+     * @param pos
+     * @param xSize
+     * @param ySize
+     * @param zSize
+     * @param p7
+     * @param p8
+     * @param p9
+     * @returns
+     */
+    isAtCoord(pos: Vector3, xSize: number, ySize: number, zSize: number, p7: boolean, p8: boolean, p9: number): boolean;
+    /**
+     * LOD distance can be 0 to 0xFFFF (higher values will result in 0xFFFF) as it is actually stored as a 16-bit value (aka uint16_t).
+     *
+     * @param value
+     */
+    setLodDist(value: number): void;
+    /**
+     * @param toggle
+     */
+    setDynamic(toggle: boolean): void;
+    /**
+     * @param radius
+     */
+    setCustomPickupRadius(radius: number): void;
+    /**
+     * @returns
+     */
+    getPopulationType(): number;
+    /**
+     * @returns
+     */
+    isAVehicle(): boolean;
+    /**
+     * @param pos
+     * @param atTop
+     * @param inWorldCoords
+     * @returns
+     */
+    getHeight(pos: Vector3, atTop: boolean, inWorldCoords: boolean): number;
+    /**
+     * @param pos
+     * @returns
+     */
+    getOffsetFromGivenWorldCoords(pos: Vector3): Vector3;
+    addTrackingTrails(): void;
+    /**
+     * @param toggle
+     */
+    setCanClimbOnEntity(toggle: boolean): void;
+    /**
+     * @returns minimum; maximum
+     */
+    getWorldPositionOfDimensions(): [Vector3, Vector3];
+    /**
+     * @param p1
+     * @returns
+     */
+    isUnderwater(p1: boolean): any;
+    /**
+     * @param animation
+     * @param animGroup
+     * @param p3
+     * @returns
+     */
+    stopAnim(animation: string | null, animGroup: string | null, p3: number): any;
+    /**
+     * @returns
+     */
+    hasCollidedWithAnything(): boolean;
+    /**
+     * @param entity2
+     * @param p2
+     * @param boneIndex
+     * @param offset
+     * @param p7
+     * @param p8
+     * @param p9
+     * @param p10
+     * @param p11
+     * @param p12
+     * @param p13
+     * @param p14
+     * @param p15
+     * @param p16
+     * @param p17
+     * @param p18
+     * @param p19
+     * @param p20
+     * @param p21
+     */
+    attachToEntityPhysically(entity2: Entity, p2: number, boneIndex: number, offset: Vector3, p7: number, p8: number, p9: number, p10: number, p11: number, p12: number, p13: number, p14: boolean, p15: boolean, p16: boolean, p17: boolean, p18: number, p19: boolean, p20: number, p21: number): void;
+    /**
+     * @returns
+     */
+    getHeightAboveGround(): number;
+    /**
+     * @param pos
+     * @param heading
+     * @param p5
+     * @param p6
+     */
+    setCoordsAndHeadingNoOffset(pos: Vector3, heading: number, p5: boolean, p6: boolean): void;
+    /**
+     * 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.
+     *
+     * @param originX
+     * @param originY
+     * @param originZ
+     * @param edgeX
+     * @param edgeY
+     * @param edgeZ
+     * @param angle
+     * @param p8
+     * @param p9
+     * @param p10
+     * @returns
+     */
+    isInAngledArea(originX: number, originY: number, originZ: number, edgeX: number, edgeY: number, edgeZ: number, angle: number, p8: boolean, p9: boolean, p10: any): boolean;
+    clearLastDamageEntity(): void;
+    /**
+     * @param toggle
+     */
+    setAlwaysPrerender(toggle: boolean): void;
+    /**
+     * Note that the third parameter(denoted as z) is "up and down" with positive numbers encouraging upwards movement.
+     *
+     * @param pos
+     */
+    setVelocity(pos: Vector3): void;
+    /**
+     * SET_ENTITY_LO*
+     *
+     * @param p1
+     * @param p2
+     * @param p3
+     */
+    N_0xAF7F3099B9FEB535(p1: number, p2: number, p3: number): void;
+    /**
+     * @returns
+     */
+    N_0xAF72EC7E1B54539B(): Entity | null;
+    /**
+     * Simply returns whatever is passed to it (Regardless of whether the handle is valid or not).
+     *
+     * @returns
+     */
+    getObjectIndexFromIndex(): Prop | null;
+    /**
+     * Has the entity1 got a clear line of sight to the other entity2 from the direction entity1 is facing.
+     *
+     * @param entity2
+     * @param traceType
+     * @returns
+     */
+    hasClearLosToEntityInFront(entity2: Entity, traceType: number): boolean;
+    /**
+     * @returns
+     */
+    isOnTrainTrack(): any;
+    /**
+     * @param angle
+     * @returns
+     */
+    isUpright(angle: number): boolean;
+    /**
+     * Simply returns whatever is passed to it (Regardless of whether the handle is valid or not).
+     *
+     * @returns
+     */
+    getVehicleIndexFromIndex(): Vehicle | null;
+    /**
+     * @returns
+     */
+    isVisible(): boolean;
+    /**
+     * SET_ENTITY_LO*
+     *
+     * @param toggle
+     */
+    N_0xFF9965C47FA404DA(toggle: boolean): void;
+    /**
+     * 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.
+     *
+     * @param index
+     * @returns
+     */
+    getOptimalCarryConfig(index: number): string | number;
+    setFadeIn(): void;
+    /**
+     * @returns
+     */
+    hasBeenDamagedByAnyPed(): boolean;
+}
+//# sourceMappingURL=Entity.d.ts.map