server.basecollideroptions.md

Home > server > BaseColliderOptions

BaseColliderOptions interface

The base options for a collider.

Signature:

export interface BaseColliderOptions 

Properties

Property	Modifiers	Type	Description
bounciness?		number	(Optional) The bounciness of the collider.
bouncinessCombineRule?		CoefficientCombineRule	(Optional) The bounciness combine rule of the collider.
collisionGroups?		CollisionGroups	(Optional) The collision groups the collider belongs to.
enabled?		boolean	(Optional) Whether the collider is enabled.
flags?		number	(Optional) The flags of the collider if the shape is a trimesh
friction?		number	(Optional) The friction of the collider.
frictionCombineRule?		CoefficientCombineRule	(Optional) The friction combine rule of the collider.
isSensor?		boolean	(Optional) Whether the collider is a sensor.
mass?		number	(Optional) The mass of the collider.
onCollision?		CollisionCallback	(Optional) The on collision callback for the collider.
parentRigidBody?		RigidBody	(Optional) The parent rigid body of the collider.
relativePosition?		Vector3Like	(Optional) The relative position of the collider. Relative to parent rigid body.
relativeRotation?		QuaternionLike	(Optional) The relative rotation of the collider. Relative to parent rigid body.
shape		ColliderShape	The shape of the collider.
simulation?		Simulation	(Optional) The simulation the collider is in, if provided the collider will automatically be added to the simulation.
tag?		string	(Optional) An arbitrary identifier tag of the collider. Useful for your own logic.