REVO / API version 0.0.10
ColshapeCylinder
Height extends upwards from z.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ColshapeCylinder(
x,y,z,radius,height):ColshapeCylinder
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
x |
number |
y |
number |
z |
number |
radius |
number |
height |
number |
Returns
Section titled “Returns”ColshapeCylinder
Overrides
Section titled “Overrides”Colshape.constructor
Properties
Section titled “Properties”| Property | Type | Details |
|---|---|---|
colshapeType |
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. |
height |
number |
— |
id |
number |
|
isStreamedIn |
boolean |
|
playersOnly |
boolean |
Defaults to false. Includes the local player and other streamed-in players when true. |
radius |
number |
— |
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 |
BaseType |
|
valid |
boolean |
|
all |
readonly ColshapeCylinder[] |
|
count |
number |
Accessors
Section titled “Accessors”| Accessor | Type | Details |
|---|---|---|
pos |
Read: Vector3Write: IVector3 |
|
quaternion |
Read: QuaternionWrite: IQuaternion |
|
rot |
Read: Vector3Write: IVector3 |
Euler angles in radians, applied X, then Y, then Z. |
Methods
Section titled “Methods”destroy()
Section titled “destroy()”destroy():
void
Emits leave for each tracked member before invalidating the shape.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”getSyncedMeta()
Section titled “getSyncedMeta()”Call Signature
Section titled “Call Signature”getSyncedMeta<
K>(key):ICustomBaseSyncedMeta[K] |undefined
Returns a copy. Client-only objects have no synced metadata.
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
K extends never |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
key |
K |
Returns
Section titled “Returns”ICustomBaseSyncedMeta[K] | undefined
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”getSyncedMeta<
T>(key):T|undefined
Returns a copy. Client-only objects have no synced metadata.
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
T |
TransportValue |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
key |
string |
Returns
Section titled “Returns”T | undefined
Inherited from
Section titled “Inherited from”getSyncedMetaKeys()
Section titled “getSyncedMetaKeys()”getSyncedMetaKeys():
string[]
Returns
Section titled “Returns”string[]
Inherited from
Section titled “Inherited from”hasSyncedMeta()
Section titled “hasSyncedMeta()”hasSyncedMeta(
key):boolean
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
key |
string |
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”isEntityIn()
Section titled “isEntityIn()”isEntityIn(
entity):boolean
Requires both the shape and entity to be streamed in. Invalid entities throw.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
entity |
Entity |
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”isPointIn()
Section titled “isPointIn()”isPointIn(
point):boolean
Checks geometry even while the shape is inactive.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
point |
IVector3 |
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”getById()
Section titled “getById()”
staticgetById(id):ColshapeCylinder|null
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
number |
Returns
Section titled “Returns”ColshapeCylinder | null