Skip to content

REVO / API version 0.0.10

Streamable

Remains accessible to scripts while streamed out.

Property Type Details
dimension
readonly
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.

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

Inherited from WorldBase.rot

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

Returns a copy. Client-only objects have no synced metadata.

Type Parameter
K extends never
Parameter Type
key K

ICustomBaseSyncedMeta[K] | undefined

WorldBase.getSyncedMeta

getSyncedMeta<T>(key): T | undefined

Returns a copy. Client-only objects have no synced metadata.

Type Parameter Default type
T TransportValue
Parameter Type
key string

T | undefined

WorldBase.getSyncedMeta


getSyncedMetaKeys(): string[]

string[]

WorldBase.getSyncedMetaKeys


hasSyncedMeta(key): boolean

Parameter Type
key string

boolean

WorldBase.hasSyncedMeta


static getById(id): Streamable | null

Parameter Type
id number

Streamable | null

WorldBase.getById