[Home](./index.md) > [server](./server.md) > [Collider](./server.collider.md) ## Collider class Represents a collider in a world's physics simulation. When to use: defining collision shapes for rigid bodies or entities. Do NOT use for: gameplay queries; use `Simulation.raycast` or intersection APIs instead. **Signature:** ```typescript export default class Collider extends EventRouter ``` **Extends:** [EventRouter](./server.eventrouter.md) ## Remarks Colliders are usually created via `RigidBody` or `Entity` options. You can also create and manage them directly for advanced use cases. \*\*Category:\*\* Physics ## Constructors

Constructor	Modifiers	Description
[(constructor)(colliderOptions)](./server.collider._constructor_.md)		Creates a collider with the provided options. Use for: configuring a collider before adding it to a simulation or rigid body.

## Properties

Property	Modifiers	Type	Description
[bounciness](./server.collider.bounciness.md)	`readonly`	number	The bounciness of the collider. \*\*Category:\*\* Physics
[bouncinessCombineRule](./server.collider.bouncinesscombinerule.md)	`readonly`	[CoefficientCombineRule](./server.coefficientcombinerule.md)	The bounciness combine rule of the collider. \*\*Category:\*\* Physics
[collisionGroups](./server.collider.collisiongroups.md)	`readonly`	[CollisionGroups](./server.collisiongroups.md)	The collision groups the collider belongs to. \*\*Category:\*\* Physics
[friction](./server.collider.friction.md)	`readonly`	number	The friction of the collider. \*\*Category:\*\* Physics
[frictionCombineRule](./server.collider.frictioncombinerule.md)	`readonly`	[CoefficientCombineRule](./server.coefficientcombinerule.md)	The friction combine rule of the collider. \*\*Category:\*\* Physics
[isBall](./server.collider.isball.md)	`readonly`	boolean	Whether the collider is a ball collider. \*\*Category:\*\* Physics
[isBlock](./server.collider.isblock.md)	`readonly`	boolean	Whether the collider is a block collider. \*\*Category:\*\* Physics
[isCapsule](./server.collider.iscapsule.md)	`readonly`	boolean	Whether the collider is a capsule collider. \*\*Category:\*\* Physics
[isCone](./server.collider.iscone.md)	`readonly`	boolean	Whether the collider is a cone collider. \*\*Category:\*\* Physics
[isCylinder](./server.collider.iscylinder.md)	`readonly`	boolean	Whether the collider is a cylinder collider. \*\*Category:\*\* Physics
[isEnabled](./server.collider.isenabled.md)	`readonly`	boolean	Whether the collider is enabled. \*\*Category:\*\* Physics
[isNone](./server.collider.isnone.md)	`readonly`	boolean	Whether the collider is a none collider. \*\*Category:\*\* Physics
[isRemoved](./server.collider.isremoved.md)	`readonly`	boolean	Whether the collider has been removed from the simulation. \*\*Category:\*\* Physics
[isRoundCylinder](./server.collider.isroundcylinder.md)	`readonly`	boolean	Whether the collider is a round cylinder collider. \*\*Category:\*\* Physics
[isSensor](./server.collider.issensor.md)	`readonly`	boolean	Whether the collider is a sensor. \*\*Category:\*\* Physics
[isSimulated](./server.collider.issimulated.md)	`readonly`	boolean	Whether the collider is simulated. \*\*Category:\*\* Physics
[isTrimesh](./server.collider.istrimesh.md)	`readonly`	boolean	Whether the collider is a trimesh collider. \*\*Category:\*\* Physics
[isVoxel](./server.collider.isvoxel.md)	`readonly`	boolean	Whether the collider is a voxel collider. \*\*Category:\*\* Physics
[isWedge](./server.collider.iswedge.md)	`readonly`	boolean	Whether the collider is a wedge collider. \*\*Category:\*\* Physics
[parentRigidBody](./server.collider.parentrigidbody.md)	`readonly`	[RigidBody](./server.rigidbody.md) \| undefined	The parent rigid body of the collider. \*\*Category:\*\* Physics
[rawCollider](./server.collider.rawcollider.md)	`readonly`	[RawCollider](./server.rawcollider.md) \| undefined	The raw collider object from the Rapier physics engine. \*\*Category:\*\* Physics
[rawShape](./server.collider.rawshape.md)	`readonly`	[RawShape](./server.rawshape.md) \| undefined	The raw shape object from the Rapier physics engine. \*\*Category:\*\* Physics
[relativePosition](./server.collider.relativeposition.md)	`readonly`	[Vector3Like](./server.vector3like.md)	The relative position of the collider to its parent rigid body. \*\*Category:\*\* Physics
[relativeRotation](./server.collider.relativerotation.md)	`readonly`	[QuaternionLike](./server.quaternionlike.md)	The relative rotation of the collider. \*\*Category:\*\* Physics
[scale](./server.collider.scale.md)	`readonly`	[Vector3Like](./server.vector3like.md)	The scale of the collider. \*\*Category:\*\* Physics
[shape](./server.collider.shape.md)	`readonly`	[ColliderShape](./server.collidershape.md)	The shape of the collider. \*\*Category:\*\* Physics
[tag](./server.collider.tag.md)	`readonly`	string \| undefined	An arbitrary identifier tag of the collider. Useful for your own logic. \*\*Category:\*\* Physics

## Methods

Method	Modifiers	Description
[addToSimulation(simulation, parentRigidBody)](./server.collider.addtosimulation.md)		Adds the collider to the simulation.
[enableCollisionEvents(enabled)](./server.collider.enablecollisionevents.md)		Enables or disables collision events for the collider. This is automatically enabled if an on collision callback is set.
[enableContactForceEvents(enabled)](./server.collider.enablecontactforceevents.md)		Enables or disables contact force events for the collider. This is automatically enabled if an on contact force callback is set.
[optionsFromBlockHalfExtents(halfExtents)](./server.collider.optionsfromblockhalfextents.md)	`static`	Creates collider options from a block's half extents.
[optionsFromModelUri(modelUri, scale, preferredShape)](./server.collider.optionsfrommodeluri.md)	`static`	Creates collider options from a model URI using an approximate shape and size.
[removeFromSimulation()](./server.collider.removefromsimulation.md)		Removes the collider from the simulation.
[setBounciness(bounciness)](./server.collider.setbounciness.md)		Sets the bounciness of the collider.
[setBouncinessCombineRule(bouncinessCombineRule)](./server.collider.setbouncinesscombinerule.md)		Sets the bounciness combine rule of the collider.
[setCollisionGroups(collisionGroups)](./server.collider.setcollisiongroups.md)		Sets the collision groups of the collider.
[setEnabled(enabled)](./server.collider.setenabled.md)		Sets whether the collider is enabled.
[setFriction(friction)](./server.collider.setfriction.md)		Sets the friction of the collider.
[setFrictionCombineRule(frictionCombineRule)](./server.collider.setfrictioncombinerule.md)		Sets the friction combine rule of the collider.
[setHalfExtents(halfExtents)](./server.collider.sethalfextents.md)		Sets the half extents of a simulated block collider.
[setHalfHeight(halfHeight)](./server.collider.sethalfheight.md)		Sets the half height of a simulated capsule, cone, cylinder, or round cylinder collider.
[setMass(mass)](./server.collider.setmass.md)		Sets the mass of the collider.
[setOnCollision(callback)](./server.collider.setoncollision.md)		Sets the on collision callback for the collider.
[setRadius(radius)](./server.collider.setradius.md)		Sets the radius of a simulated ball, capsule, cylinder, or round cylinder collider.
[setRelativePosition(position)](./server.collider.setrelativeposition.md)		Sets the position of the collider relative to its parent rigid body or the world origin.
[setRelativeRotation(rotation)](./server.collider.setrelativerotation.md)		Sets the relative rotation of the collider to its parent rigid body or the world origin.
[setScale(scale)](./server.collider.setscale.md)		Scales the collider by the given scalar. Only ball, block, capsule, cone, cylinder, round cylinder are supported.
[setSensor(sensor)](./server.collider.setsensor.md)		Sets whether the collider is a sensor.
[setTag(tag)](./server.collider.settag.md)		Sets the tag of the collider.
[setVoxel(coordinate, filled)](./server.collider.setvoxel.md)		Sets the voxel at the given coordinate as filled or not filled.