hytopia 0.1.56 → 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.basecharactercontroller.attach.md → server.baseentitycontroller.attach.md}

@@ -1,10 +1,10 @@
 <!-- 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; [attach](./server.basecharactercontroller.attach.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseEntityController](./server.baseentitycontroller.md) &gt; [attach](./server.baseentitycontroller.attach.md)
 
-## BaseCharacterController.attach() method
+## BaseEntityController.attach() method
 
-Override this method to handle the attachment of an entity to your character controller.
+Override this method to handle the attachment of an entity to your entity controller.
 
 **Signature:**
 

package/docs/{server.basecharactercontroller.despawn.md → server.baseentitycontroller.despawn.md}

@@ -1,10 +1,10 @@
 <!-- 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; [despawn](./server.basecharactercontroller.despawn.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseEntityController](./server.baseentitycontroller.md) &gt; [despawn](./server.baseentitycontroller.despawn.md)
 
-## BaseCharacterController.despawn() method
+## BaseEntityController.despawn() method
 
-Override this method to handle the despawn of an entity from your character controller.
+Override this method to handle the despawn of an entity from your entity controller.
 
 **Signature:**
 

package/docs/{server.basecharactercontroller.detach.md → server.baseentitycontroller.detach.md}

@@ -1,10 +1,10 @@
 <!-- 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; [detach](./server.basecharactercontroller.detach.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseEntityController](./server.baseentitycontroller.md) &gt; [detach](./server.baseentitycontroller.detach.md)
 
-## BaseCharacterController.detach() method
+## BaseEntityController.detach() method
 
-Override this method to handle the detachment of an entity from your character controller.
+Override this method to handle the detachment of an entity from your entity controller.
 
 **Signature:**
 

package/docs/{server.basecharactercontroller.md → server.baseentitycontroller.md}

@@ -1,20 +1,20 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [server](./server.md) &gt; [BaseCharacterController](./server.basecharactercontroller.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseEntityController](./server.baseentitycontroller.md)
 
-## BaseCharacterController class
+## BaseEntityController class
 
-A base class for character controller implementations.
+A base class for entity controller implementations.
 
 **Signature:**
 
 ```typescript
-export default abstract class BaseCharacterController 
+export default abstract class BaseEntityController 
 ```
 
 ## Remarks
 
-The BaseCharacterController should be extended by a more specific character controller that you or a plugin implements.
+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
 
@@ -41,7 +41,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[onAttach?](./server.basecharactercontroller.onattach.md)
+[onAttach?](./server.baseentitycontroller.onattach.md)
 
 
 </td><td>
@@ -54,13 +54,13 @@ Description
 
 </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 character controller class.
+_(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.basecharactercontroller.ondespawn.md)
+[onDespawn?](./server.baseentitycontroller.ondespawn.md)
 
 
 </td><td>
@@ -73,13 +73,13 @@ _(Optional)_ A function that is called when the controller is attached to an ent
 
 </td><td>
 
-_(Optional)_ A function that is called when the controlled entity is despawned. Useful for implementing despawn logic without writing a new character controller class.
+_(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.basecharactercontroller.ondetach.md)
+[onDetach?](./server.baseentitycontroller.ondetach.md)
 
 
 </td><td>
@@ -92,13 +92,13 @@ _(Optional)_ A function that is called when the controlled entity is despawned.
 
 </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 character controller class.
+_(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.basecharactercontroller.onspawn.md)
+[onSpawn?](./server.baseentitycontroller.onspawn.md)
 
 
 </td><td>
@@ -111,13 +111,13 @@ _(Optional)_ A function that is called when the controller is detached from an e
 
 </td><td>
 
-_(Optional)_ A function that is called when the controlled entity is spawned. Useful for implementing spawn logic without writing a new character controller class.
+_(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.basecharactercontroller.ontick.md)
+[onTick?](./server.baseentitycontroller.ontick.md)
 
 
 </td><td>
@@ -130,13 +130,13 @@ _(Optional)_ A function that is called when the controlled entity is spawned. Us
 
 </td><td>
 
-_(Optional)_ A function that is called every tick. Useful for implementing tick logic without writing a new character controller class.
+_(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.basecharactercontroller.ontickwithplayerinput.md)
+[onTickWithPlayerInput?](./server.baseentitycontroller.ontickwithplayerinput.md)
 
 
 </td><td>
@@ -149,7 +149,7 @@ _(Optional)_ A function that is called every tick. Useful for implementing tick
 
 </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 character controller class.
+_(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>
@@ -175,7 +175,7 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[attach(entity)](./server.basecharactercontroller.attach.md)
+[attach(entity)](./server.baseentitycontroller.attach.md)
 
 
 </td><td>
@@ -183,13 +183,13 @@ Description
 
 </td><td>
 
-Override this method to handle the attachment of an entity to your character controller.
+Override this method to handle the attachment of an entity to your entity controller.
 
 
 </td></tr>
 <tr><td>
 
-[despawn(entity)](./server.basecharactercontroller.despawn.md)
+[despawn(entity)](./server.baseentitycontroller.despawn.md)
 
 
 </td><td>
@@ -197,13 +197,13 @@ Override this method to handle the attachment of an entity to your character con
 
 </td><td>
 
-Override this method to handle the despawn of an entity from your character controller.
+Override this method to handle the despawn of an entity from your entity controller.
 
 
 </td></tr>
 <tr><td>
 
-[detach(entity)](./server.basecharactercontroller.detach.md)
+[detach(entity)](./server.baseentitycontroller.detach.md)
 
 
 </td><td>
@@ -211,13 +211,13 @@ Override this method to handle the despawn of an entity from your character cont
 
 </td><td>
 
-Override this method to handle the detachment of an entity from your character controller.
+Override this method to handle the detachment of an entity from your entity controller.
 
 
 </td></tr>
 <tr><td>
 
-[spawn(entity)](./server.basecharactercontroller.spawn.md)
+[spawn(entity)](./server.baseentitycontroller.spawn.md)
 
 
 </td><td>
@@ -225,13 +225,13 @@ Override this method to handle the detachment of an entity from your character c
 
 </td><td>
 
-Override this method to handle the spawning of an entity to your character controller.
+Override this method to handle the spawning of an entity to your entity controller.
 
 
 </td></tr>
 <tr><td>
 
-[tick(entity, deltaTimeMs)](./server.basecharactercontroller.tick.md)
+[tick(entity, deltaTimeMs)](./server.baseentitycontroller.tick.md)
 
 
 </td><td>
@@ -239,13 +239,13 @@ Override this method to handle the spawning of an entity to your character contr
 
 </td><td>
 
-Override this method to handle entity movements based on your character controller.
+Override this method to handle entity movements based on your entity controller.
 
 
 </td></tr>
 <tr><td>
 
-[tickWithPlayerInput(entity, input, cameraOrientation, deltaTimeMs)](./server.basecharactercontroller.tickwithplayerinput.md)
+[tickWithPlayerInput(entity, input, cameraOrientation, deltaTimeMs)](./server.baseentitycontroller.tickwithplayerinput.md)
 
 
 </td><td>
@@ -253,7 +253,7 @@ Override this method to handle entity movements based on your character controll
 
 </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.
+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>

package/docs/{server.basecharactercontroller.onattach.md → server.baseentitycontroller.onattach.md}

@@ -1,10 +1,10 @@
 <!-- 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; [onAttach](./server.basecharactercontroller.onattach.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseEntityController](./server.baseentitycontroller.md) &gt; [onAttach](./server.baseentitycontroller.onattach.md)
 
-## BaseCharacterController.onAttach property
+## 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 character controller class.
+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:**
 

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.basecharactercontroller.ondetach.md → server.baseentitycontroller.ondetach.md}

@@ -1,10 +1,10 @@
 <!-- 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; [onDetach](./server.basecharactercontroller.ondetach.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseEntityController](./server.baseentitycontroller.md) &gt; [onDetach](./server.baseentitycontroller.ondetach.md)
 
-## BaseCharacterController.onDetach property
+## 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 character controller class.
+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:**
 

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.basecharactercontroller.ontickwithplayerinput.md → server.baseentitycontroller.ontickwithplayerinput.md}

@@ -1,10 +1,10 @@
 <!-- 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)
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseEntityController](./server.baseentitycontroller.md) &gt; [onTickWithPlayerInput](./server.baseentitycontroller.ontickwithplayerinput.md)
 
-## BaseCharacterController.onTickWithPlayerInput property
+## 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 character controller class.
+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:**
 

package/docs/{server.basecharactercontroller.spawn.md → server.baseentitycontroller.spawn.md}

@@ -1,10 +1,10 @@
 <!-- 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; [spawn](./server.basecharactercontroller.spawn.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseEntityController](./server.baseentitycontroller.md) &gt; [spawn](./server.baseentitycontroller.spawn.md)
 
-## BaseCharacterController.spawn() method
+## BaseEntityController.spawn() method
 
-Override this method to handle the spawning of an entity to your character controller.
+Override this method to handle the spawning of an entity to your entity controller.
 
 **Signature:**
 

package/docs/{server.basecharactercontroller.tick.md → server.baseentitycontroller.tick.md}

@@ -1,10 +1,10 @@
 <!-- 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)
+[Home](./index.md) &gt; [server](./server.md) &gt; [BaseEntityController](./server.baseentitycontroller.md) &gt; [tick](./server.baseentitycontroller.tick.md)
 
-## BaseCharacterController.tick() method
+## BaseEntityController.tick() method
 
-Override this method to handle entity movements based on your character controller.
+Override this method to handle entity movements based on your entity controller.
 
 **Signature:**
 

package/docs/{server.basecharactercontroller.tickwithplayerinput.md → server.baseentitycontroller.tickwithplayerinput.md}

@@ -1,10 +1,10 @@
 <!-- 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:**
 

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

package/docs/server.entity.md

@@ -146,7 +146,7 @@ The URI or path to the texture to be used, if this is set, the entity is a block
 </td></tr>
 <tr><td>
 
-[characterController](./server.entity.charactercontroller.md)
+[controller](./server.entity.controller.md)
 
 
 </td><td>
@@ -156,12 +156,12 @@ The URI or path to the texture to be used, if this is set, the entity is a block
 
 </td><td>
 
-[BaseCharacterController](./server.basecharactercontroller.md) \| undefined
+[BaseEntityController](./server.baseentitycontroller.md) \| undefined
 
 
 </td><td>
 
-The character controller for the entity.
+The controller for the entity.
 
 
 </td></tr>
@@ -248,6 +248,27 @@ boolean
 Whether the entity is spawned.
 
 
+</td></tr>
+<tr><td>
+
+[modelAnimationsPlaybackRate](./server.entity.modelanimationsplaybackrate.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The playback rate of the entity's model animations.
+
+
 </td></tr>
 <tr><td>
 
@@ -586,7 +607,21 @@ Despawns the entity from the world.
 </td></tr>
 <tr><td>
 
-[setCharacterController(characterController)](./server.entity.setcharactercontroller.md)
+[setController(controller)](./server.entity.setcontroller.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Sets the controller for the entity.
+
+
+</td></tr>
+<tr><td>
+
+[setModelAnimationsPlaybackRate(playbackRate)](./server.entity.setmodelanimationsplaybackrate.md)
 
 
 </td><td>
@@ -594,7 +629,7 @@ Despawns the entity from the world.
 
 </td><td>
 
-Sets the character controller for the entity.
+Sets the playback rate of all animations on the entity's model.
 
 
 </td></tr>

package/docs/server.entity.modelanimationsplaybackrate.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; [modelAnimationsPlaybackRate](./server.entity.modelanimationsplaybackrate.md)
+
+## Entity.modelAnimationsPlaybackRate property
+
+The playback rate of the entity's model animations.
+
+**Signature:**
+
+```typescript
+get modelAnimationsPlaybackRate(): number;
+```

package/docs/server.entity.setcontroller.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; [Entity](./server.entity.md) &gt; [setController](./server.entity.setcontroller.md)
+
+## Entity.setController() method
+
+Sets the controller for the entity.
+
+**Signature:**
+
+```typescript
+setController(controller: BaseEntityController | undefined): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+controller
+
+
+</td><td>
+
+[BaseEntityController](./server.baseentitycontroller.md) \| undefined
+
+
+</td><td>
+
+The controller to set.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/docs/server.entity.setmodelanimationsplaybackrate.md

@@ -0,0 +1,57 @@
+<!-- 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; [setModelAnimationsPlaybackRate](./server.entity.setmodelanimationsplaybackrate.md)
+
+## Entity.setModelAnimationsPlaybackRate() method
+
+Sets the playback rate of all animations on the entity's model.
+
+**Signature:**
+
+```typescript
+setModelAnimationsPlaybackRate(playbackRate: number): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+playbackRate
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The playback rate of the entity's model animations.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+
+## Remarks
+
+Defaults to 1. A positive value will play the animation forward, a negative value will play the animation in reverse. Any value may be used. You can make animations play faster by using larger values.
+

package/docs/server.entityeventpayload.md

@@ -33,6 +33,15 @@ Description
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+[SetModelAnimationsPlaybackRate](./server.entityeventpayload.setmodelanimationsplaybackrate.md)
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 

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

@@ -0,0 +1,11 @@
+<!-- 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; [SetModelAnimationsPlaybackRate](./server.entityeventpayload.setmodelanimationsplaybackrate.md) &gt; [entity](./server.entityeventpayload.setmodelanimationsplaybackrate.entity.md)
+
+## EntityEventPayload.SetModelAnimationsPlaybackRate.entity property
+
+**Signature:**
+
+```typescript
+entity: Entity;
+```