Skip to main content
Branch: Release Candidate

AreaBlip

Hierarchy

  • Blip
    • AreaBlip

Index

Constructors

Properties

Methods

Constructors

constructor

  • new AreaBlip(x: number, y: number, z: number, width: number, height: number): AreaBlip

Properties

publicalpha

alpha: number

publicasMissionCreator

asMissionCreator: boolean

publicblipType

blipType: BlipType

publicbright

bright: boolean

publiccategory

category: number

publiccolor

color: number

publiccrewIndicatorVisible

crewIndicatorVisible: boolean

publicdimension

dimension: number

Object dimension.

Remarks

Check https://docs.altv.mp/articles/dimensions.html to understand how it works.

publicdisplay

display: number

publicflashInterval

flashInterval: number

publicflashTimer

flashTimer: number

publicflashes

flashes: boolean

publicflashesAlternate

flashesAlternate: boolean

publicfriendIndicatorVisible

friendIndicatorVisible: boolean

publicgxtName

gxtName: string

publicheading

heading: number

publicheadingIndicatorVisible

headingIndicatorVisible: boolean

publichighDetail

highDetail: boolean

publicreadonlyid

id: number

publicreadonlyisAttached

isAttached: boolean

publicisFriendly

isFriendly: boolean

publicreadonlyisGlobal

isGlobal: boolean

publicisHiddenOnLegend

isHiddenOnLegend: boolean

publicisMinimalOnEdge

isMinimalOnEdge: boolean

publicreadonlyisRemote

isRemote: boolean

Whether this entity was created clientside or serverside. (Clientside = false, Serverside = true).

publicisShortHeightThreshold

isShortHeightThreshold: boolean

publicreadonlyisStreamedIn

isStreamedIn: boolean

publicname

name: string

publicnumber

number: number

publicoutlineIndicatorVisible

outlineIndicatorVisible: boolean

publicpos

pos: Vector3

Object position

publicpriority

priority: number

publicpulse

pulse: boolean

publicreadonlyrefCount

refCount: number

Returns the ref count of the entity.

Remarks

It’s only available in debug-mode.

publicreadonlyremoteID

remoteID: number

The serverside id of this entity.

publicroute

route: boolean

publicrouteColor

routeColor: RGBA

publicscale

scale: number

publicreadonlyscriptID

scriptID: number

publicsecondaryColor

secondaryColor: number | RGBA

publicshortRange

shortRange: boolean

publicshowCone

showCone: boolean

publicshrinked

shrinked: boolean

publicsize

size: Vector2

publicsprite

sprite: BlipSprite

publictickVisible

tickVisible: boolean

publicreadonlytype

type: BaseObjectType

Type of the object.

publicuseHeightIndicatorOnEdge

useHeightIndicatorOnEdge: boolean

publicreadonlyvalid

valid: boolean

Object usability.

Returns

False if object is no longer usable.

publicvisible

visible: boolean

publicstaticreadonlyall

all: readonly Blip[]

Array with all blips.

Remarks

This creates a clone of the array everytime it is called. It is advised to call this once and store the result in a variable, before iterating over it.

Example 

const blips = alt.Blip.all; // Store it in a variable, so it doesn't create a copy of the array on each iteration
for(let i = 0; i < blips.length; i++)
{
  alt.log(`${blips[i].scriptID}`); // Logs the scriptID of every blip
}

publicstaticreadonlycount

count: number

Methods

publicdeleteMeta

  • deleteMeta(key: string): void
  • deleteMeta<K>(key: K): void

publicdestroy

  • destroy(): void

  • Removes the object from the world.

publicfade

  • fade(opacity: number, duration: number): void

publicgetMeta

  • getMeta<K>(key: Exclude<K, never>): unknown
  • getMeta<K>(key: K): undefined | ICustomBlipMeta[K]
  • getMeta<V>(key: string): undefined | V

  • Type parameters

    • K: string

publicgetMetaDataKeys

  • getMetaDataKeys(): readonly string[]

publicgetSyncedMeta

  • getSyncedMeta<K>(key: Exclude<K, never>): unknown
  • getSyncedMeta<K>(key: K): undefined | ICustomBaseObjectSyncedMeta[K]
  • getSyncedMeta<V>(key: string): undefined | V

  • Gets a value using the specified key.

    Type parameters

    • K: string

publicgetSyncedMetaKeys

  • getSyncedMetaKeys(): readonly string[]

publichasMeta

  • hasMeta(key: string): boolean
  • hasMeta<K>(key: K): boolean

publichasSyncedMeta

  • hasSyncedMeta(key: string): boolean
  • hasSyncedMeta<K>(key: K): boolean

  • Determines whether contains the specified key.

publicsetMeta

  • setMeta<K>(key: K, value: InterfaceValueByKey<ICustomBlipMeta, K, unknown, void>): void
  • setMeta<K>(key: K, value: ICustomBlipMeta[K]): void
  • setMeta<V, K>(key: K, value: InterfaceValueByKey<ICustomBlipMeta, K, V, void>): void

  • Type parameters

    • K: string

publicstaticgetByID

  • getByID(id: number): null | Blip

  • Retrieves the blip from the pool.

publicstaticgetByRemoteID

  • getByRemoteID(id: number): null | Blip

  • Gets the blip with the given remote id

publicstaticgetByScriptID

  • getByScriptID(scriptID: number): null | Blip

  • Retrieves the blip from the pool.