hytopia 0.1.56 → 0.1.57

package/docs/server.basecharactercontroller.ondespawn.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; [onDespawn](./server.basecharactercontroller.ondespawn.md)
-
-## BaseCharacterController.onDespawn property
-
-A function that is called when the controlled entity is despawned. Useful for implementing despawn logic without writing a new character controller class.
-
-**Signature:**
-
-```typescript
-onDespawn?: (entity: Entity) => void;
-```

package/docs/server.basecharactercontroller.onspawn.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; [onSpawn](./server.basecharactercontroller.onspawn.md)
-
-## BaseCharacterController.onSpawn property
-
-A function that is called when the controlled entity is spawned. Useful for implementing spawn logic without writing a new character controller class.
-
-**Signature:**
-
-```typescript
-onSpawn?: (entity: Entity) => void;
-```

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 function that is called every tick. Useful for implementing tick logic without writing a new character controller class.
-
-**Signature:**
-
-```typescript
-onTick?: (entity: Entity, deltaTimeMs: number) => void;
-```

package/docs/server.defaultcharactercontroller._constructor_.md

@@ -1,49 +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(options?: DefaultCharacterControllerOptions);
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><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.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;
-```

package/docs/server.defaultcharactercontroller.md

@@ -1,333 +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)(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>
-
-[attach(entity)](./server.defaultcharactercontroller.attach.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Called when the controller is attached to an entity.
-
-
-</td></tr>
-<tr><td>
-
-[spawn(entity)](./server.defaultcharactercontroller.spawn.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Called when the controlled entity is spawned. In DefaultCharacterController, this function is used to create the colliders for the entity for wall and ground detection.
-
-
-</td></tr>
-<tr><td>
-
-[tickWithPlayerInput(entity, 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.spawn.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; [DefaultCharacterController](./server.defaultcharactercontroller.md) &gt; [spawn](./server.defaultcharactercontroller.spawn.md)
-
-## DefaultCharacterController.spawn() method
-
-Called when the controlled entity is spawned. In DefaultCharacterController, this function is used to create the colliders for the entity for wall and ground detection.
-
-**Signature:**
-
-```typescript
-spawn(entity: Entity): void;
-```
-
-## 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 that is spawned.
-
-
-</td></tr>
-</tbody></table>
-**Returns:**
-
-void
-

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