Index

Search Results for

    Class BaseObject

    Inheritance
    BaseObject
    BaseObject
    Inherited Members
    shared.BaseObject.constructor
    shared.BaseObject.type
    shared.BaseObject.valid
    shared.BaseObject.id
    shared.BaseObject.destroy
    shared.BaseObject.getMetaDataKeys
    shared.BaseObject.getSyncedMeta
    shared.BaseObject.hasSyncedMeta
    shared.BaseObject.getSyncedMetaKeys
    shared.BaseObject.refCount
    Module: alt-client
    Package: @altmp/altv-types
    Syntax
    class BaseObject extends BaseObject

    Properties

    | Improve this Doc View Source

    isRemote

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

    remoteID

    Declaration
    public readonly remoteID: number
    Property Value
    Type Description
    number

    Methods

    | Improve this Doc View Source

    getByID(BaseObjectType, number)

    Declaration
    public static getByID(type: BaseObjectType, id: number): null | BaseObject
    Parameters
    Type Name Description
    BaseObjectType type
    number id
    Returns
    Type Description
    null | BaseObject
    | Improve this Doc View Source

    getByRemoteID(BaseObjectType, number)

    Declaration
    public static getByRemoteID(type: BaseObjectType, id: number): null | BaseObject
    Parameters
    Type Name Description
    BaseObjectType type
    number id
    Returns
    Type Description
    null | BaseObject
    | 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

    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

    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 | ICustomBaseObjectMeta[K]
    Parameters
    Type Name Description
    K key
    Returns
    Type Description
    undefined | ICustomBaseObjectMeta[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

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

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

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

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

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

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

    setMeta(MetaValues<ICustomBaseObjectMeta>)

    Declaration
    public setMeta(values: MetaValues<ICustomBaseObjectMeta>): void
    Parameters
    Type Name Description
    MetaValues<ICustomBaseObjectMeta> values