hytopia 0.1.56 → 0.1.57

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>
 
-[characterController?](./server.entityoptions.charactercontroller.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>
 
-[BaseCharacterController](./server.basecharactercontroller.md)
+[BaseEntityController](./server.baseentitycontroller.md)
 
 
 </td><td>
 
-_(Optional)_ The character controller to use for the entity.
+_(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:**
 

package/docs/server.movecompletecallback.md

@@ -4,7 +4,7 @@
 
 ## MoveCompleteCallback type
 
-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.
 
 **Signature:**
 

package/docs/server.moveoptions.md

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

package/docs/server.playerentity.md

@@ -15,7 +15,7 @@ export default class PlayerEntity extends Entity
 
 ## Remarks
 
-Player entities extend the [Entity](./server.entity.md) class. They can be created and assigned to a player when a player joins a world. PlayerEntity automatically handles mapping player inputs to the associated character controller of the entity, calling the character controller's onTickPlayerMovement method when player input has changed.
+Player entities extend the [Entity](./server.entity.md) class. They can be created and assigned to a player when a player joins a world. PlayerEntity automatically handles mapping player inputs to the associated entity controller of the entity, calling the entity controller's onTickPlayerMovement method when player input has changed.
 
 ## Example
 

package/docs/server.playerentitycontroller._constructor_.md

@@ -0,0 +1,49 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntityController](./server.playerentitycontroller.md) &gt; [(constructor)](./server.playerentitycontroller._constructor_.md)
+
+## PlayerEntityController.(constructor)
+
+Constructs a new instance of the `PlayerEntityController` class
+
+**Signature:**
+
+```typescript
+constructor(options?: PlayerEntityControllerOptions);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+[PlayerEntityControllerOptions](./server.playerentitycontrolleroptions.md)
+
+
+</td><td>
+
+_(Optional)_ Options for the controller.
+
+
+</td></tr>
+</tbody></table>

package/docs/{server.defaultcharactercontroller.attach.md → server.playerentitycontroller.attach.md}

@@ -1,8 +1,8 @@
 <!-- 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; [attach](./server.defaultcharactercontroller.attach.md)
+[Home](./index.md) &gt; [server](./server.md) &gt; [PlayerEntityController](./server.playerentitycontroller.md) &gt; [attach](./server.playerentitycontroller.attach.md)
 
-## DefaultCharacterController.attach() method
+## PlayerEntityController.attach() method
 
 Called when the controller is attached to an entity.
 

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

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

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

package/docs/server.playerentitycontroller.isgrounded.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; [PlayerEntityController](./server.playerentitycontroller.md) &gt; [isGrounded](./server.playerentitycontroller.isgrounded.md)
+
+## PlayerEntityController.isGrounded property
+
+Whether the entity is grounded.
+
+**Signature:**
+
+```typescript
+get isGrounded(): boolean;
+```

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