hytopia 0.3.10 → 0.3.11

package/docs/server.ballcollideroptions.md

@@ -0,0 +1,75 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [BallColliderOptions](./server.ballcollideroptions.md)
+
+## BallColliderOptions interface
+
+The options for a ball collider.
+
+**Signature:**
+
+```typescript
+export interface BallColliderOptions extends BaseColliderOptions 
+```
+**Extends:** [BaseColliderOptions](./server.basecollideroptions.md)
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[radius?](./server.ballcollideroptions.radius.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The radius of the ball collider.
+
+
+</td></tr>
+<tr><td>
+
+[shape](./server.ballcollideroptions.shape.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[ColliderShape.BALL](./server.collidershape.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.ballcollideroptions.radius.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; [BallColliderOptions](./server.ballcollideroptions.md) &gt; [radius](./server.ballcollideroptions.radius.md)
+
+## BallColliderOptions.radius property
+
+The radius of the ball collider.
+
+**Signature:**
+
+```typescript
+radius?: number;
+```

package/docs/server.ballcollideroptions.shape.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [BallColliderOptions](./server.ballcollideroptions.md) &gt; [shape](./server.ballcollideroptions.shape.md)
+
+## BallColliderOptions.shape property
+
+**Signature:**
+
+```typescript
+shape: ColliderShape.BALL;
+```

package/docs/server.basecollideroptions.bounciness.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; [BaseColliderOptions](./server.basecollideroptions.md) &gt; [bounciness](./server.basecollideroptions.bounciness.md)
+
+## BaseColliderOptions.bounciness property
+
+The bounciness of the collider.
+
+**Signature:**
+
+```typescript
+bounciness?: number;
+```

package/docs/server.basecollideroptions.bouncinesscombinerule.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; [BaseColliderOptions](./server.basecollideroptions.md) &gt; [bouncinessCombineRule](./server.basecollideroptions.bouncinesscombinerule.md)
+
+## BaseColliderOptions.bouncinessCombineRule property
+
+The bounciness combine rule of the collider.
+
+**Signature:**
+
+```typescript
+bouncinessCombineRule?: CoefficientCombineRule;
+```

package/docs/server.basecollideroptions.collisiongroups.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; [BaseColliderOptions](./server.basecollideroptions.md) &gt; [collisionGroups](./server.basecollideroptions.collisiongroups.md)
+
+## BaseColliderOptions.collisionGroups property
+
+The collision groups the collider belongs to.
+
+**Signature:**
+
+```typescript
+collisionGroups?: CollisionGroups;
+```

package/docs/server.basecollideroptions.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; [BaseColliderOptions](./server.basecollideroptions.md) &gt; [enabled](./server.basecollideroptions.enabled.md)
+
+## BaseColliderOptions.enabled property
+
+Whether the collider is enabled.
+
+**Signature:**
+
+```typescript
+enabled?: boolean;
+```

package/docs/server.basecollideroptions.flags.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; [BaseColliderOptions](./server.basecollideroptions.md) &gt; [flags](./server.basecollideroptions.flags.md)
+
+## BaseColliderOptions.flags property
+
+The flags of the collider if the shape is a trimesh
+
+**Signature:**
+
+```typescript
+flags?: number;
+```

package/docs/server.basecollideroptions.friction.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; [BaseColliderOptions](./server.basecollideroptions.md) &gt; [friction](./server.basecollideroptions.friction.md)
+
+## BaseColliderOptions.friction property
+
+The friction of the collider.
+
+**Signature:**
+
+```typescript
+friction?: number;
+```

package/docs/server.basecollideroptions.frictioncombinerule.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; [BaseColliderOptions](./server.basecollideroptions.md) &gt; [frictionCombineRule](./server.basecollideroptions.frictioncombinerule.md)
+
+## BaseColliderOptions.frictionCombineRule property
+
+The friction combine rule of the collider.
+
+**Signature:**
+
+```typescript
+frictionCombineRule?: CoefficientCombineRule;
+```

package/docs/server.basecollideroptions.issensor.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; [BaseColliderOptions](./server.basecollideroptions.md) &gt; [isSensor](./server.basecollideroptions.issensor.md)
+
+## BaseColliderOptions.isSensor property
+
+Whether the collider is a sensor.
+
+**Signature:**
+
+```typescript
+isSensor?: boolean;
+```

package/docs/server.basecollideroptions.mass.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; [BaseColliderOptions](./server.basecollideroptions.md) &gt; [mass](./server.basecollideroptions.mass.md)
+
+## BaseColliderOptions.mass property
+
+The mass of the collider.
+
+**Signature:**
+
+```typescript
+mass?: number;
+```

package/docs/server.basecollideroptions.md

@@ -0,0 +1,342 @@
+<!-- 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>

package/docs/server.basecollideroptions.oncollision.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; [BaseColliderOptions](./server.basecollideroptions.md) &gt; [onCollision](./server.basecollideroptions.oncollision.md)
+
+## BaseColliderOptions.onCollision property
+
+The on collision callback for the collider.
+
+**Signature:**
+
+```typescript
+onCollision?: CollisionCallback;
+```

package/docs/server.basecollideroptions.parentrigidbody.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; [BaseColliderOptions](./server.basecollideroptions.md) &gt; [parentRigidBody](./server.basecollideroptions.parentrigidbody.md)
+
+## BaseColliderOptions.parentRigidBody property
+
+The parent rigid body of the collider.
+
+**Signature:**
+
+```typescript
+parentRigidBody?: RigidBody;
+```

package/docs/server.basecollideroptions.relativeposition.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; [BaseColliderOptions](./server.basecollideroptions.md) &gt; [relativePosition](./server.basecollideroptions.relativeposition.md)
+
+## BaseColliderOptions.relativePosition property
+
+The relative position of the collider. Relative to parent rigid body.
+
+**Signature:**
+
+```typescript
+relativePosition?: Vector3Like;
+```

package/docs/server.basecollideroptions.relativerotation.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; [BaseColliderOptions](./server.basecollideroptions.md) &gt; [relativeRotation](./server.basecollideroptions.relativerotation.md)
+
+## BaseColliderOptions.relativeRotation property
+
+The relative rotation of the collider. Relative to parent rigid body.
+
+**Signature:**
+
+```typescript
+relativeRotation?: QuaternionLike;
+```

package/docs/server.basecollideroptions.shape.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; [BaseColliderOptions](./server.basecollideroptions.md) &gt; [shape](./server.basecollideroptions.shape.md)
+
+## BaseColliderOptions.shape property
+
+The shape of the collider.
+
+**Signature:**
+
+```typescript
+shape: ColliderShape;
+```

package/docs/{server.collideroptions.simulation.md → server.basecollideroptions.simulation.md}

@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [server](./server.md) &gt; [ColliderOptions](./server.collideroptions.md) &gt; [simulation](./server.collideroptions.simulation.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseColliderOptions](./server.basecollideroptions.md) &gt; [simulation](./server.basecollideroptions.simulation.md)
 
-## ColliderOptions.simulation property
+## BaseColliderOptions.simulation property
 
 The simulation the collider is in, if provided the collider will automatically be added to the simulation.
 

package/docs/{server.collideroptions.tag.md → server.basecollideroptions.tag.md}

@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [server](./server.md) &gt; [ColliderOptions](./server.collideroptions.md) &gt; [tag](./server.collideroptions.tag.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseColliderOptions](./server.basecollideroptions.md) &gt; [tag](./server.basecollideroptions.tag.md)
 
-## ColliderOptions.tag property
+## BaseColliderOptions.tag property
 
 An arbitrary identifier tag of the collider. Useful for your own logic.
 

package/docs/{server.rigidbodyoptions.colliders.md → server.baserigidbodyoptions.colliders.md}

@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [server](./server.md) &gt; [RigidBodyOptions](./server.rigidbodyoptions.md) &gt; [colliders](./server.rigidbodyoptions.colliders.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseRigidBodyOptions](./server.baserigidbodyoptions.md) &gt; [colliders](./server.baserigidbodyoptions.colliders.md)
 
-## RigidBodyOptions.colliders property
+## BaseRigidBodyOptions.colliders property
 
 The colliders of the rigid body, provided as [ColliderOptions](./server.collideroptions.md)<!-- -->.
 

package/docs/server.baserigidbodyoptions.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; [BaseRigidBodyOptions](./server.baserigidbodyoptions.md) &gt; [enabled](./server.baserigidbodyoptions.enabled.md)
+
+## BaseRigidBodyOptions.enabled property
+
+Whether the rigid body is enabled.
+
+**Signature:**
+
+```typescript
+enabled?: boolean;
+```