hytopia 0.1.55 → 0.1.57

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,37 +156,39 @@ 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>
 <tr><td>
 
-[createCustomCharacterController?](./server.entity.createcustomcharactercontroller.md)
+[id](./server.entity.id.md)
 
 
 </td><td>
 
+`readonly`
+
 
 </td><td>
 
-(entity: [Entity](./server.entity.md)<!-- -->) =&gt; [BaseCharacterController](./server.basecharactercontroller.md)
+number \| undefined
 
 
 </td><td>
 
-_(Optional)_ A function that creates a custom character controller for the entity when it spawns.
+The unique identifier for the entity.
 
 
 </td></tr>
 <tr><td>
 
-[id](./server.entity.id.md)
+[isBlockEntity](./server.entity.isblockentity.md)
 
 
 </td><td>
@@ -196,18 +198,18 @@ _(Optional)_ A function that creates a custom character controller for the entit
 
 </td><td>
 
-number \| undefined
+boolean
 
 
 </td><td>
 
-The unique identifier for the entity.
+Whether the entity is a block entity.
 
 
 </td></tr>
 <tr><td>
 
-[isBlockEntity](./server.entity.isblockentity.md)
+[isModelEntity](./server.entity.ismodelentity.md)
 
 
 </td><td>
@@ -222,13 +224,13 @@ boolean
 
 </td><td>
 
-Whether the entity is a block entity.
+Whether the entity is a model entity.
 
 
 </td></tr>
 <tr><td>
 
-[isModelEntity](./server.entity.ismodelentity.md)
+[isSpawned](./server.entity.isspawned.md)
 
 
 </td><td>
@@ -243,13 +245,13 @@ boolean
 
 </td><td>
 
-Whether the entity is a model entity.
+Whether the entity is spawned.
 
 
 </td></tr>
 <tr><td>
 
-[isSpawned](./server.entity.isspawned.md)
+[modelAnimationsPlaybackRate](./server.entity.modelanimationsplaybackrate.md)
 
 
 </td><td>
@@ -259,12 +261,12 @@ Whether the entity is a model entity.
 
 </td><td>
 
-boolean
+number
 
 
 </td><td>
 
-Whether the entity is spawned.
+The playback rate of the entity's model animations.
 
 
 </td></tr>
@@ -605,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>
@@ -613,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;
+```

package/docs/server.entityeventpayload.setmodelanimationsplaybackrate.md

@@ -0,0 +1,70 @@
+<!-- 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)
+
+## EntityEventPayload.SetModelAnimationsPlaybackRate interface
+
+**Signature:**
+
+```typescript
+interface SetModelAnimationsPlaybackRate 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[entity](./server.entityeventpayload.setmodelanimationsplaybackrate.entity.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Entity](./server.entity.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[playbackRate](./server.entityeventpayload.setmodelanimationsplaybackrate.playbackrate.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.entityeventpayload.setmodelanimationsplaybackrate.playbackrate.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; [playbackRate](./server.entityeventpayload.setmodelanimationsplaybackrate.playbackrate.md)
+
+## EntityEventPayload.SetModelAnimationsPlaybackRate.playbackRate property
+
+**Signature:**
+
+```typescript
+playbackRate: number;
+```

package/docs/server.entityeventtype.md

@@ -43,6 +43,20 @@ DESPAWN
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+SET\_MODEL\_ANIMATIONS\_PLAYBACK\_RATE
+
+
+</td><td>
+
+`"ENTITY.SET_MODEL_ANIMATIONS_PLAYBACK_RATE"`
+
+
+</td><td>
+
+
 </td></tr>
 <tr><td>
 

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

package/docs/server.entityoptions.md

@@ -75,7 +75,7 @@ _(Optional)_ The texture uri of a entity if the entity is a block entity, if set
 </td></tr>
 <tr><td>
 
-[createCustomCharacterController?](./server.entityoptions.createcustomcharactercontroller.md)
+[controller?](./server.entityoptions.controller.md)
 
 
 </td><td>
@@ -83,12 +83,31 @@ _(Optional)_ The texture uri of a entity if the entity is a block entity, if set
 
 </td><td>
 
-(entity: [Entity](./server.entity.md)<!-- -->) =&gt; [BaseCharacterController](./server.basecharactercontroller.md)
+[BaseEntityController](./server.baseentitycontroller.md)
 
 
 </td><td>
 
-_(Optional)_ A function that creates a custom character controller for the entity when it spawns.
+_(Optional)_ The entity controller to use for the entity.
+
+
+</td></tr>
+<tr><td>
+
+[modelAnimationsPlaybackRate?](./server.entityoptions.modelanimationsplaybackrate.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The playback rate of the entity's model animations.
 
 
 </td></tr>

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

package/docs/server.facecallback.md

@@ -4,7 +4,7 @@
 
 ## FaceCallback type
 
-A callback function called when the entity associated with the SimpleCharacterController updates its rotation as it is attempting to face a target coordinate.
+A callback function called when the entity associated with the SimpleEntityController updates its rotation as it is attempting to face a target coordinate.
 
 **Signature:**
 

package/docs/server.facecompletecallback.md

@@ -4,7 +4,7 @@
 
 ## FaceCompleteCallback type
 
-A callback function called when the entity associated with the SimpleCharacterController finishes rotating and is now facing a target coordinate.
+A callback function called when the entity associated with the SimpleEntityController finishes rotating and is now facing a target coordinate.
 
 **Signature:**
 

package/docs/server.faceoptions.md

@@ -4,7 +4,7 @@
 
 ## FaceOptions type
 
-Options for the [SimpleCharacterController.face()](./server.simplecharactercontroller.face.md) method.
+Options for the [SimpleEntityController.face()](./server.simpleentitycontroller.face.md) method.
 
 **Signature:**
 

package/docs/server.md

@@ -126,17 +126,6 @@ Represents a collider in a world's physics simulation.
 A helper class for building and decoding collision groups.
 
 
-</td></tr>
-<tr><td>
-
-[DefaultCharacterController](./server.defaultcharactercontroller.md)
-
-
-</td><td>
-
-The default character controller implementation.
-
-
 </td></tr>
 <tr><td>
 
@@ -214,6 +203,17 @@ The camera for a Player.
 Represents an entity controlled by a player in a world.
 
 
+</td></tr>
+<tr><td>
+
+[PlayerEntityController](./server.playerentitycontroller.md)
+
+
+</td><td>
+
+The player entity controller implementation.
+
+
 </td></tr>
 <tr><td>
 
@@ -261,12 +261,12 @@ Represents a rigid body in a world's physics simulation.
 </td></tr>
 <tr><td>
 
-[SimpleCharacterController](./server.simplecharactercontroller.md)
+[SimpleEntityController](./server.simpleentitycontroller.md)
 
 
 </td><td>
 
-A simple character controller with basic movement functions.
+A simple entity controller with basic movement functions.
 
 
 </td></tr>
@@ -331,12 +331,12 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
-[BaseCharacterController](./server.basecharactercontroller.md)
+[BaseEntityController](./server.baseentitycontroller.md)
 
 
 </td><td>
 
-A base class for character controller implementations.
+A base class for entity controller implementations.
 
 
 </td></tr>
@@ -596,34 +596,34 @@ Options for creating a Collider instance.
 </td></tr>
 <tr><td>
 
-[DefaultCharacterControllerOptions](./server.defaultcharactercontrolleroptions.md)
+[EntityOptions](./server.entityoptions.md)
 
 
 </td><td>
 
-Options for creating a DefaultCharacterController instance.
+Options for creating an Entity instance.
 
 
 </td></tr>
 <tr><td>
 
-[EntityOptions](./server.entityoptions.md)
+[Event\_2](./server.event_2.md)
 
 
 </td><td>
 
-Options for creating an Entity instance.
+An EventRouter event.
 
 
 </td></tr>
 <tr><td>
 
-[Event\_2](./server.event_2.md)
+[PlayerEntityControllerOptions](./server.playerentitycontrolleroptions.md)
 
 
 </td><td>
 
-An EventRouter event.
+Options for creating a PlayerEntityController instance.
 
 
 </td></tr>
@@ -998,7 +998,7 @@ A decoded set of collision groups represented as their string equivalents.
 
 </td><td>
 
-A callback function called when the entity associated with the SimpleCharacterController updates its rotation as it is attempting to face a target coordinate.
+A callback function called when the entity associated with the SimpleEntityController updates its rotation as it is attempting to face a target coordinate.
 
 
 </td></tr>
@@ -1009,7 +1009,7 @@ A callback function called when the entity associated with the SimpleCharacterCo
 
 </td><td>
 
-A callback function called when the entity associated with the SimpleCharacterController finishes rotating and is now facing a target coordinate.
+A callback function called when the entity associated with the SimpleEntityController finishes rotating and is now facing a target coordinate.
 
 
 </td></tr>
@@ -1020,7 +1020,7 @@ A callback function called when the entity associated with the SimpleCharacterCo
 
 </td><td>
 
-Options for the [SimpleCharacterController.face()](./server.simplecharactercontroller.face.md) method.
+Options for the [SimpleEntityController.face()](./server.simpleentitycontroller.face.md) method.
 
 
 </td></tr>
@@ -1031,7 +1031,7 @@ Options for the [SimpleCharacterController.face()](./server.simplecharactercontr
 
 </td><td>
 
-A callback function called when the entity associated with the SimpleCharacterController updates its position as it is attempting to move to a target coordinate.
+A callback function called when the entity associated with the SimpleEntityController updates its position as it is attempting to move to a target coordinate.
 
 
 </td></tr>
@@ -1042,7 +1042,7 @@ A callback function called when the entity associated with the SimpleCharacterCo
 
 </td><td>
 
-A callback function called when the entity associated with the SimpleCharacterController reaches the target coordinate. An entity must reach the x,y,z coordinate for the callback to be called.
+A callback function called when the entity associated with the SimpleEntityController reaches the target coordinate. An entity must reach the x,y,z coordinate for the callback to be called.
 
 
 </td></tr>
@@ -1053,7 +1053,7 @@ A callback function called when the entity associated with the SimpleCharacterCo
 
 </td><td>
 
-Options for the [SimpleCharacterController.move()](./server.simplecharactercontroller.move.md) method.
+Options for the [SimpleEntityController.move()](./server.simpleentitycontroller.move.md) method.
 
 
 </td></tr>

package/docs/server.movecallback.md

@@ -4,7 +4,7 @@
 
 ## MoveCallback type
 
-A callback function called when the entity associated with the SimpleCharacterController updates its position as it is attempting to move to a target coordinate.
+A callback function called when the entity associated with the SimpleEntityController updates its position as it is attempting to move to a target coordinate.
 
 **Signature:**