Skip to content

ColliderProps

Defined in: packages/engine/src/components/Entity.tsx:59

The body the entity has in the physics world: a shape, how it moves, the shape’s full extents in metres and the layers it collides with, as the Collider trait reads them. A hull is shaped from the entity’s model and reads no size.

Property Type Default value Description
collides? readonly CollisionLayer[] every layer The layers it collides with. The body itself stands in CollisionLayer.Props.
kind BodyKind undefined Fixed never moves, Kinematic follows the entity’s transform, and Dynamic falls, rolls and is pushed.
shape ColliderShape undefined -
size? Size undefined A box’s sides, a sphere’s diameter in width, and a capsule’s diameter in width and its height in height.