hytopia/docs/server.baserigidbodyoptions.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; [BaseRigidBodyOptions](./server.baserigidbodyoptions.md)

## BaseRigidBodyOptions interface

The base options for a rigid body.

Use for: initial rigid body configuration when creating entities or bodies. Do NOT use for: runtime changes; use `RigidBody` setter methods instead.

\*\*Category:\*\* Physics

**Signature:**

```typescript
export interface BaseRigidBodyOptions 
```

## Properties

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

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


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

[colliders?](./server.baserigidbodyoptions.colliders.md)


</td><td>


</td><td>

[ColliderOptions](./server.collideroptions.md)<!-- -->\[\]


</td><td>

_(Optional)_ The colliders of the rigid body, provided as `ColliderOptions`<!-- -->.

\*\*Category:\*\* Physics


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

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


</td><td>


</td><td>

boolean


</td><td>

_(Optional)_ Whether the rigid body is enabled.

\*\*Category:\*\* Physics


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

[position?](./server.baserigidbodyoptions.position.md)


</td><td>


</td><td>

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


</td><td>

_(Optional)_ The position of the rigid body.

\*\*Category:\*\* Physics


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

[rotation?](./server.baserigidbodyoptions.rotation.md)


</td><td>


</td><td>

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


</td><td>

_(Optional)_ The rotation of the rigid body.

\*\*Category:\*\* Physics


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

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


</td><td>


</td><td>

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


</td><td>

_(Optional)_ The simulation the rigid body is in. If provided, the rigid body will be automatically added to the simulation.

\*\*Category:\*\* Physics


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

[type?](./server.baserigidbodyoptions.type.md)


</td><td>


</td><td>

[RigidBodyType](./server.rigidbodytype.md)


</td><td>

_(Optional)_ The type of the rigid body, defaults to `RigidBodyType.DYNAMIC`<!-- -->.

\*\*Category:\*\* Physics


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