hytopia/docs/server.basecollideroptions.md

The HYTOPIA SDK makes it easy for developers to create massively multiplayer games using JavaScript or TypeScript.

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [server](./server.md) &gt; [BaseColliderOptions](./server.basecollideroptions.md)

## BaseColliderOptions interface

The base options for a collider.

**Signature:**

```typescript
export interface BaseColliderOptions 
```

## Properties

<table><thead><tr><th>

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[bounciness?](./server.basecollideroptions.bounciness.md)


</td><td>


</td><td>

number


</td><td>

_(Optional)_ The bounciness of the collider.


</td></tr>
<tr><td>

[bouncinessCombineRule?](./server.basecollideroptions.bouncinesscombinerule.md)


</td><td>


</td><td>

[CoefficientCombineRule](./server.coefficientcombinerule.md)


</td><td>

_(Optional)_ The bounciness combine rule of the collider.


</td></tr>
<tr><td>

[collisionGroups?](./server.basecollideroptions.collisiongroups.md)


</td><td>


</td><td>

[CollisionGroups](./server.collisiongroups.md)


</td><td>

_(Optional)_ The collision groups the collider belongs to.


</td></tr>
<tr><td>

[enabled?](./server.basecollideroptions.enabled.md)


</td><td>


</td><td>

boolean


</td><td>

_(Optional)_ Whether the collider is enabled.


</td></tr>
<tr><td>

[flags?](./server.basecollideroptions.flags.md)


</td><td>


</td><td>

number


</td><td>

_(Optional)_ The flags of the collider if the shape is a trimesh


</td></tr>
<tr><td>

[friction?](./server.basecollideroptions.friction.md)


</td><td>


</td><td>

number


</td><td>

_(Optional)_ The friction of the collider.


</td></tr>
<tr><td>

[frictionCombineRule?](./server.basecollideroptions.frictioncombinerule.md)


</td><td>


</td><td>

[CoefficientCombineRule](./server.coefficientcombinerule.md)


</td><td>

_(Optional)_ The friction combine rule of the collider.


</td></tr>
<tr><td>

[isSensor?](./server.basecollideroptions.issensor.md)


</td><td>


</td><td>

boolean


</td><td>

_(Optional)_ Whether the collider is a sensor.


</td></tr>
<tr><td>

[mass?](./server.basecollideroptions.mass.md)


</td><td>


</td><td>

number


</td><td>

_(Optional)_ The mass of the collider.


</td></tr>
<tr><td>

[onCollision?](./server.basecollideroptions.oncollision.md)


</td><td>


</td><td>

[CollisionCallback](./server.collisioncallback.md)


</td><td>

_(Optional)_ The on collision callback for the collider.


</td></tr>
<tr><td>

[parentRigidBody?](./server.basecollideroptions.parentrigidbody.md)


</td><td>


</td><td>

[RigidBody](./server.rigidbody.md)


</td><td>

_(Optional)_ The parent rigid body of the collider.


</td></tr>
<tr><td>

[relativePosition?](./server.basecollideroptions.relativeposition.md)


</td><td>


</td><td>

[Vector3Like](./server.vector3like.md)


</td><td>

_(Optional)_ The relative position of the collider. Relative to parent rigid body.


</td></tr>
<tr><td>

[relativeRotation?](./server.basecollideroptions.relativerotation.md)


</td><td>


</td><td>

[QuaternionLike](./server.quaternionlike.md)


</td><td>

_(Optional)_ The relative rotation of the collider. Relative to parent rigid body.


</td></tr>
<tr><td>

[shape](./server.basecollideroptions.shape.md)


</td><td>


</td><td>

[ColliderShape](./server.collidershape.md)


</td><td>

The shape of the collider.


</td></tr>
<tr><td>

[simulation?](./server.basecollideroptions.simulation.md)


</td><td>


</td><td>

[Simulation](./server.simulation.md)


</td><td>

_(Optional)_ The simulation the collider is in, if provided the collider will automatically be added to the simulation.


</td></tr>
<tr><td>

[tag?](./server.basecollideroptions.tag.md)


</td><td>


</td><td>

string


</td><td>

_(Optional)_ An arbitrary identifier tag of the collider. Useful for your own logic.


</td></tr>
</tbody></table>