Index

Search Results for

    Class Entity

    Inheritance
    BaseObject
    BaseObject
    WorldObject
    Entity
    Inherited Members
    pos
    WorldObject.constructor
    WorldObject.type
    WorldObject.valid
    WorldObject.id
    WorldObject.destroy
    WorldObject.getMetaDataKeys
    WorldObject.refCount
    Module: alt-server
    Package: @altmp/altv-types
    Syntax
    class Entity extends WorldObject

    Properties

    | Improve this Doc View Source

    all

    Declaration
    public readonly static all: readonly Entity[]
    Property Value
    Type Description
    readonly Entity[]
    | Improve this Doc View Source

    netOwner

    Declaration
    public readonly netOwner: null | Player
    Property Value
    Type Description
    null | Player
    | Improve this Doc View Source

    model

    Declaration
    public get model(): number
public set model(model: string | number): void
    Parameters
    Type Name Description
    string | number model
    Property Value
    Type Description
    number
    | Improve this Doc View Source

    rot

    Declaration
    public rot: Vector3
    Property Value
    Type Description
    Vector3
    | Improve this Doc View Source

    visible

    Declaration
    public visible: boolean
    Property Value
    Type Description
    boolean
    | Improve this Doc View Source

    streamed

    Declaration
    public streamed: boolean
    Property Value
    Type Description
    boolean
    | Improve this Doc View Source

    frozen

    Declaration
    public frozen: boolean
    Property Value
    Type Description
    boolean
    | Improve this Doc View Source

    collision

    Declaration
    public collision: boolean
    Property Value
    Type Description
    boolean
    | Improve this Doc View Source

    streamingDistance

    Declaration
    public streamingDistance: number
    Property Value
    Type Description
    number
    | Improve this Doc View Source

    timestamp

    Declaration
    public readonly timestamp: number
    Property Value
    Type Description
    number

    Methods

    | Improve this Doc View Source

    setMeta<K extends string>(K, InterfaceValueByKey<ICustomEntityMeta, K, unknown, void>)

    Declaration
    public setMeta<K extends string>(key: K, value: InterfaceValueByKey<ICustomEntityMeta, K, unknown, void>): void
    Parameters
    Type Name Description
    K key
    InterfaceValueByKey<ICustomEntityMeta, K, unknown, void> value
    | Improve this Doc View Source

    setMeta<K extends never>(K, ICustomEntityMeta[K])

    Declaration
    public setMeta<K extends never>(key: K, value: ICustomEntityMeta[K]): void
    Parameters
    Type Name Description
    K key
    ICustomEntityMeta[K] value
    | Improve this Doc View Source

    setMeta<V extends unknown, K extends string>(K, InterfaceValueByKey<ICustomEntityMeta, K, V, void>)

    Declaration
    public setMeta<V extends unknown, K extends string>(key: K, value: InterfaceValueByKey<ICustomEntityMeta, K, V, void>): void
    Parameters
    Type Name Description
    K key
    InterfaceValueByKey<ICustomEntityMeta, K, V, void> value
    | Improve this Doc View Source

    setMeta(MetaValues<ICustomEntityMeta>)

    Declaration
    public setMeta(values: MetaValues<ICustomEntityMeta>): void
    Parameters
    Type Name Description
    MetaValues<ICustomEntityMeta> values
    | Improve this Doc View Source

    deleteMeta(string)

    Declaration
    public deleteMeta(key: string): void
    Parameters
    Type Name Description
    string key
    | Improve this Doc View Source

    deleteMeta<K extends never>(K)

    Declaration
    public deleteMeta<K extends never>(key: K): void
    Parameters
    Type Name Description
    K key
    | Improve this Doc View Source

    getMeta<K extends string>(Exclude<K, never>)

    Declaration
    public getMeta<K extends string>(key: Exclude<K, never>): unknown
    Parameters
    Type Name Description
    Exclude<K, never> key
    Returns
    Type Description
    unknown
    | Improve this Doc View Source

    getMeta<K extends never>(K)

    Declaration
    public getMeta<K extends never>(key: K): undefined | ICustomEntityMeta[K]
    Parameters
    Type Name Description
    K key
    Returns
    Type Description
    undefined | ICustomEntityMeta[K]
    | Improve this Doc View Source

    getMeta<V extends unknown>(string)

    Declaration
    public getMeta<V extends unknown>(key: string): undefined | V
    Parameters
    Type Name Description
    string key
    Returns
    Type Description
    undefined | V
    | Improve this Doc View Source

    hasMeta(string)

    Declaration
    public hasMeta(key: string): boolean
    Parameters
    Type Name Description
    string key
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    hasMeta<K extends never>(K)

    Declaration
    public hasMeta<K extends never>(key: K): boolean
    Parameters
    Type Name Description
    K key
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    deleteSyncedMeta(string)

    Declaration
    public deleteSyncedMeta(key: string): void
    Parameters
    Type Name Description
    string key
    | Improve this Doc View Source

    deleteSyncedMeta<K extends never>(K)

    Declaration
    public deleteSyncedMeta<K extends never>(key: K): void
    Parameters
    Type Name Description
    K key
    | Improve this Doc View Source

    getSyncedMeta<K extends string>(Exclude<K, never>)

    Declaration
    public getSyncedMeta<K extends string>(key: Exclude<K, never>): unknown
    Parameters
    Type Name Description
    Exclude<K, never> key
    Returns
    Type Description
    unknown
    | Improve this Doc View Source

    getSyncedMeta<K extends never>(K)

    Declaration
    public getSyncedMeta<K extends never>(key: K): undefined | ICustomEntitySyncedMeta[K]
    Parameters
    Type Name Description
    K key
    Returns
    Type Description
    undefined | ICustomEntitySyncedMeta[K]
    | Improve this Doc View Source

    getSyncedMeta<V extends unknown>(string)

    Declaration
    public getSyncedMeta<V extends unknown>(key: string): undefined | V
    Parameters
    Type Name Description
    string key
    Returns
    Type Description
    undefined | V
    | Improve this Doc View Source

    hasSyncedMeta(string)

    Declaration
    public hasSyncedMeta(key: string): boolean
    Parameters
    Type Name Description
    string key
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    hasSyncedMeta<K extends never>(K)

    Declaration
    public hasSyncedMeta<K extends never>(key: K): boolean
    Parameters
    Type Name Description
    K key
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    getSyncedMetaKeys()

    Declaration
    public getSyncedMetaKeys(): readonly string[]
    Returns
    Type Description
    readonly string[]
    | Improve this Doc View Source

    setSyncedMeta<K extends string>(K, InterfaceValueByKey<ICustomEntitySyncedMeta, K, unknown, void>)

    Declaration
    public setSyncedMeta<K extends string>(key: K, value: InterfaceValueByKey<ICustomEntitySyncedMeta, K, unknown, void>): void
    Parameters
    Type Name Description
    K key
    InterfaceValueByKey<ICustomEntitySyncedMeta, K, unknown, void> value
    | Improve this Doc View Source

    setSyncedMeta<K extends never>(K, ICustomEntitySyncedMeta[K])

    Declaration
    public setSyncedMeta<K extends never>(key: K, value: ICustomEntitySyncedMeta[K]): void
    Parameters
    Type Name Description
    K key
    ICustomEntitySyncedMeta[K] value
    | Improve this Doc View Source

    setSyncedMeta<V extends unknown, K extends string>(K, InterfaceValueByKey<ICustomEntitySyncedMeta, K, V, void>)

    Declaration
    public setSyncedMeta<V extends unknown, K extends string>(key: K, value: InterfaceValueByKey<ICustomEntitySyncedMeta, K, V, void>): void
    Parameters
    Type Name Description
    K key
    InterfaceValueByKey<ICustomEntitySyncedMeta, K, V, void> value
    | Improve this Doc View Source

    setSyncedMeta(MetaValues<ICustomEntitySyncedMeta>)

    Declaration
    public setSyncedMeta(values: MetaValues<ICustomEntitySyncedMeta>): void
    Parameters
    Type Name Description
    MetaValues<ICustomEntitySyncedMeta> values
    | Improve this Doc View Source

    deleteStreamSyncedMeta(string)

    Declaration
    public deleteStreamSyncedMeta(key: string): void
    Parameters
    Type Name Description
    string key
    | Improve this Doc View Source

    deleteStreamSyncedMeta<K extends never>(K)

    Declaration
    public deleteStreamSyncedMeta<K extends never>(key: K): void
    Parameters
    Type Name Description
    K key
    | Improve this Doc View Source

    getStreamSyncedMeta<K extends string>(Exclude<K, never>)

    Declaration
    public getStreamSyncedMeta<K extends string>(key: Exclude<K, never>): unknown
    Parameters
    Type Name Description
    Exclude<K, never> key
    Returns
    Type Description
    unknown
    | Improve this Doc View Source

    getStreamSyncedMeta<K extends never>(K)

    Declaration
    public getStreamSyncedMeta<K extends never>(key: K): undefined | ICustomEntityStreamSyncedMeta[K]
    Parameters
    Type Name Description
    K key
    Returns
    Type Description
    undefined | ICustomEntityStreamSyncedMeta[K]
    | Improve this Doc View Source

    getStreamSyncedMeta<V extends unknown>(string)

    Declaration
    public getStreamSyncedMeta<V extends unknown>(key: string): undefined | V
    Parameters
    Type Name Description
    string key
    Returns
    Type Description
    undefined | V
    | Improve this Doc View Source

    hasStreamSyncedMeta(string)

    Declaration
    public hasStreamSyncedMeta(key: string): boolean
    Parameters
    Type Name Description
    string key
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    hasStreamSyncedMeta<K extends never>(K)

    Declaration
    public hasStreamSyncedMeta<K extends never>(key: K): boolean
    Parameters
    Type Name Description
    K key
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    getStreamSyncedMetaKeys()

    Declaration
    public getStreamSyncedMetaKeys(): readonly string[]
    Returns
    Type Description
    readonly string[]
    | Improve this Doc View Source

    setStreamSyncedMeta<K extends string>(K, InterfaceValueByKey<ICustomEntityStreamSyncedMeta, K, unknown, void>)

    Declaration
    public setStreamSyncedMeta<K extends string>(key: K, value: InterfaceValueByKey<ICustomEntityStreamSyncedMeta, K, unknown, void>): void
    Parameters
    Type Name Description
    K key
    InterfaceValueByKey<ICustomEntityStreamSyncedMeta, K, unknown, void> value
    | Improve this Doc View Source

    setStreamSyncedMeta<K extends never>(K, ICustomEntityStreamSyncedMeta[K])

    Declaration
    public setStreamSyncedMeta<K extends never>(key: K, value: ICustomEntityStreamSyncedMeta[K]): void
    Parameters
    Type Name Description
    K key
    ICustomEntityStreamSyncedMeta[K] value
    | Improve this Doc View Source

    setStreamSyncedMeta<V extends unknown, K extends string>(K, InterfaceValueByKey<ICustomEntityStreamSyncedMeta, K, V, void>)

    Declaration
    public setStreamSyncedMeta<V extends unknown, K extends string>(key: K, value: InterfaceValueByKey<ICustomEntityStreamSyncedMeta, K, V, void>): void
    Parameters
    Type Name Description
    K key
    InterfaceValueByKey<ICustomEntityStreamSyncedMeta, K, V, void> value
    | Improve this Doc View Source

    setStreamSyncedMeta(MetaValues<ICustomEntityStreamSyncedMeta>)

    Declaration
    public setStreamSyncedMeta(values: MetaValues<ICustomEntityStreamSyncedMeta>): void
    Parameters
    Type Name Description
    MetaValues<ICustomEntityStreamSyncedMeta> values
    | Improve this Doc View Source

    setNetOwner(Player, boolean)

    Declaration
    public setNetOwner(player: Player, disableMigration?: boolean): void
    Parameters
    Type Name Description
    Player player
    boolean disableMigration
    | Improve this Doc View Source

    resetNetOwner(boolean)

    Declaration
    public resetNetOwner(disableMigration?: boolean): void
    Parameters
    Type Name Description
    boolean disableMigration
    | Improve this Doc View Source

    attachTo(Entity, string | number, string | number, IVector3, IVector3, boolean, boolean)

    Declaration
    public attachTo(entity: Entity, entityBone: string | number, ownBone: string | number, pos: IVector3, rot: IVector3, enableCollisions: boolean, noFixedRotation: boolean): void
    Parameters
    Type Name Description
    Entity entity
    string | number entityBone
    string | number ownBone
    IVector3 pos
    IVector3 rot
    boolean enableCollisions
    boolean noFixedRotation
    | Improve this Doc View Source

    detach()

    Declaration
    public detach(): void