REVO / API version 0.0.10
Entity
Only this resource’s local entities can be modified, except pos, heading and setPlayerControl on Player.local. Transforms, streaming settings and LocalPed appearance can be set before stream-in. Other writes require isStreamedIn. After destruction, networkId is null and isNetworked/ready/isStreamedIn are false.
Extends
Section titled “Extends”Extended by
Section titled “Extended by”Implements
Section titled “Implements”Properties
Section titled “Properties”| Property | Type | Details |
|---|---|---|
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. |
heading |
number |
Heading in radians. |
id |
number |
Local ID, assigned independently on the client and server. |
isLocallySimulated |
boolean |
Simulation authority does not grant permission to change server-owned state. |
isNetworked |
boolean |
— |
isStreamedIn |
boolean |
|
netOwner |
Player | null |
— |
networkId |
number | null |
Server-assigned network ID, or null without replication. Separate from id. |
ready |
boolean |
The initial server state has been applied, or a client-only entity has streamed in. |
scriptID |
number |
GTA handle, or 0 while not streamed in. Do not retain it across frames. |
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 |
|
all |
readonly Entity[] |
|
count |
number |
Accessors
Section titled “Accessors”| Accessor | Type | Details |
|---|---|---|
modelHash |
number |
|
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
Deletes an entity created by this resource. Throws if the entity is networked, belongs to another resource, has been destroyed, or cannot be removed from GTA.
Returns
Section titled “Returns”void
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):Entity|null
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
number |
Returns
Section titled “Returns”Entity | null
Overrides
Section titled “Overrides”getByNetworkId()
Section titled “getByNetworkId()”
staticgetByNetworkId(networkId):Entity|null
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
networkId |
number |
Returns
Section titled “Returns”Entity | null
getByScriptId()
Section titled “getByScriptId()”
staticgetByScriptId(scriptID):Entity|null
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
scriptID |
number |
Returns
Section titled “Returns”Entity | null