Index

Search Results for

    Class VirtualEntity

    Inheritance
    BaseObject
    BaseObject
    WorldObject
    VirtualEntity
    Inherited Members
    WorldObject.deleteMeta
    WorldObject.hasMeta
    WorldObject.getMeta
    WorldObject.setMeta
    WorldObject.deleteSyncedMeta
    WorldObject.setSyncedMeta
    pos
    WorldObject.type
    WorldObject.valid
    WorldObject.id
    WorldObject.destroy
    WorldObject.getMetaDataKeys
    WorldObject.getSyncedMeta
    WorldObject.hasSyncedMeta
    WorldObject.getSyncedMetaKeys
    WorldObject.refCount
    Module: alt-server
    Package: @altmp/altv-types
    Syntax
    class VirtualEntity extends WorldObject

    Constructors

    | Improve this Doc View Source

    VirtualEntity(VirtualEntityGroup, Vector3, number, Record<string, any>)

    Declaration
    public VirtualEntity(group: VirtualEntityGroup, position: Vector3, streamingDistance: number, data?: Record<string, any>): VirtualEntity
    Parameters
    Type Name Description
    VirtualEntityGroup group
    Vector3 position
    number streamingDistance
    Record<string, any> data

    Properties

    | Improve this Doc View Source

    all

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

    group

    Declaration
    public readonly group: VirtualEntityGroup
    Property Value
    Type Description
    VirtualEntityGroup
    | Improve this Doc View Source

    streamingDistance

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

    visible

    Declaration
    public visible: boolean
    Property Value
    Type Description
    boolean

    Methods

    | 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 | ICustomVirtualEntityStreamSyncedMeta[K]
    Parameters
    Type Name Description
    K key
    Returns
    Type Description
    undefined | ICustomVirtualEntityStreamSyncedMeta[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<ICustomVirtualEntityStreamSyncedMeta, K, unknown, void>)

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

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

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

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

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

    setStreamSyncedMeta(MetaValues<ICustomVirtualEntityStreamSyncedMeta>)

    Declaration
    public setStreamSyncedMeta(values: MetaValues<ICustomVirtualEntityStreamSyncedMeta>): void
    Parameters
    Type Name Description
    MetaValues<ICustomVirtualEntityStreamSyncedMeta> 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