hytopia 0.1.55 → 0.1.57

package/docs/server.defaultcharactercontroller.md

@@ -1,319 +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)
-
-## DefaultCharacterController class
-
-The default character controller implementation.
-
-**Signature:**
-
-```typescript
-export default class DefaultCharacterController extends BaseCharacterController 
-```
-**Extends:** [BaseCharacterController](./server.basecharactercontroller.md)
-
-## Remarks
-
-This class extends [BaseCharacterController](./server.basecharactercontroller.md) and implements the default movement logic for a character entity. This is used as the default for players when they join your game. This class may be extended if you'd like to implement additional logic on top of the DefaultCharacterController implementation.
-
-## Example
-
-
-```typescript
-// Create a custom character controller for myEntity, prior to spawning it.
-myEntity.createCustomCharacterController = () => {
-  return new DefaultCharacterController(myEntity, {
-    jumpVelocity: 10,
-    runVelocity: 8,
-    walkVelocity: 4,
-  });
-};
-
-// Spawn the entity in the world.
-myEntity.spawn(world, { x: 53, y: 10, z: 23 });
-```
-
-## Constructors
-
-<table><thead><tr><th>
-
-Constructor
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[(constructor)(entity, options)](./server.defaultcharactercontroller._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Constructs a new instance of the `DefaultCharacterController` 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>
-
-[canJump](./server.defaultcharactercontroller.canjump.md)
-
-
-</td><td>
-
-
-</td><td>
-
-(defaultCharacterController: [DefaultCharacterController](./server.defaultcharactercontroller.md)<!-- -->) =&gt; boolean
-
-
-</td><td>
-
-A function allowing custom logic to determine if the entity can jump.
-
-
-</td></tr>
-<tr><td>
-
-[canRun](./server.defaultcharactercontroller.canrun.md)
-
-
-</td><td>
-
-
-</td><td>
-
-(defaultCharacterController: [DefaultCharacterController](./server.defaultcharactercontroller.md)<!-- -->) =&gt; boolean
-
-
-</td><td>
-
-A function allowing custom logic to determine if the entity can run.
-
-
-</td></tr>
-<tr><td>
-
-[canWalk](./server.defaultcharactercontroller.canwalk.md)
-
-
-</td><td>
-
-
-</td><td>
-
-(defaultCharacterController: [DefaultCharacterController](./server.defaultcharactercontroller.md)<!-- -->) =&gt; boolean
-
-
-</td><td>
-
-A function allowing custom logic to determine if the entity can walk.
-
-
-</td></tr>
-<tr><td>
-
-[isGrounded](./server.defaultcharactercontroller.isgrounded.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-Whether the entity is grounded.
-
-
-</td></tr>
-<tr><td>
-
-[isOnPlatform](./server.defaultcharactercontroller.isonplatform.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-Whether the entity is on a platform, a platform is any entity with a kinematic rigid body.
-
-
-</td></tr>
-<tr><td>
-
-[jumpVelocity](./server.defaultcharactercontroller.jumpvelocity.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-The upward velocity applied to the entity when it jumps.
-
-
-</td></tr>
-<tr><td>
-
-[platform](./server.defaultcharactercontroller.platform.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-[Entity](./server.entity.md) \| undefined
-
-
-</td><td>
-
-The platform the entity is on, if any.
-
-
-</td></tr>
-<tr><td>
-
-[runVelocity](./server.defaultcharactercontroller.runvelocity.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-The normalized horizontal velocity applied to the entity when it runs.
-
-
-</td></tr>
-<tr><td>
-
-[walkVelocity](./server.defaultcharactercontroller.walkvelocity.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-The normalized horizontal velocity applied to the entity when it walks.
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[createColliders()](./server.defaultcharactercontroller.createcolliders.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Creates the colliders for the character controller, overriding the default implementation.
-
-
-</td></tr>
-<tr><td>
-
-[tickWithPlayerInput(input, cameraOrientation, deltaTimeMs)](./server.defaultcharactercontroller.tickwithplayerinput.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Ticks the player movement for the character controller, overriding the default implementation.
-
-
-</td></tr>
-</tbody></table>

package/docs/server.defaultcharactercontroller.platform.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; [platform](./server.defaultcharactercontroller.platform.md)
-
-## DefaultCharacterController.platform property
-
-The platform the entity is on, if any.
-
-**Signature:**
-
-```typescript
-get platform(): Entity | undefined;
-```

package/docs/server.defaultcharactercontroller.runvelocity.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; [runVelocity](./server.defaultcharactercontroller.runvelocity.md)
-
-## DefaultCharacterController.runVelocity property
-
-The normalized horizontal velocity applied to the entity when it runs.
-
-**Signature:**
-
-```typescript
-runVelocity: number;
-```

package/docs/server.defaultcharactercontroller.walkvelocity.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; [walkVelocity](./server.defaultcharactercontroller.walkvelocity.md)
-
-## DefaultCharacterController.walkVelocity property
-
-The normalized horizontal velocity applied to the entity when it walks.
-
-**Signature:**
-
-```typescript
-walkVelocity: number;
-```

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

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

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

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

package/docs/server.defaultcharactercontrolleroptions.runvelocity.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; [DefaultCharacterControllerOptions](./server.defaultcharactercontrolleroptions.md) &gt; [runVelocity](./server.defaultcharactercontrolleroptions.runvelocity.md)
-
-## DefaultCharacterControllerOptions.runVelocity property
-
-The normalized horizontal velocity applied to the entity when it runs.
-
-**Signature:**
-
-```typescript
-runVelocity?: number;
-```

package/docs/server.defaultcharactercontrolleroptions.walkvelocity.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; [DefaultCharacterControllerOptions](./server.defaultcharactercontrolleroptions.md) &gt; [walkVelocity](./server.defaultcharactercontrolleroptions.walkvelocity.md)
-
-## DefaultCharacterControllerOptions.walkVelocity property
-
-The normalized horizontal velocity applied to the entity when it walks.
-
-**Signature:**
-
-```typescript
-walkVelocity?: number;
-```

package/docs/server.entity.charactercontroller.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; [characterController](./server.entity.charactercontroller.md)
-
-## Entity.characterController property
-
-The character controller for the entity.
-
-**Signature:**
-
-```typescript
-get characterController(): BaseCharacterController | undefined;
-```

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.entity.setcharactercontroller.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; [Entity](./server.entity.md) &gt; [setCharacterController](./server.entity.setcharactercontroller.md)
-
-## Entity.setCharacterController() method
-
-Sets the character controller for the entity.
-
-**Signature:**
-
-```typescript
-setCharacterController(characterController: BaseCharacterController): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-characterController
-
-
-</td><td>
-
-[BaseCharacterController](./server.basecharactercontroller.md)
-
-
-</td><td>
-
-The character controller to set.
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-void
-

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;
-```