Skip to content

REVO / API version 0.0.10

ColshapeSphere

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

new ColshapeSphere(x, y, z, radius): ColshapeSphere

Parameter Type
x number
y number
z number
radius number

ColshapeSphere

Colshape.constructor

Property Type Details
colshapeType
readonly
ColshapeType Inherited from Colshape.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.

Inherited from Colshape.dimension
id
readonly
number Inherited from Colshape.id
isStreamedIn
readonly
boolean Inherited from Colshape.isStreamedIn
playersOnly boolean Defaults to false. Includes the local player and other streamed-in players when true.

Inherited from Colshape.playersOnly
radius
readonly
number —
streamDistance number | null Per-object distance in metres. null uses the streamer’s default.

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

Inherited from Colshape.rot

destroy(): void

Emits leave for each tracked member before invalidating the shape.

void

Colshape.destroy


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

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

Colshape.getSyncedMeta


getSyncedMetaKeys(): string[]

string[]

Colshape.getSyncedMetaKeys


hasSyncedMeta(key): boolean

Parameter Type
key string

boolean

Colshape.hasSyncedMeta


isEntityIn(entity): boolean

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

Parameter Type
entity Entity

boolean

Colshape.isEntityIn


isPointIn(point): boolean

Checks geometry even while the shape is inactive.

Parameter Type
point IVector3

boolean

Colshape.isPointIn


static getById(id): ColshapeSphere | null

Parameter Type
id number

ColshapeSphere | null

Colshape.getById

Colshapes