hytopia 0.1.55 → 0.1.57

package/boilerplate/index.ts

@@ -70,7 +70,7 @@ startServer(world => {
    * the game. From here, we create a basic player
    * entity instance which automatically handles mapping
    * their inputs to control their in-game entity and
-   * internally uses our default character controller.
+   * internally uses our player entity controller.
    */
   world.onPlayerJoin = player => {
     const playerEntity = new PlayerEntity({

package/docs/server.baseentitycontroller.attach.md

@@ -0,0 +1,53 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseEntityController](./server.baseentitycontroller.md) &gt; [attach](./server.baseentitycontroller.attach.md)
+
+## BaseEntityController.attach() method
+
+Override this method to handle the attachment of an entity to your entity controller.
+
+**Signature:**
+
+```typescript
+attach(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 to attach the controller to.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.baseentitycontroller.despawn.md

@@ -0,0 +1,53 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseEntityController](./server.baseentitycontroller.md) &gt; [despawn](./server.baseentitycontroller.despawn.md)
+
+## BaseEntityController.despawn() method
+
+Override this method to handle the despawn of an entity from your entity controller.
+
+**Signature:**
+
+```typescript
+despawn(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 to despawn.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.baseentitycontroller.detach.md

@@ -0,0 +1,53 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseEntityController](./server.baseentitycontroller.md) &gt; [detach](./server.baseentitycontroller.detach.md)
+
+## BaseEntityController.detach() method
+
+Override this method to handle the detachment of an entity from your entity controller.
+
+**Signature:**
+
+```typescript
+detach(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 to detach.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.baseentitycontroller.md

@@ -0,0 +1,260 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseEntityController](./server.baseentitycontroller.md)
+
+## BaseEntityController class
+
+A base class for entity controller implementations.
+
+**Signature:**
+
+```typescript
+export default abstract class BaseEntityController 
+```
+
+## Remarks
+
+The BaseEntityController should be extended by a more specific entity controller that you or a plugin implements. Entity controllers are intended to be used as one controller instance per entity, but are flexible enough for edge cases such as if you want to create niche behavior of one controller for many entities that behave in unison.
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[onAttach?](./server.baseentitycontroller.onattach.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(entity: [Entity](./server.entity.md)<!-- -->) =&gt; void
+
+
+</td><td>
+
+_(Optional)_ A function that is called when the controller is attached to an entity. Useful for implementing attach logic without writing a new entity controller class.
+
+
+</td></tr>
+<tr><td>
+
+[onDespawn?](./server.baseentitycontroller.ondespawn.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(entity: [Entity](./server.entity.md)<!-- -->) =&gt; void
+
+
+</td><td>
+
+_(Optional)_ A function that is called when the controlled entity is despawned. Useful for implementing despawn logic without writing a new entity controller class.
+
+
+</td></tr>
+<tr><td>
+
+[onDetach?](./server.baseentitycontroller.ondetach.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(entity: [Entity](./server.entity.md)<!-- -->) =&gt; void
+
+
+</td><td>
+
+_(Optional)_ A function that is called when the controller is detached from an entity. Useful for implementing detach logic without writing a new entity controller class.
+
+
+</td></tr>
+<tr><td>
+
+[onSpawn?](./server.baseentitycontroller.onspawn.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(entity: [Entity](./server.entity.md)<!-- -->) =&gt; void
+
+
+</td><td>
+
+_(Optional)_ A function that is called when the controlled entity is spawned. Useful for implementing spawn logic without writing a new entity controller class.
+
+
+</td></tr>
+<tr><td>
+
+[onTick?](./server.baseentitycontroller.ontick.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(entity: [Entity](./server.entity.md)<!-- -->, deltaTimeMs: number) =&gt; void
+
+
+</td><td>
+
+_(Optional)_ A function that is called every tick. Useful for implementing tick logic without writing a new entity controller class.
+
+
+</td></tr>
+<tr><td>
+
+[onTickWithPlayerInput?](./server.baseentitycontroller.ontickwithplayerinput.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(entity: [PlayerEntity](./server.playerentity.md)<!-- -->, input: [PlayerInput](./server.playerinput.md)<!-- -->, cameraOrientation: [PlayerCameraOrientation](./server.playercameraorientation.md)<!-- -->, deltaTimeMs: number) =&gt; void
+
+
+</td><td>
+
+_(Optional)_ A function that is called every tick with player input by a PlayerEntity with this controller attached. Useful for implementing tick logic without writing a new entity controller class.
+
+
+</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.baseentitycontroller.attach.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Override this method to handle the attachment of an entity to your entity controller.
+
+
+</td></tr>
+<tr><td>
+
+[despawn(entity)](./server.baseentitycontroller.despawn.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Override this method to handle the despawn of an entity from your entity controller.
+
+
+</td></tr>
+<tr><td>
+
+[detach(entity)](./server.baseentitycontroller.detach.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Override this method to handle the detachment of an entity from your entity controller.
+
+
+</td></tr>
+<tr><td>
+
+[spawn(entity)](./server.baseentitycontroller.spawn.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Override this method to handle the spawning of an entity to your entity controller.
+
+
+</td></tr>
+<tr><td>
+
+[tick(entity, deltaTimeMs)](./server.baseentitycontroller.tick.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Override this method to handle entity movements based on your entity controller.
+
+
+</td></tr>
+<tr><td>
+
+[tickWithPlayerInput(entity, input, cameraOrientation, deltaTimeMs)](./server.baseentitycontroller.tickwithplayerinput.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Override this method to handle entity movements based on player input for your entity controller. This is called every tick by a PlayerEntity with a entity controller.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.baseentitycontroller.onattach.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; [BaseEntityController](./server.baseentitycontroller.md) &gt; [onAttach](./server.baseentitycontroller.onattach.md)
+
+## BaseEntityController.onAttach property
+
+A function that is called when the controller is attached to an entity. Useful for implementing attach logic without writing a new entity controller class.
+
+**Signature:**
+
+```typescript
+onAttach?: (entity: Entity) => void;
+```

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

package/docs/server.baseentitycontroller.ondetach.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; [BaseEntityController](./server.baseentitycontroller.md) &gt; [onDetach](./server.baseentitycontroller.ondetach.md)
+
+## BaseEntityController.onDetach property
+
+A function that is called when the controller is detached from an entity. Useful for implementing detach logic without writing a new entity controller class.
+
+**Signature:**
+
+```typescript
+onDetach?: (entity: Entity) => void;
+```

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

package/docs/server.baseentitycontroller.ontick.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; [BaseEntityController](./server.baseentitycontroller.md) &gt; [onTick](./server.baseentitycontroller.ontick.md)
+
+## BaseEntityController.onTick property
+
+A function that is called every tick. Useful for implementing tick logic without writing a new entity controller class.
+
+**Signature:**
+
+```typescript
+onTick?: (entity: Entity, deltaTimeMs: number) => void;
+```

package/docs/server.baseentitycontroller.ontickwithplayerinput.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; [BaseEntityController](./server.baseentitycontroller.md) &gt; [onTickWithPlayerInput](./server.baseentitycontroller.ontickwithplayerinput.md)
+
+## BaseEntityController.onTickWithPlayerInput property
+
+A function that is called every tick with player input by a PlayerEntity with this controller attached. Useful for implementing tick logic without writing a new entity controller class.
+
+**Signature:**
+
+```typescript
+onTickWithPlayerInput?: (entity: PlayerEntity, input: PlayerInput, cameraOrientation: PlayerCameraOrientation, deltaTimeMs: number) => void;
+```

package/docs/server.baseentitycontroller.spawn.md

@@ -0,0 +1,53 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseEntityController](./server.baseentitycontroller.md) &gt; [spawn](./server.baseentitycontroller.spawn.md)
+
+## BaseEntityController.spawn() method
+
+Override this method to handle the spawning of an entity to your entity controller.
+
+**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 to spawn.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.baseentitycontroller.tick.md

@@ -0,0 +1,67 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseEntityController](./server.baseentitycontroller.md) &gt; [tick](./server.baseentitycontroller.tick.md)
+
+## BaseEntityController.tick() method
+
+Override this method to handle entity movements based on your entity controller.
+
+**Signature:**
+
+```typescript
+tick(entity: Entity, deltaTimeMs: number): 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>
+
+
+</td></tr>
+<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.basecharactercontroller.tickwithplayerinput.md → server.baseentitycontroller.tickwithplayerinput.md}

@@ -1,15 +1,15 @@
 <!-- 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; [tickWithPlayerInput](./server.basecharactercontroller.tickwithplayerinput.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseEntityController](./server.baseentitycontroller.md) &gt; [tickWithPlayerInput](./server.baseentitycontroller.tickwithplayerinput.md)
 
-## BaseCharacterController.tickWithPlayerInput() method
+## BaseEntityController.tickWithPlayerInput() method
 
-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.
+Override this method to handle entity movements based on player input for your entity controller. This is called every tick by a PlayerEntity with a entity controller.
 
 **Signature:**
 
 ```typescript
-tickWithPlayerInput(input: PlayerInput, cameraOrientation: PlayerCameraOrientation, deltaTimeMs: number): void;
+tickWithPlayerInput(entity: PlayerEntity, input: PlayerInput, cameraOrientation: PlayerCameraOrientation, deltaTimeMs: number): void;
 ```
 
 ## Parameters
@@ -32,6 +32,22 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+entity
+
+
+</td><td>
+
+[PlayerEntity](./server.playerentity.md)
+
+
+</td><td>
+
+The entity to tick.
+
+
+</td></tr>
+<tr><td>
+
 input
 
 

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