hytopia 0.1.0 → 0.1.2

package/docs/server.hytopia.rigidbodyoptions.colliders.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [RigidBodyOptions](./server.hytopia.rigidbodyoptions.md) &gt; [colliders](./server.hytopia.rigidbodyoptions.colliders.md)
+
+## HYTOPIA.RigidBodyOptions.colliders property
+
+The colliders of the rigid body, provided as [ColliderOptions](./server.collideroptions.md)<!-- -->.
+
+**Signature:**
+
+```typescript
+colliders?: ColliderOptions[];
+```

package/docs/server.hytopia.rigidbodyoptions.dominancegroup.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [RigidBodyOptions](./server.hytopia.rigidbodyoptions.md) &gt; [dominanceGroup](./server.hytopia.rigidbodyoptions.dominancegroup.md)
+
+## HYTOPIA.RigidBodyOptions.dominanceGroup property
+
+The dominance group of the rigid body.
+
+**Signature:**
+
+```typescript
+dominanceGroup?: number;
+```

package/docs/server.hytopia.rigidbodyoptions.enabled.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [RigidBodyOptions](./server.hytopia.rigidbodyoptions.md) &gt; [enabled](./server.hytopia.rigidbodyoptions.enabled.md)
+
+## HYTOPIA.RigidBodyOptions.enabled property
+
+Whether the rigid body is enabled.
+
+**Signature:**
+
+```typescript
+enabled?: boolean;
+```

package/docs/server.hytopia.rigidbodyoptions.enabledrotations.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [RigidBodyOptions](./server.hytopia.rigidbodyoptions.md) &gt; [enabledRotations](./server.hytopia.rigidbodyoptions.enabledrotations.md)
+
+## HYTOPIA.RigidBodyOptions.enabledRotations property
+
+The enabled rotations of the rigid body.
+
+**Signature:**
+
+```typescript
+enabledRotations?: Vector3Boolean;
+```

package/docs/server.hytopia.rigidbodyoptions.enabledtranslations.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [RigidBodyOptions](./server.hytopia.rigidbodyoptions.md) &gt; [enabledTranslations](./server.hytopia.rigidbodyoptions.enabledtranslations.md)
+
+## HYTOPIA.RigidBodyOptions.enabledTranslations property
+
+The enabled translations of the rigid body.
+
+**Signature:**
+
+```typescript
+enabledTranslations?: Vector3Boolean;
+```

package/docs/server.hytopia.rigidbodyoptions.gravityscale.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [RigidBodyOptions](./server.hytopia.rigidbodyoptions.md) &gt; [gravityScale](./server.hytopia.rigidbodyoptions.gravityscale.md)
+
+## HYTOPIA.RigidBodyOptions.gravityScale property
+
+The gravity scale of the rigid body.
+
+**Signature:**
+
+```typescript
+gravityScale?: number;
+```

package/docs/server.hytopia.rigidbodyoptions.lineardamping.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [RigidBodyOptions](./server.hytopia.rigidbodyoptions.md) &gt; [linearDamping](./server.hytopia.rigidbodyoptions.lineardamping.md)
+
+## HYTOPIA.RigidBodyOptions.linearDamping property
+
+The linear damping of the rigid body.
+
+**Signature:**
+
+```typescript
+linearDamping?: number;
+```

package/docs/server.hytopia.rigidbodyoptions.linearvelocity.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [RigidBodyOptions](./server.hytopia.rigidbodyoptions.md) &gt; [linearVelocity](./server.hytopia.rigidbodyoptions.linearvelocity.md)
+
+## HYTOPIA.RigidBodyOptions.linearVelocity property
+
+The linear velocity of the rigid body.
+
+**Signature:**
+
+```typescript
+linearVelocity?: Vector3;
+```

package/docs/server.hytopia.rigidbodyoptions.md

@@ -0,0 +1,437 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [RigidBodyOptions](./server.hytopia.rigidbodyoptions.md)
+
+## HYTOPIA.RigidBodyOptions interface
+
+Options for creating a RigidBody instance.
+
+**Signature:**
+
+```typescript
+export interface RigidBodyOptions 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[additionalMass?](./server.hytopia.rigidbodyoptions.additionalmass.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The additional mass of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[additionalMassProperties?](./server.hytopia.rigidbodyoptions.additionalmassproperties.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[RigidBodyAdditionalMassProperties](./server.rigidbodyadditionalmassproperties.md)
+
+
+</td><td>
+
+_(Optional)_ The additional mass properties of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[additionalSolverIterations?](./server.hytopia.rigidbodyoptions.additionalsolveriterations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The additional solver iterations of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[angularDamping?](./server.hytopia.rigidbodyoptions.angulardamping.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The angular damping of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[angularVelocity?](./server.hytopia.rigidbodyoptions.angularvelocity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+_(Optional)_ The angular velocity of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[ccdEnabled?](./server.hytopia.rigidbodyoptions.ccdenabled.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ Whether the rigid body has continuous collision detection enabled.
+
+
+</td></tr>
+<tr><td>
+
+[colliders?](./server.hytopia.rigidbodyoptions.colliders.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[ColliderOptions](./server.collideroptions.md)<!-- -->\[\]
+
+
+</td><td>
+
+_(Optional)_ The colliders of the rigid body, provided as [ColliderOptions](./server.collideroptions.md)<!-- -->.
+
+
+</td></tr>
+<tr><td>
+
+[dominanceGroup?](./server.hytopia.rigidbodyoptions.dominancegroup.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The dominance group of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[enabled?](./server.hytopia.rigidbodyoptions.enabled.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ Whether the rigid body is enabled.
+
+
+</td></tr>
+<tr><td>
+
+[enabledRotations?](./server.hytopia.rigidbodyoptions.enabledrotations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Vector3Boolean](./server.vector3boolean.md)
+
+
+</td><td>
+
+_(Optional)_ The enabled rotations of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[enabledTranslations?](./server.hytopia.rigidbodyoptions.enabledtranslations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Vector3Boolean](./server.vector3boolean.md)
+
+
+</td><td>
+
+_(Optional)_ The enabled translations of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[gravityScale?](./server.hytopia.rigidbodyoptions.gravityscale.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The gravity scale of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[linearDamping?](./server.hytopia.rigidbodyoptions.lineardamping.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The linear damping of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[linearVelocity?](./server.hytopia.rigidbodyoptions.linearvelocity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+_(Optional)_ The linear velocity of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[rotation?](./server.hytopia.rigidbodyoptions.rotation.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Rotation](./server.rotation.md)
+
+
+</td><td>
+
+_(Optional)_ The rotation of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[simulation?](./server.hytopia.rigidbodyoptions.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.
+
+
+</td></tr>
+<tr><td>
+
+[sleeping?](./server.hytopia.rigidbodyoptions.sleeping.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ Whether the rigid body is sleeping.
+
+
+</td></tr>
+<tr><td>
+
+[softCcdPrediction?](./server.hytopia.rigidbodyoptions.softccdprediction.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The soft continuous collision detection prediction of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[tag?](./server.hytopia.rigidbodyoptions.tag.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_ The tag of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[translation?](./server.hytopia.rigidbodyoptions.translation.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+_(Optional)_ The translation of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[type](./server.hytopia.rigidbodyoptions.type.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[RigidBodyType](./server.rigidbodytype.md)
+
+
+</td><td>
+
+The type of the rigid body.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.hytopia.rigidbodyoptions.rotation.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [RigidBodyOptions](./server.hytopia.rigidbodyoptions.md) &gt; [rotation](./server.hytopia.rigidbodyoptions.rotation.md)
+
+## HYTOPIA.RigidBodyOptions.rotation property
+
+The rotation of the rigid body.
+
+**Signature:**
+
+```typescript
+rotation?: Rotation;
+```

package/docs/server.hytopia.rigidbodyoptions.simulation.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [RigidBodyOptions](./server.hytopia.rigidbodyoptions.md) &gt; [simulation](./server.hytopia.rigidbodyoptions.simulation.md)
+
+## HYTOPIA.RigidBodyOptions.simulation property
+
+The simulation the rigid body is in. If provided, the rigid body will be automatically added to the simulation.
+
+**Signature:**
+
+```typescript
+simulation?: Simulation;
+```

package/docs/server.hytopia.rigidbodyoptions.sleeping.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [RigidBodyOptions](./server.hytopia.rigidbodyoptions.md) &gt; [sleeping](./server.hytopia.rigidbodyoptions.sleeping.md)
+
+## HYTOPIA.RigidBodyOptions.sleeping property
+
+Whether the rigid body is sleeping.
+
+**Signature:**
+
+```typescript
+sleeping?: boolean;
+```

package/docs/server.hytopia.rigidbodyoptions.softccdprediction.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [RigidBodyOptions](./server.hytopia.rigidbodyoptions.md) &gt; [softCcdPrediction](./server.hytopia.rigidbodyoptions.softccdprediction.md)
+
+## HYTOPIA.RigidBodyOptions.softCcdPrediction property
+
+The soft continuous collision detection prediction of the rigid body.
+
+**Signature:**
+
+```typescript
+softCcdPrediction?: number;
+```

package/docs/server.hytopia.rigidbodyoptions.tag.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [RigidBodyOptions](./server.hytopia.rigidbodyoptions.md) &gt; [tag](./server.hytopia.rigidbodyoptions.tag.md)
+
+## HYTOPIA.RigidBodyOptions.tag property
+
+The tag of the rigid body.
+
+**Signature:**
+
+```typescript
+tag?: string;
+```

package/docs/server.hytopia.rigidbodyoptions.translation.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [RigidBodyOptions](./server.hytopia.rigidbodyoptions.md) &gt; [translation](./server.hytopia.rigidbodyoptions.translation.md)
+
+## HYTOPIA.RigidBodyOptions.translation property
+
+The translation of the rigid body.
+
+**Signature:**
+
+```typescript
+translation?: Vector3;
+```

package/docs/server.hytopia.rigidbodyoptions.type.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [RigidBodyOptions](./server.hytopia.rigidbodyoptions.md) &gt; [type](./server.hytopia.rigidbodyoptions.type.md)
+
+## HYTOPIA.RigidBodyOptions.type property
+
+The type of the rigid body.
+
+**Signature:**
+
+```typescript
+type: RigidBodyType;
+```