REVO / API version 0.0.10
AreaBlip
Map blip with no distance culling.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new AreaBlip(
x,y,z,width,height):AreaBlip
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
x |
number |
y |
number |
z |
number |
width |
number |
height |
number |
Returns
Section titled “Returns”AreaBlip
Overrides
Section titled “Overrides”Blip.constructor
Properties
Section titled “Properties”| Property | Type | Details |
|---|---|---|
alpha |
number |
|
blipType |
BlipType |
|
color |
number |
GTA palette index, 0..255. |
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. |
display |
number |
GTA display mode, 0..10. |
flashes |
boolean |
|
flashesAlternate |
boolean |
|
flashInterval |
number |
|
flashTimer |
number |
Duration in milliseconds. -1 means indefinite. |
heading |
number |
Heading in radians. Point sprites stay upright until a rotation is explicitly assigned. |
id |
number |
|
isStreamedIn |
boolean |
|
name |
string |
|
priority |
number |
|
route |
boolean |
|
routeColor |
number |
GTA route palette index, 0..255. |
scale |
number |
|
scriptID |
number |
0 until created on an active game frame, and after destruction. |
shortRange |
boolean |
|
size |
Vector2 |
— |
streamDistance |
number | null |
Per-object distance in metres. null uses the streamer’s default. |
streamingEnabled |
boolean |
Enables automatic streaming. Disabling it preserves the current streaming state. A dimension mismatch still suspends it until its dimension is visible again. |
type |
BaseType |
|
valid |
boolean |
|
visible |
boolean |
|
all |
readonly AreaBlip[] |
|
count |
number |
Accessors
Section titled “Accessors”| Accessor | Type | Details |
|---|---|---|
pos |
Read: Vector3Write: IVector3 |
|
quaternion |
Read: QuaternionWrite: IQuaternion |
|
rot |
Read: Vector3Write: IVector3 |
Euler angles in radians, applied X, then Y, then Z. |
Methods
Section titled “Methods”destroy()
Section titled “destroy()”destroy():
void
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”fade()
Section titled “fade()”fade(
alpha,durationMs):void
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
alpha |
number |
durationMs |
number |
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”getSyncedMeta()
Section titled “getSyncedMeta()”Call Signature
Section titled “Call Signature”getSyncedMeta<
K>(key):ICustomBaseSyncedMeta[K] |undefined
Returns a copy. Client-only objects have no synced metadata.
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
K extends never |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
key |
K |
Returns
Section titled “Returns”ICustomBaseSyncedMeta[K] | undefined
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”getSyncedMeta<
T>(key):T|undefined
Returns a copy. Client-only objects have no synced metadata.
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
T |
TransportValue |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
key |
string |
Returns
Section titled “Returns”T | undefined
Inherited from
Section titled “Inherited from”getSyncedMetaKeys()
Section titled “getSyncedMetaKeys()”getSyncedMetaKeys():
string[]
Returns
Section titled “Returns”string[]
Inherited from
Section titled “Inherited from”hasSyncedMeta()
Section titled “hasSyncedMeta()”hasSyncedMeta(
key):boolean
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
key |
string |
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”getById()
Section titled “getById()”
staticgetById(id):AreaBlip|null
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
number |
Returns
Section titled “Returns”AreaBlip | null
Overrides
Section titled “Overrides”getByScriptId()
Section titled “getByScriptId()”
staticgetByScriptId(scriptID):AreaBlip|null
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
scriptID |
number |
Returns
Section titled “Returns”AreaBlip | null