hytopia 0.1.55 → 0.1.57

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.basecharactercontroller.md

@@ -1,197 +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)
-
-## BaseCharacterController class
-
-A base class for character controller implementations.
-
-**Signature:**
-
-```typescript
-export default abstract class BaseCharacterController 
-```
-
-## Remarks
-
-The BaseCharacterController should be extended by a more specific character controller that you or a plugin implements.
-
-## Constructors
-
-<table><thead><tr><th>
-
-Constructor
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[(constructor)(entity, \_options)](./server.basecharactercontroller._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Constructs a new instance of the `BaseCharacterController` class
-
-
-</td></tr>
-</tbody></table>
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[entity](./server.basecharactercontroller.entity.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-[Entity](./server.entity.md)
-
-
-</td><td>
-
-The entity the controller is for.
-
-
-</td></tr>
-<tr><td>
-
-[onTick?](./server.basecharactercontroller.ontick.md)
-
-
-</td><td>
-
-
-</td><td>
-
-(deltaTimeMs: number) =&gt; void
-
-
-</td><td>
-
-_(Optional)_ A callback function for when the controller ticks.
-
-
-</td></tr>
-<tr><td>
-
-[onTickWithPlayerInput?](./server.basecharactercontroller.ontickwithplayerinput.md)
-
-
-</td><td>
-
-
-</td><td>
-
-(input: [PlayerInput](./server.playerinput.md)<!-- -->, cameraOrientation: [PlayerCameraOrientation](./server.playercameraorientation.md)<!-- -->, deltaTimeMs: number) =&gt; void
-
-
-</td><td>
-
-_(Optional)_ A callback function for when the controller ticks player movement.
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[createColliders()](./server.basecharactercontroller.createcolliders.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Override this method to create controller specific colliders to be attached to the controlled entity when it spawns.
-
-
-</td></tr>
-<tr><td>
-
-[tick(deltaTimeMs)](./server.basecharactercontroller.tick.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Override this method to handle entity movements based on your character controller.
-
-
-</td></tr>
-<tr><td>
-
-[tickWithPlayerInput(input, cameraOrientation, deltaTimeMs)](./server.basecharactercontroller.tickwithplayerinput.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Override this method to handle entity movements based on player input for your character controller. This is called every tick by a PlayerEntity with a character controller.
-
-
-</td></tr>
-</tbody></table>

package/docs/server.basecharactercontroller.ontick.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; [onTick](./server.basecharactercontroller.ontick.md)
-
-## BaseCharacterController.onTick property
-
-A callback function for when the controller ticks.
-
-**Signature:**
-
-```typescript
-onTick?: (deltaTimeMs: number) => void;
-```

package/docs/server.basecharactercontroller.ontickwithplayerinput.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; [onTickWithPlayerInput](./server.basecharactercontroller.ontickwithplayerinput.md)
-
-## BaseCharacterController.onTickWithPlayerInput property
-
-A callback function for when the controller ticks player movement.
-
-**Signature:**
-
-```typescript
-onTickWithPlayerInput?: (input: PlayerInput, cameraOrientation: PlayerCameraOrientation, deltaTimeMs: number) => void;
-```

package/docs/server.basecharactercontroller.tick.md

@@ -1,53 +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; [tick](./server.basecharactercontroller.tick.md)
-
-## BaseCharacterController.tick() method
-
-Override this method to handle entity movements based on your character controller.
-
-**Signature:**
-
-```typescript
-tick(deltaTimeMs: number): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-deltaTimeMs
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-The delta time in milliseconds since the last tick.
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-void
-

package/docs/server.defaultcharactercontroller._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; [DefaultCharacterController](./server.defaultcharactercontroller.md) &gt; [(constructor)](./server.defaultcharactercontroller._constructor_.md)
-
-## DefaultCharacterController.(constructor)
-
-Constructs a new instance of the `DefaultCharacterController` class
-
-**Signature:**
-
-```typescript
-constructor(entity: Entity, options?: DefaultCharacterControllerOptions);
-```
-
-## 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>
-
-[DefaultCharacterControllerOptions](./server.defaultcharactercontrolleroptions.md)
-
-
-</td><td>
-
-_(Optional)_ Options for the controller.
-
-
-</td></tr>
-</tbody></table>

package/docs/server.defaultcharactercontroller.canjump.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; [DefaultCharacterController](./server.defaultcharactercontroller.md) &gt; [canJump](./server.defaultcharactercontroller.canjump.md)
-
-## DefaultCharacterController.canJump property
-
-A function allowing custom logic to determine if the entity can jump.
-
-**Signature:**
-
-```typescript
-canJump: (defaultCharacterController: DefaultCharacterController) => boolean;
-```

package/docs/server.defaultcharactercontroller.canrun.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; [DefaultCharacterController](./server.defaultcharactercontroller.md) &gt; [canRun](./server.defaultcharactercontroller.canrun.md)
-
-## DefaultCharacterController.canRun property
-
-A function allowing custom logic to determine if the entity can run.
-
-**Signature:**
-
-```typescript
-canRun: (defaultCharacterController: DefaultCharacterController) => boolean;
-```

package/docs/server.defaultcharactercontroller.canwalk.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; [DefaultCharacterController](./server.defaultcharactercontroller.md) &gt; [canWalk](./server.defaultcharactercontroller.canwalk.md)
-
-## DefaultCharacterController.canWalk property
-
-A function allowing custom logic to determine if the entity can walk.
-
-**Signature:**
-
-```typescript
-canWalk: (defaultCharacterController: DefaultCharacterController) => boolean;
-```

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.defaultcharactercontroller.isgrounded.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; [DefaultCharacterController](./server.defaultcharactercontroller.md) &gt; [isGrounded](./server.defaultcharactercontroller.isgrounded.md)
-
-## DefaultCharacterController.isGrounded property
-
-Whether the entity is grounded.
-
-**Signature:**
-
-```typescript
-get isGrounded(): boolean;
-```

package/docs/server.defaultcharactercontroller.isonplatform.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; [DefaultCharacterController](./server.defaultcharactercontroller.md) &gt; [isOnPlatform](./server.defaultcharactercontroller.isonplatform.md)
-
-## DefaultCharacterController.isOnPlatform property
-
-Whether the entity is on a platform, a platform is any entity with a kinematic rigid body.
-
-**Signature:**
-
-```typescript
-get isOnPlatform(): boolean;
-```

package/docs/server.defaultcharactercontroller.jumpvelocity.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; [DefaultCharacterController](./server.defaultcharactercontroller.md) &gt; [jumpVelocity](./server.defaultcharactercontroller.jumpvelocity.md)
-
-## DefaultCharacterController.jumpVelocity property
-
-The upward velocity applied to the entity when it jumps.
-
-**Signature:**
-
-```typescript
-jumpVelocity: number;
-```