REVO / API version 0.0.10
LocalObject
Created asynchronously when streamed in. Collections and lookups include only this resource’s objects.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new LocalObject(
model,position,rotation,dynamic?):LocalObject
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
model |
string | number |
- |
position |
IVector3 |
- |
rotation |
number | IVector3 | IQuaternion |
Heading or XYZ Euler angles in radians, or a non-zero quaternion (normalized on creation). |
dynamic? |
boolean |
Whether the object uses dynamic physics. Defaults to true. |
Returns
Section titled “Returns”LocalObject
Overrides
Section titled “Overrides”Object.constructor
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. |
dynamic |
boolean |
|
heading |
number |
Heading in radians. |
health |
number |
|
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 |
false |
|
isStreamedIn |
boolean |
|
maxHealth |
number |
|
netOwner |
Player | null |
|
networkId |
null |
Server-assigned network ID, or null without replication. Separate from id. |
physicsAsleep |
boolean |
|
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 LocalObject[] |
|
count |
number |
Accessors
Section titled “Accessors”| Accessor | Type | Details |
|---|---|---|
angVelocity |
Read: Vector3Write: IVector3 |
Angular velocity in radians per second. |
modelHash |
Read: numberWrite: string | number |
Accepts a model name or nonzero hash of the same entity type. Returns the old hash until the new model is applied. |
pos |
Read: Vector3Write: IVector3 |
|
quaternion |
Read: QuaternionWrite: IQuaternion |
|
rot |
Read: Vector3Write: IVector3 |
Euler angles in radians, applied X, then Y, then Z. |
velocity |
Read: Vector3Write: IVector3 |
Methods
Section titled “Methods”activatePhysics()
Section titled “activatePhysics()”activatePhysics():
void
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”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
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”setAppearance()
Section titled “setAppearance()”setAppearance(
alpha,textureVariation,lodDistance):void
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
alpha |
number |
Integer in [0, 255]. |
textureVariation |
number |
Integer in [0, 255]. |
lodDistance |
number |
Integer in [-1, 65535]. -1 restores the model default. |
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”getById()
Section titled “getById()”
staticgetById(id):LocalObject|null
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
number |
Returns
Section titled “Returns”LocalObject | null
Overrides
Section titled “Overrides”getByNetworkId()
Section titled “getByNetworkId()”
staticgetByNetworkId(networkId):null
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
networkId |
number |
Returns
Section titled “Returns”null
Overrides
Section titled “Overrides”getByScriptId()
Section titled “getByScriptId()”
staticgetByScriptId(scriptID):LocalObject|null
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
scriptID |
number |
Returns
Section titled “Returns”LocalObject | null