Index

Search Results for

    Class Checkpoint

    Inheritance
    BaseObject
    BaseObject
    WorldObject
    Colshape
    Checkpoint
    Inherited Members
    Colshape.deleteSyncedMeta
    Colshape.setSyncedMeta
    pos
    min
    max
    Colshape.type
    Colshape.valid
    Colshape.id
    Colshape.destroy
    Colshape.getMetaDataKeys
    Colshape.getSyncedMeta
    Colshape.hasSyncedMeta
    Colshape.getSyncedMetaKeys
    Colshape.refCount
    Module: alt-server
    Package: @altmp/altv-types
    Syntax
    class Checkpoint extends Colshape

    Constructors

    | Improve this Doc View Source

    Checkpoint(CheckpointType, number, number, number, number, number, number, number, number, number, number)

    Declaration
    Checkpoint(type: CheckpointType, x: number, y: number, z: number, radius: number, height: number, r: number, g: number, b: number, a: number, streamingDistance: number): Checkpoint
    Parameters
    Type Name Description
    CheckpointType type
    number x
    number y
    number z
    number radius
    number height
    number r
    number g
    number b
    number a
    number streamingDistance
    | Improve this Doc View Source

    Checkpoint(CheckpointType, IVector3, number, number, RGBA, number)

    Declaration
    Checkpoint(type: CheckpointType, pos: IVector3, radius: number, height: number, color: RGBA, streamingDistance: number): Checkpoint
    Parameters
    Type Name Description
    CheckpointType type
    IVector3 pos
    number radius
    number height
    RGBA color
    number streamingDistance

    Properties

    | Improve this Doc View Source

    streamingDistance

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

    all

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

    count

    Declaration
    public readonly static count: 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

    getByID(number)

    Declaration
    public static getByID(id: number): null | Checkpoint
    Parameters
    Type Name Description
    number id
    Returns
    Type Description
    null | Checkpoint
    | 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 | ICustomCheckpointMeta[K]
    Parameters
    Type Name Description
    K key
    Returns
    Type Description
    undefined | ICustomCheckpointMeta[K]
    | Improve this Doc View Source

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

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

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

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

    setMeta(MetaValues<ICustomCheckpointMeta>)

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

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

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

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

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

    setStreamSyncedMeta(MetaValues<ICustomCheckpointStreamSyncedMeta>)

    Declaration
    public setStreamSyncedMeta(values: MetaValues<ICustomCheckpointStreamSyncedMeta>): void
    Parameters
    Type Name Description
    MetaValues<ICustomCheckpointStreamSyncedMeta> 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 | ICustomCheckpointStreamSyncedMeta[K]
    Parameters
    Type Name Description
    K key
    Returns
    Type Description
    undefined | ICustomCheckpointStreamSyncedMeta[K]
    | 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[]