Index

Search Results for

    Class Blip

    Inheritance
    BaseObject
    BaseObject
    WorldObject
    Blip
    Inherited Members
    pos
    WorldObject.constructor
    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 Blip extends WorldObject

    Properties

    | Improve this Doc View Source

    all

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

    count

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

    scriptID

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

    routeColor

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

    alpha

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

    asMissionCreator

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

    bright

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

    category

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

    color

    Declaration
    public color: number | White | Red | Green | Blue | LightRed | Violet | Pink | LightOrange | LightBrown | LightGreen | LightBlue | LightPurple | DarkPurple | Cyan | LightYellow | Organe | GraniteGreen | DarkBrown | LightGray | LightPink | LemonGreen | ForestGreen | ElectricBlue | BrightPurple | DarkYellow | PinkRed | Orange | BrilliantRose | Salmon | DarkGreen | BlizzardBlue | OracleBlue | Silver | MulberryPink | AltoGray | JellyBeanBlue | DarkOrange | Mamba
    Property Value
    Type Description
    number | White | Red | Green | Blue | LightRed | Violet | Pink | LightOrange | LightBrown | LightGreen | LightBlue | LightPurple | DarkPurple | Cyan | LightYellow | Organe | GraniteGreen | DarkBrown | LightGray | LightPink | LemonGreen | ForestGreen | ElectricBlue | BrightPurple | DarkYellow | PinkRed | Orange | BrilliantRose | Salmon | DarkGreen | BlizzardBlue | OracleBlue | Silver | MulberryPink | AltoGray | JellyBeanBlue | DarkOrange | Mamba
    | Improve this Doc View Source

    crewIndicatorVisible

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

    display

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

    flashes

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

    flashesAlternate

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

    flashInterval

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

    flashTimer

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

    friendIndicatorVisible

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

    gxtName

    Declaration
    public gxtName: string
    Property Value
    Type Description
    string
    | Improve this Doc View Source

    heading

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

    headingIndicatorVisible

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

    highDetail

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

    name

    Declaration
    public name: string
    Property Value
    Type Description
    string
    | Improve this Doc View Source

    number

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

    outlineIndicatorVisible

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

    priority

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

    pulse

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

    route

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

    scale

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

    secondaryColor

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

    shortRange

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

    showCone

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

    shrinked

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

    size

    Declaration
    public size: Vector2
    Property Value
    Type Description
    Vector2
    | Improve this Doc View Source

    sprite

    Declaration
    public sprite: BlipSprite
    Property Value
    Type Description
    BlipSprite
    | Improve this Doc View Source

    tickVisible

    Declaration
    public tickVisible: 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

    blipType

    Declaration
    public blipType: BlipType
    Property Value
    Type Description
    BlipType
    | Improve this Doc View Source

    isFriendly

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

    isHiddenOnLegend

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

    isMinimalOnEdge

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

    useHeightIndicatorOnEdge

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

    isShortHeightThreshold

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

    isStreamedIn

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

    isAttached

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

    isGlobal

    Declaration
    public readonly isGlobal: boolean
    Property Value
    Type Description
    boolean

    Methods

    | Improve this Doc View Source

    getByID(number)

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

    getByScriptID(number)

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

    getByRemoteID(number)

    Declaration
    public static getByRemoteID(id: number): null | Blip
    Parameters
    Type Name Description
    number id
    Returns
    Type Description
    null | Blip
    | Improve this Doc View Source

    fade(number, number)

    Declaration
    public fade(opacity: number, duration: number): void
    Parameters
    Type Name Description
    number opacity
    number duration
    | 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 | ICustomBlipMeta[K]
    Parameters
    Type Name Description
    K key
    Returns
    Type Description
    undefined | ICustomBlipMeta[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<ICustomBlipMeta, K, unknown, void>)

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

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

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

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

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

    setMeta(MetaValues<ICustomBlipMeta>)

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