Index

Search Results for

    Class Checkpoint

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

    Constructors

    | Improve this Doc View Source

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

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

    Properties

    | Improve this Doc View Source

    checkpointType

    Declaration
    public checkpointType: CheckpointType
    Property Value
    Type Description
    CheckpointType
    | Improve this Doc View Source

    nextPos

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

    radius

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

    height

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

    color

    Declaration
    public color: RGBA
    Property Value
    Type Description
    RGBA
    | Improve this Doc View Source

    iconColor

    Declaration
    public iconColor: RGBA
    Property Value
    Type Description
    RGBA
    | 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

    isStreamedIn

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

    visible

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

    scriptID

    Declaration
    public readonly scriptID: number
    Property Value
    Type Description
    number

    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

    getByScriptID(number)

    Declaration
    public static getByScriptID(scriptID: number): null | Checkpoint
    Parameters
    Type Name Description
    number scriptID
    Returns
    Type Description
    null | Checkpoint
    | Improve this Doc View Source

    isEntityIn(Entity)

    Declaration
    public isEntityIn(entity: Entity): boolean
    Parameters
    Type Name Description
    Entity entity
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    isPointIn(IVector3)

    Declaration
    public isPointIn(pos: IVector3): boolean
    Parameters
    Type Name Description
    IVector3 pos
    Returns
    Type Description
    boolean
    | 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

    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<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<V extends unknown, K extends string>(K, InterfaceValueByKey<ICustomCheckpointMeta, K, V, void>)

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

    setMeta(MetaValues<ICustomCheckpointMeta>)

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