hytopia 0.1.26 → 0.1.29

package/docs/server.hytopia.worldloopeventtype.md

@@ -0,0 +1,103 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [HYTOPIA](./server.hytopia.md) &gt; [WorldLoopEventType](./server.hytopia.worldloopeventtype.md)
+
+## HYTOPIA.WorldLoopEventType enum
+
+Event types a WorldLoop instance can emit.
+
+**Signature:**
+
+```typescript
+export declare enum WorldLoopEventType 
+```
+
+## Enumeration Members
+
+<table><thead><tr><th>
+
+Member
+
+
+</th><th>
+
+Value
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+START
+
+
+</td><td>
+
+`"WORLD_LOOP.START"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+STOP
+
+
+</td><td>
+
+`"WORLD_LOOP.STOP"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+TICK\_END
+
+
+</td><td>
+
+`"WORLD_LOOP.TICK_END"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+TICK\_ERROR
+
+
+</td><td>
+
+`"WORLD_LOOP.TICK_ERROR"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+TICK\_START
+
+
+</td><td>
+
+`"WORLD_LOOP.TICK_START"`
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.md

@@ -225,6 +225,17 @@ Manages all connected players in a game server.
 Represents a rigid body in a world's physics simulation.
 
 
+</td></tr>
+<tr><td>
+
+[SimpleCharacterController](./server.simplecharactercontroller.md)
+
+
+</td><td>
+
+A simple character controller with basic movement functions.
+
+
 </td></tr>
 <tr><td>
 
@@ -420,6 +431,17 @@ Event types a Player can emit.
 The types a RigidBody can be.
 
 
+</td></tr>
+<tr><td>
+
+[WorldLoopEventType](./server.worldloopeventtype.md)
+
+
+</td><td>
+
+Event types a WorldLoop instance can emit.
+
+
 </td></tr>
 </tbody></table>
 
@@ -716,6 +738,17 @@ Payloads for events emitted by a GameServer instance.
 Payloads for events a Player can emit.
 
 
+</td></tr>
+<tr><td>
+
+[WorldLoopEventPayload](./server.worldloopeventpayload.md)
+
+
+</td><td>
+
+Payloads for events emitted by a WorldLoop instance.
+
+
 </td></tr>
 </tbody></table>
 
@@ -823,6 +856,72 @@ A callback function for a chat command.
 A decoded set of collision groups represented as their string equivalents.
 
 
+</td></tr>
+<tr><td>
+
+[FaceCallback](./server.facecallback.md)
+
+
+</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.
+
+
+</td></tr>
+<tr><td>
+
+[FaceCompleteCallback](./server.facecompletecallback.md)
+
+
+</td><td>
+
+A callback function called when the entity associated with the SimpleCharacterController finishes rotating and is now facing a target coordinate.
+
+
+</td></tr>
+<tr><td>
+
+[FaceOptions](./server.faceoptions.md)
+
+
+</td><td>
+
+Options for the [SimpleCharacterController.face()](./server.simplecharactercontroller.face.md) method.
+
+
+</td></tr>
+<tr><td>
+
+[MoveCallback](./server.movecallback.md)
+
+
+</td><td>
+
+A callback function called when the entity associated with the SimpleCharacterController updates its translation as it is attempting to move to a target coordinate.
+
+
+</td></tr>
+<tr><td>
+
+[MoveCompleteCallback](./server.movecompletecallback.md)
+
+
+</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.
+
+
+</td></tr>
+<tr><td>
+
+[MoveOptions](./server.moveoptions.md)
+
+
+</td><td>
+
+Options for the [SimpleCharacterController.move()](./server.simplecharactercontroller.move.md) method.
+
+
 </td></tr>
 <tr><td>
 

package/docs/server.movecallback.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [MoveCallback](./server.movecallback.md)
+
+## MoveCallback type
+
+A callback function called when the entity associated with the SimpleCharacterController updates its translation as it is attempting to move to a target coordinate.
+
+**Signature:**
+
+```typescript
+export type MoveCallback = (currentTranslation: Vector3, targetTranslation: Vector3) => void;
+```
+**References:** [Vector3](./server.vector3.md)
+

package/docs/server.movecompletecallback.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [MoveCompleteCallback](./server.movecompletecallback.md)
+
+## 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.
+
+**Signature:**
+
+```typescript
+export type MoveCompleteCallback = (endTranslation: Vector3) => void;
+```
+**References:** [Vector3](./server.vector3.md)
+

package/docs/server.moveoptions.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [MoveOptions](./server.moveoptions.md)
+
+## MoveOptions type
+
+Options for the [SimpleCharacterController.move()](./server.simplecharactercontroller.move.md) method.
+
+**Signature:**
+
+```typescript
+export type MoveOptions = {
+    moveCallback?: MoveCallback;
+    moveCompleteCallback?: MoveCompleteCallback;
+};
+```
+**References:** [MoveCallback](./server.movecallback.md)<!-- -->, [MoveCompleteCallback](./server.movecompletecallback.md)
+

package/docs/server.simplecharactercontroller.face.md

@@ -0,0 +1,89 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [SimpleCharacterController](./server.simplecharactercontroller.md) &gt; [face](./server.simplecharactercontroller.face.md)
+
+## SimpleCharacterController.face() method
+
+Rotates the entity at a given speed to face a target coordinate.
+
+**Signature:**
+
+```typescript
+face(target: Vector3, speed: number, options?: FaceOptions): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+target
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+The target coordinate to face.
+
+
+</td></tr>
+<tr><td>
+
+speed
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The speed at which to rotate to the target coordinate.
+
+
+</td></tr>
+<tr><td>
+
+options
+
+
+</td><td>
+
+[FaceOptions](./server.faceoptions.md)
+
+
+</td><td>
+
+_(Optional)_ Additional options for the face operation, such as callbacks.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+
+## Remarks
+
+If this method is called while the entity is already attempting to face another target, the previous target will be ignored and the entity will start attempting to face the new target.
+

package/docs/server.simplecharactercontroller.md

@@ -0,0 +1,88 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [SimpleCharacterController](./server.simplecharactercontroller.md)
+
+## SimpleCharacterController class
+
+A simple character controller with basic movement functions.
+
+**Signature:**
+
+```typescript
+export default class SimpleCharacterController extends BaseCharacterController 
+```
+**Extends:** [BaseCharacterController](./server.basecharactercontroller.md)
+
+## Remarks
+
+This class implements simple movement methods that serve as a way to add realistic movement and rotational facing functionality to an entity. This is also a great base to extend for your own more complex character controller that implements things like pathfinding.
+
+## Example
+
+
+```typescript
+// Create a custom character controller for myEntity, prior to spawning it.
+myEntity.createCustomCharacterController = () => {
+  return new SimpleCharacterController(myEntity);
+};
+
+// Spawn the entity in the world.
+myEntity.spawn(world, { x: 53, y: 10, z: 23 });
+
+// Move the entity at a speed of 4 blocks
+// per second to the coordinate (10, 1, 10).
+// console.log when we reach the target.
+myEntity.characterController.move({ x: 10, y: 1, z: 10 }, 4, {
+  moveCompleteCallback: endPosition => {
+    console.log('Finished moving to', endPosition);
+  },
+});
+```
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[face(target, speed, options)](./server.simplecharactercontroller.face.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Rotates the entity at a given speed to face a target coordinate.
+
+
+</td></tr>
+<tr><td>
+
+[move(target, speed, options)](./server.simplecharactercontroller.move.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Moves the entity at a given speed in a straight line to a target coordinate.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.simplecharactercontroller.move.md

@@ -0,0 +1,89 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [SimpleCharacterController](./server.simplecharactercontroller.md) &gt; [move](./server.simplecharactercontroller.move.md)
+
+## SimpleCharacterController.move() method
+
+Moves the entity at a given speed in a straight line to a target coordinate.
+
+**Signature:**
+
+```typescript
+move(target: Vector3, speed: number, options?: MoveOptions): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+target
+
+
+</td><td>
+
+[Vector3](./server.vector3.md)
+
+
+</td><td>
+
+The target coordinate to move to.
+
+
+</td></tr>
+<tr><td>
+
+speed
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The speed at which to move to the target coordinate.
+
+
+</td></tr>
+<tr><td>
+
+options
+
+
+</td><td>
+
+[MoveOptions](./server.moveoptions.md)
+
+
+</td><td>
+
+_(Optional)_ Additional options for the move operation, such as callbacks.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+
+## Remarks
+
+If this method is called while the entity is already attempting to move to another target, the previous target will be ignored and the entity will start attempting to move to the new target.
+

package/docs/server.worldloopeventpayload.md

@@ -0,0 +1,73 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [WorldLoopEventPayload](./server.worldloopeventpayload.md)
+
+## WorldLoopEventPayload namespace
+
+Payloads for events emitted by a WorldLoop instance.
+
+**Signature:**
+
+```typescript
+export declare namespace WorldLoopEventPayload 
+```
+
+## Interfaces
+
+<table><thead><tr><th>
+
+Interface
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[Start](./server.worldloopeventpayload.start.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[Stop](./server.worldloopeventpayload.stop.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[TickEnd](./server.worldloopeventpayload.tickend.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[TickError](./server.worldloopeventpayload.tickerror.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[TickStart](./server.worldloopeventpayload.tickstart.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.worldloopeventpayload.start.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; [WorldLoopEventPayload](./server.worldloopeventpayload.md) &gt; [Start](./server.worldloopeventpayload.start.md)
+
+## WorldLoopEventPayload.Start interface
+
+**Signature:**
+
+```typescript
+interface Start 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[worldLoop](./server.worldloopeventpayload.start.worldloop.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[WorldLoop](./server.worldloop.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.worldloopeventpayload.start.worldloop.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; [WorldLoopEventPayload](./server.worldloopeventpayload.md) &gt; [Start](./server.worldloopeventpayload.start.md) &gt; [worldLoop](./server.worldloopeventpayload.start.worldloop.md)
+
+## WorldLoopEventPayload.Start.worldLoop property
+
+**Signature:**
+
+```typescript
+worldLoop: WorldLoop;
+```