hytopia 0.3.10 → 0.3.11

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

package/docs/server.cylindercollideroptions.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; [CylinderColliderOptions](./server.cylindercollideroptions.md) &gt; [shape](./server.cylindercollideroptions.shape.md)
+
+## CylinderColliderOptions.shape property
+
+**Signature:**
+
+```typescript
+shape: ColliderShape.CYLINDER;
+```

package/docs/server.dynamicrigidbodyoptions.additionalmass.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; [DynamicRigidBodyOptions](./server.dynamicrigidbodyoptions.md) &gt; [additionalMass](./server.dynamicrigidbodyoptions.additionalmass.md)
+
+## DynamicRigidBodyOptions.additionalMass property
+
+The additional mass of the rigid body.
+
+**Signature:**
+
+```typescript
+additionalMass?: number;
+```

package/docs/server.dynamicrigidbodyoptions.additionalmassproperties.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; [DynamicRigidBodyOptions](./server.dynamicrigidbodyoptions.md) &gt; [additionalMassProperties](./server.dynamicrigidbodyoptions.additionalmassproperties.md)
+
+## DynamicRigidBodyOptions.additionalMassProperties property
+
+The additional mass properties of the rigid body.
+
+**Signature:**
+
+```typescript
+additionalMassProperties?: RigidBodyAdditionalMassProperties;
+```

package/docs/server.dynamicrigidbodyoptions.additionalsolveriterations.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; [DynamicRigidBodyOptions](./server.dynamicrigidbodyoptions.md) &gt; [additionalSolverIterations](./server.dynamicrigidbodyoptions.additionalsolveriterations.md)
+
+## DynamicRigidBodyOptions.additionalSolverIterations property
+
+The additional solver iterations of the rigid body.
+
+**Signature:**
+
+```typescript
+additionalSolverIterations?: number;
+```

package/docs/server.dynamicrigidbodyoptions.angulardamping.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; [DynamicRigidBodyOptions](./server.dynamicrigidbodyoptions.md) &gt; [angularDamping](./server.dynamicrigidbodyoptions.angulardamping.md)
+
+## DynamicRigidBodyOptions.angularDamping property
+
+The angular damping of the rigid body.
+
+**Signature:**
+
+```typescript
+angularDamping?: number;
+```

package/docs/server.dynamicrigidbodyoptions.angularvelocity.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; [DynamicRigidBodyOptions](./server.dynamicrigidbodyoptions.md) &gt; [angularVelocity](./server.dynamicrigidbodyoptions.angularvelocity.md)
+
+## DynamicRigidBodyOptions.angularVelocity property
+
+The angular velocity of the rigid body.
+
+**Signature:**
+
+```typescript
+angularVelocity?: Vector3Like;
+```

package/docs/server.dynamicrigidbodyoptions.ccdenabled.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; [DynamicRigidBodyOptions](./server.dynamicrigidbodyoptions.md) &gt; [ccdEnabled](./server.dynamicrigidbodyoptions.ccdenabled.md)
+
+## DynamicRigidBodyOptions.ccdEnabled property
+
+Whether the rigid body has continuous collision detection enabled.
+
+**Signature:**
+
+```typescript
+ccdEnabled?: boolean;
+```

package/docs/server.dynamicrigidbodyoptions.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; [DynamicRigidBodyOptions](./server.dynamicrigidbodyoptions.md) &gt; [dominanceGroup](./server.dynamicrigidbodyoptions.dominancegroup.md)
+
+## DynamicRigidBodyOptions.dominanceGroup property
+
+The dominance group of the rigid body.
+
+**Signature:**
+
+```typescript
+dominanceGroup?: number;
+```

package/docs/server.dynamicrigidbodyoptions.enabledpositions.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; [DynamicRigidBodyOptions](./server.dynamicrigidbodyoptions.md) &gt; [enabledPositions](./server.dynamicrigidbodyoptions.enabledpositions.md)
+
+## DynamicRigidBodyOptions.enabledPositions property
+
+The enabled axes of positional movement of the rigid body.
+
+**Signature:**
+
+```typescript
+enabledPositions?: Vector3Boolean;
+```

package/docs/server.dynamicrigidbodyoptions.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; [DynamicRigidBodyOptions](./server.dynamicrigidbodyoptions.md) &gt; [enabledRotations](./server.dynamicrigidbodyoptions.enabledrotations.md)
+
+## DynamicRigidBodyOptions.enabledRotations property
+
+The enabled rotations of the rigid body.
+
+**Signature:**
+
+```typescript
+enabledRotations?: Vector3Boolean;
+```

package/docs/server.dynamicrigidbodyoptions.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; [DynamicRigidBodyOptions](./server.dynamicrigidbodyoptions.md) &gt; [gravityScale](./server.dynamicrigidbodyoptions.gravityscale.md)
+
+## DynamicRigidBodyOptions.gravityScale property
+
+The gravity scale of the rigid body.
+
+**Signature:**
+
+```typescript
+gravityScale?: number;
+```

package/docs/server.dynamicrigidbodyoptions.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; [DynamicRigidBodyOptions](./server.dynamicrigidbodyoptions.md) &gt; [linearDamping](./server.dynamicrigidbodyoptions.lineardamping.md)
+
+## DynamicRigidBodyOptions.linearDamping property
+
+The linear damping of the rigid body.
+
+**Signature:**
+
+```typescript
+linearDamping?: number;
+```

package/docs/server.dynamicrigidbodyoptions.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; [DynamicRigidBodyOptions](./server.dynamicrigidbodyoptions.md) &gt; [linearVelocity](./server.dynamicrigidbodyoptions.linearvelocity.md)
+
+## DynamicRigidBodyOptions.linearVelocity property
+
+The linear velocity of the rigid body.
+
+**Signature:**
+
+```typescript
+linearVelocity?: Vector3Like;
+```

package/docs/server.dynamicrigidbodyoptions.md

@@ -0,0 +1,324 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [DynamicRigidBodyOptions](./server.dynamicrigidbodyoptions.md)
+
+## DynamicRigidBodyOptions interface
+
+The options for a dynamic rigid body, also the default type.
+
+**Signature:**
+
+```typescript
+export interface DynamicRigidBodyOptions extends BaseRigidBodyOptions 
+```
+**Extends:** [BaseRigidBodyOptions](./server.baserigidbodyoptions.md)
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[additionalMass?](./server.dynamicrigidbodyoptions.additionalmass.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The additional mass of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[additionalMassProperties?](./server.dynamicrigidbodyoptions.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.dynamicrigidbodyoptions.additionalsolveriterations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The additional solver iterations of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[angularDamping?](./server.dynamicrigidbodyoptions.angulardamping.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The angular damping of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[angularVelocity?](./server.dynamicrigidbodyoptions.angularvelocity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+_(Optional)_ The angular velocity of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[ccdEnabled?](./server.dynamicrigidbodyoptions.ccdenabled.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ Whether the rigid body has continuous collision detection enabled.
+
+
+</td></tr>
+<tr><td>
+
+[dominanceGroup?](./server.dynamicrigidbodyoptions.dominancegroup.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The dominance group of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[enabledPositions?](./server.dynamicrigidbodyoptions.enabledpositions.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Vector3Boolean](./server.vector3boolean.md)
+
+
+</td><td>
+
+_(Optional)_ The enabled axes of positional movement of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[enabledRotations?](./server.dynamicrigidbodyoptions.enabledrotations.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Vector3Boolean](./server.vector3boolean.md)
+
+
+</td><td>
+
+_(Optional)_ The enabled rotations of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[gravityScale?](./server.dynamicrigidbodyoptions.gravityscale.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The gravity scale of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[linearDamping?](./server.dynamicrigidbodyoptions.lineardamping.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The linear damping of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[linearVelocity?](./server.dynamicrigidbodyoptions.linearvelocity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+_(Optional)_ The linear velocity of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[sleeping?](./server.dynamicrigidbodyoptions.sleeping.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ Whether the rigid body is sleeping.
+
+
+</td></tr>
+<tr><td>
+
+[softCcdPrediction?](./server.dynamicrigidbodyoptions.softccdprediction.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The soft continuous collision detection prediction of the rigid body.
+
+
+</td></tr>
+<tr><td>
+
+[type?](./server.dynamicrigidbodyoptions.type.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[RigidBodyType.DYNAMIC](./server.rigidbodytype.md)
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>

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

package/docs/server.dynamicrigidbodyoptions.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; [DynamicRigidBodyOptions](./server.dynamicrigidbodyoptions.md) &gt; [softCcdPrediction](./server.dynamicrigidbodyoptions.softccdprediction.md)
+
+## DynamicRigidBodyOptions.softCcdPrediction property
+
+The soft continuous collision detection prediction of the rigid body.
+
+**Signature:**
+
+```typescript
+softCcdPrediction?: number;
+```

package/docs/server.dynamicrigidbodyoptions.type.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; [DynamicRigidBodyOptions](./server.dynamicrigidbodyoptions.md) &gt; [type](./server.dynamicrigidbodyoptions.type.md)
+
+## DynamicRigidBodyOptions.type property
+
+**Signature:**
+
+```typescript
+type?: RigidBodyType.DYNAMIC;
+```

package/docs/server.errorhandler.error.md

@@ -0,0 +1,69 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [ErrorHandler](./server.errorhandler.md) &gt; [error](./server.errorhandler.error.md)
+
+## ErrorHandler.error() method
+
+Logs a formatted error message with stack trace to help debug issues
+
+**Signature:**
+
+```typescript
+static error(message: string, context?: string): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+message
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The error message to display
+
+
+</td></tr>
+<tr><td>
+
+context
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_ Optional context information about the error
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+