Index

Search Results for

    Class Entity

    Inheritance
    BaseObject
    BaseObject
    WorldObject
    Entity
    Inherited Members
    WorldObject.constructor
    WorldObject.type
    WorldObject.valid
    WorldObject.id
    WorldObject.destroy
    WorldObject.getMetaDataKeys
    WorldObject.refCount
    Module: alt-client
    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

    scriptID

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

    netOwner

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

    isSpawned

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

    pos

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

    rot

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

    visible

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

    frozen

    Declaration
    public frozen: boolean
    Property Value
    Type Description
    boolean

    Methods

    | Improve this Doc View Source

    getByScriptID(number)

    Declaration
    public static getByScriptID(scriptID: number): null | Entity
    Parameters
    Type Name Description
    number scriptID
    Returns
    Type Description
    null | Entity
    | 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

    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

    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

    getSyncInfo()

    Declaration
    public getSyncInfo(): ISyncInfo
    Returns
    Type Description
    ISyncInfo