Skip to content

REVO / API version 0.0.10

Colshape

Axis-aligned trigger area with fixed geometry. Supports movement but rejects nonzero rotation. Checks entity positions throughout its dimension, regardless of distance.

Property Type Details
colshapeType
readonly
ColshapeType —
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.

Overrides Streamable.dimension
id
readonly
number Inherited from Streamable.id
isStreamedIn
readonly
boolean Inherited from Streamable.isStreamedIn
playersOnly boolean Defaults to false. Includes the local player and other streamed-in players when true.
streamDistance number | null Per-object distance in metres. null uses the streamer’s default.

Inherited from Streamable.streamDistance
streamingEnabled boolean Enables automatic streaming. Disabling it preserves the current streaming state. A dimension mismatch still suspends it until its dimension is visible again.

Inherited from Streamable.streamingEnabled
type
readonly
BaseType Inherited from Streamable.type
valid
readonly
boolean Inherited from Streamable.valid
all
static readonly
readonly Colshape[] Overrides Streamable.all
count
static readonly
number Overrides Streamable.count
Accessor Type Details
pos Read: Vector3
Write: IVector3
Inherited from Streamable.pos
quaternion Read: Quaternion
Write: IQuaternion
Inherited from Streamable.quaternion
rot Read: Vector3
Write: IVector3
Euler angles in radians, applied X, then Y, then Z.

Inherited from Streamable.rot

destroy(): void

Emits leave for each tracked member before invalidating the shape.

void


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

Streamable.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

Streamable.getSyncedMeta


getSyncedMetaKeys(): string[]

string[]

Streamable.getSyncedMetaKeys


hasSyncedMeta(key): boolean

Parameter Type
key string

boolean

Streamable.hasSyncedMeta


isEntityIn(entity): boolean

Requires both the shape and entity to be streamed in. Invalid entities throw.

Parameter Type
entity Entity

boolean


isPointIn(point): boolean

Checks geometry even while the shape is inactive.

Parameter Type
point IVector3

boolean


static getById(id): Colshape | null

Parameter Type
id number

Colshape | null

Streamable.getById

Colshapes