Skip to content
On this page

Interface: ColliderProps ​

WebSG.ColliderProps

Collider properties interface.

Table of contents ​

Properties ​

Properties ​

height ​

• Optional height: number

The height of the Collider (required for capsule and cylinder types).

Defined in ​

websg.d.ts:138


isTrigger ​

• Optional isTrigger: boolean

Determines if the Collider acts as a trigger.

Defined in ​

websg.d.ts:126


mesh ​

• Optional mesh: Mesh

The mesh representing the shape of the Collider (required for hull and trimesh types).

Defined in ​

websg.d.ts:142


radius ​

• Optional radius: number

The radius of the Collider (required for sphere, capsule, and cylinder types).

Defined in ​

websg.d.ts:134


size ​

• Optional size: ArrayLike<number>

The size of the Collider (required for box type).

Defined in ​

websg.d.ts:130


type ​

• type: ColliderType

The type of the Collider.

Defined in ​

websg.d.ts:122