Skip to content

REVO / API version 0.0.10

Entity

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

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

Inherited from WorldBase.dimension
id
readonly
number Inherited from WorldBase.id
networkId
readonly
number | null Network ID shared with clients. null after destruction.
type
readonly
BaseType Inherited from WorldBase.type
valid
readonly
boolean Inherited from WorldBase.valid
visible boolean —
all
static readonly
readonly Entity[] Overrides WorldBase.all
count
static readonly
number Overrides WorldBase.count
Accessor Type Details
modelHash Read: number
Write: string | number
Accepts a model name or nonzero uint32 hash. Clients load the new model asynchronously.
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

deleteSyncedMeta(key): void

Parameter Type
key string

void

WorldBase.deleteSyncedMeta


destroy(): void

Deletes the entity. Throws for players and already destroyed entities.

void


getObservers(): readonly Player[]

readonly Player[]


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

Type Parameter
K extends never
Parameter Type
key K

ICustomBaseSyncedMeta[K] | undefined

WorldBase.getSyncedMeta

getSyncedMeta<T>(key): T | undefined

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


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

WorldBase.setSyncedMeta

setSyncedMeta(values): void

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

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

void

WorldBase.setSyncedMeta


static getById(id): Entity | null

Parameter Type
id number

Entity | null

WorldBase.getById


static getByNetworkId(networkId): Entity | null

Parameter Type
networkId number

Entity | null


static getInRadius(position, radius, dimension?): readonly Entity[]

Includes global entities alongside the selected dimension. globalDimension selects only global entities. Omit it to search all worlds.

Parameter Type
position IVector3
radius number
dimension? number

readonly Entity[]