hytopia 0.1.54 → 0.1.56

package/docs/server.basecharactercontroller._constructor_.md

@@ -1,65 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [BaseCharacterController](./server.basecharactercontroller.md) &gt; [(constructor)](./server.basecharactercontroller._constructor_.md)
-
-## BaseCharacterController.(constructor)
-
-Constructs a new instance of the `BaseCharacterController` class
-
-**Signature:**
-
-```typescript
-constructor(entity: Entity, _options?: Record<string, unknown>);
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-entity
-
-
-</td><td>
-
-[Entity](./server.entity.md)
-
-
-</td><td>
-
-The entity the controller is for.
-
-
-</td></tr>
-<tr><td>
-
-\_options
-
-
-</td><td>
-
-Record&lt;string, unknown&gt;
-
-
-</td><td>
-
-_(Optional)_ Arbitrary options you may provide or omit for your controller implementation.
-
-
-</td></tr>
-</tbody></table>

package/docs/server.basecharactercontroller.createcolliders.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [BaseCharacterController](./server.basecharactercontroller.md) &gt; [createColliders](./server.basecharactercontroller.createcolliders.md)
-
-## BaseCharacterController.createColliders() method
-
-Override this method to create controller specific colliders to be attached to the controlled entity when it spawns.
-
-**Signature:**
-
-```typescript
-createColliders(): Collider[];
-```
-**Returns:**
-
-[Collider](./server.collider.md)<!-- -->\[\]
-
-An array of colliders.
-

package/docs/server.basecharactercontroller.entity.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [BaseCharacterController](./server.basecharactercontroller.md) &gt; [entity](./server.basecharactercontroller.entity.md)
-
-## BaseCharacterController.entity property
-
-The entity the controller is for.
-
-**Signature:**
-
-```typescript
-readonly entity: Entity;
-```

package/docs/server.collider.getbounciness.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [Collider](./server.collider.md) &gt; [getBounciness](./server.collider.getbounciness.md)
-
-## Collider.getBounciness() method
-
-Gets the bounciness of the collider.
-
-**Signature:**
-
-```typescript
-getBounciness(): number;
-```
-**Returns:**
-
-number
-
-The bounciness of the collider.
-

package/docs/server.collider.getbouncinesscombinerule.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [Collider](./server.collider.md) &gt; [getBouncinessCombineRule](./server.collider.getbouncinesscombinerule.md)
-
-## Collider.getBouncinessCombineRule() method
-
-Gets the bounciness combine rule of the collider.
-
-**Signature:**
-
-```typescript
-getBouncinessCombineRule(): CoefficientCombineRule;
-```
-**Returns:**
-
-[CoefficientCombineRule](./server.coefficientcombinerule.md)
-
-The bounciness combine rule of the collider.
-

package/docs/server.collider.getcollisiongroups.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [Collider](./server.collider.md) &gt; [getCollisionGroups](./server.collider.getcollisiongroups.md)
-
-## Collider.getCollisionGroups() method
-
-Gets the collision groups the collider belongs to.
-
-**Signature:**
-
-```typescript
-getCollisionGroups(): CollisionGroups;
-```
-**Returns:**
-
-[CollisionGroups](./server.collisiongroups.md)
-
-The collision groups the collider belongs to.
-

package/docs/server.collider.getfrictioncombinerule.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [Collider](./server.collider.md) &gt; [getFrictionCombineRule](./server.collider.getfrictioncombinerule.md)
-
-## Collider.getFrictionCombineRule() method
-
-Gets the friction combine rule of the collider.
-
-**Signature:**
-
-```typescript
-getFrictionCombineRule(): CoefficientCombineRule;
-```
-**Returns:**
-
-[CoefficientCombineRule](./server.coefficientcombinerule.md)
-
-The friction combine rule of the collider.
-

package/docs/server.collider.getrelativerotation.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [Collider](./server.collider.md) &gt; [getRelativeRotation](./server.collider.getrelativerotation.md)
-
-## Collider.getRelativeRotation() method
-
-Gets the relative rotation of the collider.
-
-**Signature:**
-
-```typescript
-getRelativeRotation(): QuaternionLike;
-```
-**Returns:**
-
-[QuaternionLike](./server.quaternionlike.md)
-
-The relative rotation of the collider.
-

package/docs/server.collider.getrelativetranslation.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [Collider](./server.collider.md) &gt; [getRelativeTranslation](./server.collider.getrelativetranslation.md)
-
-## Collider.getRelativeTranslation() method
-
-Gets the relative translation of the collider to its parent rigid body.
-
-**Signature:**
-
-```typescript
-getRelativeTranslation(): Vector3Like;
-```
-**Returns:**
-
-[Vector3Like](./server.vector3like.md)
-
-The relative translation of the collider.
-

package/docs/server.collideroptions.relativetranslation.md

@@ -1,13 +0,0 @@
-<!-- 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; [relativeTranslation](./server.collideroptions.relativetranslation.md)
-
-## ColliderOptions.relativeTranslation property
-
-The relative translation of the collider. Relative to parent rigid body.
-
-**Signature:**
-
-```typescript
-relativeTranslation?: Vector3Like;
-```

package/docs/server.defaultcharactercontroller.createcolliders.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [DefaultCharacterController](./server.defaultcharactercontroller.md) &gt; [createColliders](./server.defaultcharactercontroller.createcolliders.md)
-
-## DefaultCharacterController.createColliders() method
-
-Creates the colliders for the character controller, overriding the default implementation.
-
-**Signature:**
-
-```typescript
-createColliders(): Collider[];
-```
-**Returns:**
-
-[Collider](./server.collider.md)<!-- -->\[\]
-
-An array of colliders.
-

package/docs/server.entity.createcustomcharactercontroller.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [Entity](./server.entity.md) &gt; [createCustomCharacterController](./server.entity.createcustomcharactercontroller.md)
-
-## Entity.createCustomCharacterController property
-
-A function that creates a custom character controller for the entity when it spawns.
-
-**Signature:**
-
-```typescript
-createCustomCharacterController?: (entity: Entity) => BaseCharacterController;
-```

package/docs/server.entityeventpayload.updatetranslation.entity.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [EntityEventPayload](./server.entityeventpayload.md) &gt; [UpdateTranslation](./server.entityeventpayload.updatetranslation.md) &gt; [entity](./server.entityeventpayload.updatetranslation.entity.md)
-
-## EntityEventPayload.UpdateTranslation.entity property
-
-**Signature:**
-
-```typescript
-entity: Entity;
-```

package/docs/server.entityeventpayload.updatetranslation.translation.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [EntityEventPayload](./server.entityeventpayload.md) &gt; [UpdateTranslation](./server.entityeventpayload.updatetranslation.md) &gt; [translation](./server.entityeventpayload.updatetranslation.translation.md)
-
-## EntityEventPayload.UpdateTranslation.translation property
-
-**Signature:**
-
-```typescript
-translation: Vector3Like;
-```

package/docs/server.entityoptions.createcustomcharactercontroller.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [EntityOptions](./server.entityoptions.md) &gt; [createCustomCharacterController](./server.entityoptions.createcustomcharactercontroller.md)
-
-## EntityOptions.createCustomCharacterController property
-
-A function that creates a custom character controller for the entity when it spawns.
-
-**Signature:**
-
-```typescript
-createCustomCharacterController?: (entity: Entity) => BaseCharacterController;
-```

package/docs/server.rigidbody.getadditionalmass.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [RigidBody](./server.rigidbody.md) &gt; [getAdditionalMass](./server.rigidbody.getadditionalmass.md)
-
-## RigidBody.getAdditionalMass() method
-
-Gets the additional mass of the rigid body.
-
-**Signature:**
-
-```typescript
-getAdditionalMass(): number;
-```
-**Returns:**
-
-number
-
-The additional mass of the rigid body.
-

package/docs/server.rigidbody.getadditionalsolveriterations.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [RigidBody](./server.rigidbody.md) &gt; [getAdditionalSolverIterations](./server.rigidbody.getadditionalsolveriterations.md)
-
-## RigidBody.getAdditionalSolverIterations() method
-
-Gets the additional solver iterations of the rigid body.
-
-**Signature:**
-
-```typescript
-getAdditionalSolverIterations(): number;
-```
-**Returns:**
-
-number
-
-The additional solver iterations of the rigid body.
-

package/docs/server.rigidbody.getangulardamping.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [RigidBody](./server.rigidbody.md) &gt; [getAngularDamping](./server.rigidbody.getangulardamping.md)
-
-## RigidBody.getAngularDamping() method
-
-Gets the angular damping of the rigid body.
-
-**Signature:**
-
-```typescript
-getAngularDamping(): number;
-```
-**Returns:**
-
-number
-
-The angular damping of the rigid body.
-

package/docs/server.rigidbody.getangularvelocity.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [RigidBody](./server.rigidbody.md) &gt; [getAngularVelocity](./server.rigidbody.getangularvelocity.md)
-
-## RigidBody.getAngularVelocity() method
-
-Gets the angular velocity of the rigid body.
-
-**Signature:**
-
-```typescript
-getAngularVelocity(): Vector3Like;
-```
-**Returns:**
-
-[Vector3Like](./server.vector3like.md)
-
-The angular velocity of the rigid body.
-

package/docs/server.rigidbody.getdirectionfromrotation.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [RigidBody](./server.rigidbody.md) &gt; [getDirectionFromRotation](./server.rigidbody.getdirectionfromrotation.md)
-
-## RigidBody.getDirectionFromRotation() method
-
-Gets the direction from the rotation of the rigid body.
-
-**Signature:**
-
-```typescript
-getDirectionFromRotation(): Vector3Like;
-```
-**Returns:**
-
-[Vector3Like](./server.vector3like.md)
-
-The direction from the rotation of the rigid body.
-

package/docs/server.rigidbody.getdominancegroup.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [RigidBody](./server.rigidbody.md) &gt; [getDominanceGroup](./server.rigidbody.getdominancegroup.md)
-
-## RigidBody.getDominanceGroup() method
-
-Gets the dominance group of the rigid body.
-
-**Signature:**
-
-```typescript
-getDominanceGroup(): number;
-```
-**Returns:**
-
-number
-
-The dominance group of the rigid body.
-

package/docs/server.rigidbody.geteffectiveangularinertia.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [RigidBody](./server.rigidbody.md) &gt; [getEffectiveAngularInertia](./server.rigidbody.geteffectiveangularinertia.md)
-
-## RigidBody.getEffectiveAngularInertia() method
-
-Gets the effective angular inertia of the rigid body.
-
-**Signature:**
-
-```typescript
-getEffectiveAngularInertia(): SpdMatrix3 | undefined;
-```
-**Returns:**
-
-[SpdMatrix3](./server.spdmatrix3.md) \| undefined
-
-The effective angular inertia of the rigid body.
-

package/docs/server.rigidbody.geteffectiveinversemass.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [RigidBody](./server.rigidbody.md) &gt; [getEffectiveInverseMass](./server.rigidbody.geteffectiveinversemass.md)
-
-## RigidBody.getEffectiveInverseMass() method
-
-Gets the effective inverse mass of the rigid body.
-
-**Signature:**
-
-```typescript
-getEffectiveInverseMass(): Vector3Like | undefined;
-```
-**Returns:**
-
-[Vector3Like](./server.vector3like.md) \| undefined
-
-The effective inverse mass of the rigid body.
-

package/docs/server.rigidbody.geteffectiveworldinverseprincipalangularinertiasqrt.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [RigidBody](./server.rigidbody.md) &gt; [getEffectiveWorldInversePrincipalAngularInertiaSqrt](./server.rigidbody.geteffectiveworldinverseprincipalangularinertiasqrt.md)
-
-## RigidBody.getEffectiveWorldInversePrincipalAngularInertiaSqrt() method
-
-Gets the effective world inverse principal angular inertia square root of the rigid body.
-
-**Signature:**
-
-```typescript
-getEffectiveWorldInversePrincipalAngularInertiaSqrt(): SpdMatrix3 | undefined;
-```
-**Returns:**
-
-[SpdMatrix3](./server.spdmatrix3.md) \| undefined
-
-The effective world inverse principal angular inertia square root of the rigid body.
-

package/docs/server.rigidbody.getenabledrotations.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [RigidBody](./server.rigidbody.md) &gt; [getEnabledRotations](./server.rigidbody.getenabledrotations.md)
-
-## RigidBody.getEnabledRotations() method
-
-Gets the enabled rotations of the rigid body.
-
-**Signature:**
-
-```typescript
-getEnabledRotations(): Vector3Boolean;
-```
-**Returns:**
-
-[Vector3Boolean](./server.vector3boolean.md)
-
-The enabled rotations of the rigid body.
-

package/docs/server.rigidbody.getenabledtranslations.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [RigidBody](./server.rigidbody.md) &gt; [getEnabledTranslations](./server.rigidbody.getenabledtranslations.md)
-
-## RigidBody.getEnabledTranslations() method
-
-Gets the enabled translations of the rigid body.
-
-**Signature:**
-
-```typescript
-getEnabledTranslations(): Vector3Boolean;
-```
-**Returns:**
-
-[Vector3Boolean](./server.vector3boolean.md)
-
-The enabled translations of the rigid body.
-

package/docs/server.rigidbody.getgravityscale.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [RigidBody](./server.rigidbody.md) &gt; [getGravityScale](./server.rigidbody.getgravityscale.md)
-
-## RigidBody.getGravityScale() method
-
-Gets the gravity scale of the rigid body.
-
-**Signature:**
-
-```typescript
-getGravityScale(): number;
-```
-**Returns:**
-
-number
-
-The gravity scale of the rigid body.
-

package/docs/server.rigidbody.getinversemass.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [RigidBody](./server.rigidbody.md) &gt; [getInverseMass](./server.rigidbody.getinversemass.md)
-
-## RigidBody.getInverseMass() method
-
-Gets the inverse mass of the rigid body.
-
-**Signature:**
-
-```typescript
-getInverseMass(): number | undefined;
-```
-**Returns:**
-
-number \| undefined
-
-The inverse mass of the rigid body.
-

package/docs/server.rigidbody.getinverseprincipalangularinertiasqrt.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [RigidBody](./server.rigidbody.md) &gt; [getInversePrincipalAngularInertiaSqrt](./server.rigidbody.getinverseprincipalangularinertiasqrt.md)
-
-## RigidBody.getInversePrincipalAngularInertiaSqrt() method
-
-Gets the inverse principal angular inertia square root of the rigid body.
-
-**Signature:**
-
-```typescript
-getInversePrincipalAngularInertiaSqrt(): Vector3Like | undefined;
-```
-**Returns:**
-
-[Vector3Like](./server.vector3like.md) \| undefined
-
-The inverse principal angular inertia square root of the rigid body.
-

package/docs/server.rigidbody.getlineardamping.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [RigidBody](./server.rigidbody.md) &gt; [getLinearDamping](./server.rigidbody.getlineardamping.md)
-
-## RigidBody.getLinearDamping() method
-
-Gets the linear damping of the rigid body.
-
-**Signature:**
-
-```typescript
-getLinearDamping(): number;
-```
-**Returns:**
-
-number
-
-The linear damping of the rigid body.
-

package/docs/server.rigidbody.getlinearvelocity.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [RigidBody](./server.rigidbody.md) &gt; [getLinearVelocity](./server.rigidbody.getlinearvelocity.md)
-
-## RigidBody.getLinearVelocity() method
-
-Gets the linear velocity of the rigid body.
-
-**Signature:**
-
-```typescript
-getLinearVelocity(): Vector3Like;
-```
-**Returns:**
-
-[Vector3Like](./server.vector3like.md)
-
-The linear velocity of the rigid body.
-

package/docs/server.rigidbody.getlocalcenterofmass.md

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [server](./server.md) &gt; [RigidBody](./server.rigidbody.md) &gt; [getLocalCenterOfMass](./server.rigidbody.getlocalcenterofmass.md)
-
-## RigidBody.getLocalCenterOfMass() method
-
-Gets the local center of mass of the rigid body.
-
-**Signature:**
-
-```typescript
-getLocalCenterOfMass(): Vector3Like;
-```
-**Returns:**
-
-[Vector3Like](./server.vector3like.md)
-
-The local center of mass of the rigid body.
-