REVO / API version 0.0.10
Object
Position and rotation getters return copies. Assign a new value to apply changes.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Object(
model,position,rotation?,dynamic?):Object
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
model |
string | number |
Model name (ASCII case-insensitive) or unsigned 32-bit hash. |
position |
IVector3 |
- |
rotation? |
number | IVector3 | IQuaternion |
Heading or XYZ Euler angles in radians, or a unit quaternion. Defaults to zero heading. |
dynamic? |
boolean |
- |
Returns
Section titled “Returns”Object
Overrides
Section titled “Overrides”Physical.constructor
Properties
Section titled “Properties”| Property | Type | Details |
|---|---|---|
alpha |
number |
— |
collisionEnabled |
boolean |
|
dimension |
number |
Dimension: 0..4294967294, default 0. globalDimension shows entities and spatial audio in every dimension. Players cannot use globalDimension. Global entities share movement, damage and seats across dimensions. A vehicle’s trailer follows its dimension. Occupants follow unless the new dimension is global. |
health |
number |
|
id |
number |
|
lodDistance |
number |
— |
netOwner |
Player | null |
— |
networkId |
number | null |
Network ID shared with clients. null after destruction. |
physicsAsleep |
boolean |
— |
textureVariation |
number |
— |
type |
BaseType |
|
valid |
boolean |
|
visible |
boolean |
|
all |
readonly Object[] |
|
count |
number |
Accessors
Section titled “Accessors”| Accessor | Type | Details |
|---|---|---|
angVelocity |
Read: Vector3Write: IVector3 |
|
modelHash |
Read: numberWrite: string | number |
Accepts a model name or nonzero uint32 hash. Clients load the new model asynchronously. |
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():
boolean
Returns
Section titled “Returns”boolean
deleteSyncedMeta()
Section titled “deleteSyncedMeta()”deleteSyncedMeta(
key):void
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
key |
string |
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”destroy()
Section titled “destroy()”destroy():
void
Deletes the entity. Throws for players and already destroyed entities.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”getObservers()
Section titled “getObservers()”getObservers(): readonly
Player[]
Returns
Section titled “Returns”readonly Player[]
Inherited from
Section titled “Inherited from”getSyncedMeta()
Section titled “getSyncedMeta()”Call Signature
Section titled “Call Signature”getSyncedMeta<
K>(key):ICustomBaseSyncedMeta[K] |undefined
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
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”setSyncedMeta()
Section titled “setSyncedMeta()”Call Signature
Section titled “Call Signature”setSyncedMeta<
K>(key,value):void
Copies and replicates the value to the object’s audience. Player metadata also goes to that player.
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
K extends string |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
key |
K |
value |
K extends never ? ICustomBaseSyncedMeta[K] : TransportValue |
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”setSyncedMeta(
values):void
Atomically merges own enumerable fields. Unsupported values reject the entire batch.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
values |
Partial<ICustomBaseSyncedMeta> & Record<string, TransportValue> |
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”getById()
Section titled “getById()”
staticgetById(id):Object|null
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
number |
Returns
Section titled “Returns”Object | null
Overrides
Section titled “Overrides”getByNetworkId()
Section titled “getByNetworkId()”
staticgetByNetworkId(networkId):Object|null
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
networkId |
number |
Returns
Section titled “Returns”Object | null
Overrides
Section titled “Overrides”getInRadius()
Section titled “getInRadius()”
staticgetInRadius(position,radius,dimension?): readonlyObject[]
Includes global entities alongside the selected dimension. globalDimension selects only global entities. Omit it to search all worlds.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
position |
IVector3 |
radius |
number |
dimension? |
number |
Returns
Section titled “Returns”readonly Object[]