Skip to content

REVO / API version 0.0.10

AreaBlip

Map blip with no distance culling.

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

Parameter Type
x number
y number
z number
width number
height number

AreaBlip

Blip.constructor

Property Type Details
alpha number Inherited from Blip.alpha
blipType
readonly
BlipType Inherited from Blip.blipType
color number GTA palette index, 0..255.

Inherited from Blip.color
dimension number World ID, default 0. Writable on local objects created by this resource. The server controls other objects. globalDimension makes the object visible in every numbered world.

Inherited from Blip.dimension
display number GTA display mode, 0..10.

Inherited from Blip.display
flashes boolean Inherited from Blip.flashes
flashesAlternate boolean Inherited from Blip.flashesAlternate
flashInterval number Inherited from Blip.flashInterval
flashTimer number Duration in milliseconds. -1 means indefinite.

Inherited from Blip.flashTimer
heading number Heading in radians. Point sprites stay upright until a rotation is explicitly assigned.

Inherited from Blip.heading
id
readonly
number Inherited from Blip.id
isStreamedIn
readonly
boolean Inherited from Blip.isStreamedIn
name string Inherited from Blip.name
priority number Inherited from Blip.priority
route boolean Inherited from Blip.route
routeColor number GTA route palette index, 0..255.

Inherited from Blip.routeColor
scale number Inherited from Blip.scale
scriptID
readonly
number 0 until created on an active game frame, and after destruction.

Inherited from Blip.scriptID
shortRange boolean Inherited from Blip.shortRange
size
readonly
Vector2 —
streamDistance number | null Per-object distance in metres. null uses the streamer’s default.

Inherited from Blip.streamDistance
streamingEnabled boolean Enables automatic streaming. Disabling it preserves the current streaming state. A dimension mismatch still suspends it until its dimension is visible again.

Inherited from Blip.streamingEnabled
type
readonly
BaseType Inherited from Blip.type
valid
readonly
boolean Inherited from Blip.valid
visible boolean Inherited from Blip.visible
all
static readonly
readonly AreaBlip[] Overrides Blip.all
count
static readonly
number Inherited from Blip.count
Accessor Type Details
pos Read: Vector3
Write: IVector3
Inherited from Blip.pos
quaternion Read: Quaternion
Write: IQuaternion
Inherited from Blip.quaternion
rot Read: Vector3
Write: IVector3
Euler angles in radians, applied X, then Y, then Z.

Inherited from Blip.rot

destroy(): void

void

Blip.destroy


fade(alpha, durationMs): void

Parameter Type
alpha number
durationMs number

void

Blip.fade


getSyncedMeta<K>(key): ICustomBaseSyncedMeta[K] | undefined

Returns a copy. Client-only objects have no synced metadata.

Type Parameter
K extends never
Parameter Type
key K

ICustomBaseSyncedMeta[K] | undefined

Blip.getSyncedMeta

getSyncedMeta<T>(key): T | undefined

Returns a copy. Client-only objects have no synced metadata.

Type Parameter Default type
T TransportValue
Parameter Type
key string

T | undefined

Blip.getSyncedMeta


getSyncedMetaKeys(): string[]

string[]

Blip.getSyncedMetaKeys


hasSyncedMeta(key): boolean

Parameter Type
key string

boolean

Blip.hasSyncedMeta


static getById(id): AreaBlip | null

Parameter Type
id number

AreaBlip | null

Blip.getById


static getByScriptId(scriptID): AreaBlip | null

Parameter Type
scriptID number

AreaBlip | null

Blip.getByScriptId

Blips