Skip to content

REVO / API version 0.0.10

WorldBase

Position and rotation getters return copies. Assign a new value to apply changes.

Property Type Details
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.
id
readonly
number Inherited from Base.id
type
readonly
BaseType Inherited from Base.type
valid
readonly
boolean Inherited from Base.valid
all
static readonly
readonly WorldBase[] Overrides Base.all
count
static readonly
number Overrides Base.count
Accessor Type Details
pos Read: Vector3
Write: IVector3
—
quaternion Read: Quaternion
Write: IQuaternion
—
rot Read: Vector3
Write: IVector3
Euler angles in radians, applied X, then Y, then Z.

deleteSyncedMeta(key): void

Parameter Type
key string

void

Base.deleteSyncedMeta


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

Type Parameter
K extends never
Parameter Type
key K

ICustomBaseSyncedMeta[K] | undefined

Base.getSyncedMeta

getSyncedMeta<T>(key): T | undefined

Type Parameter Default type
T TransportValue
Parameter Type
key string

T | undefined

Base.getSyncedMeta


getSyncedMetaKeys(): string[]

string[]

Base.getSyncedMetaKeys


hasSyncedMeta(key): boolean

Parameter Type
key string

boolean

Base.hasSyncedMeta


setSyncedMeta<K>(key, value): void

Copies and replicates the value to the object’s audience. Player metadata also goes to that player.

Type Parameter
K extends string
Parameter Type
key K
value K extends never ? ICustomBaseSyncedMeta[K] : TransportValue

void

Base.setSyncedMeta

setSyncedMeta(values): void

Atomically merges own enumerable fields. Unsupported values reject the entire batch.

Parameter Type
values Partial<ICustomBaseSyncedMeta> & Record<string, TransportValue>

void

Base.setSyncedMeta


static getById(id): WorldBase | null

Parameter Type
id number

WorldBase | null

Base.getById