hytopia 0.1.26 → 0.1.29

package/docs/server.hytopia.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; [HYTOPIA](./server.hytopia.md) &gt; [SimpleCharacterController](./server.hytopia.simplecharactercontroller.md)
+
+## HYTOPIA.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.hytopia.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.hytopia.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.hytopia.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; [HYTOPIA](./server.hytopia.md) &gt; [SimpleCharacterController](./server.hytopia.simplecharactercontroller.md) &gt; [move](./server.hytopia.simplecharactercontroller.move.md)
+
+## HYTOPIA.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.hytopia.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; [HYTOPIA](./server.hytopia.md) &gt; [WorldLoopEventPayload](./server.hytopia.worldloopeventpayload.md)
+
+## HYTOPIA.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.hytopia.worldloopeventpayload.start.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[Stop](./server.hytopia.worldloopeventpayload.stop.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[TickEnd](./server.hytopia.worldloopeventpayload.tickend.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[TickError](./server.hytopia.worldloopeventpayload.tickerror.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[TickStart](./server.hytopia.worldloopeventpayload.tickstart.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

package/docs/server.hytopia.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; [HYTOPIA](./server.hytopia.md) &gt; [WorldLoopEventPayload](./server.hytopia.worldloopeventpayload.md) &gt; [Start](./server.hytopia.worldloopeventpayload.start.md)
+
+## HYTOPIA.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.hytopia.worldloopeventpayload.start.worldloop.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[WorldLoop](./server.worldloop.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>

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

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

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

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

package/docs/server.hytopia.worldloopeventpayload.tickend.tickdurationms.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; [HYTOPIA](./server.hytopia.md) &gt; [WorldLoopEventPayload](./server.hytopia.worldloopeventpayload.md) &gt; [TickEnd](./server.hytopia.worldloopeventpayload.tickend.md) &gt; [tickDurationMs](./server.hytopia.worldloopeventpayload.tickend.tickdurationms.md)
+
+## HYTOPIA.WorldLoopEventPayload.TickEnd.tickDurationMs property
+
+**Signature:**
+
+```typescript
+tickDurationMs: number;
+```

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

package/docs/server.hytopia.worldloopeventpayload.tickerror.error.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; [HYTOPIA](./server.hytopia.md) &gt; [WorldLoopEventPayload](./server.hytopia.worldloopeventpayload.md) &gt; [TickError](./server.hytopia.worldloopeventpayload.tickerror.md) &gt; [error](./server.hytopia.worldloopeventpayload.tickerror.error.md)
+
+## HYTOPIA.WorldLoopEventPayload.TickError.error property
+
+**Signature:**
+
+```typescript
+error: Error;
+```

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

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

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

package/docs/server.hytopia.worldloopeventpayload.tickstart.tickdeltams.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; [HYTOPIA](./server.hytopia.md) &gt; [WorldLoopEventPayload](./server.hytopia.worldloopeventpayload.md) &gt; [TickStart](./server.hytopia.worldloopeventpayload.tickstart.md) &gt; [tickDeltaMs](./server.hytopia.worldloopeventpayload.tickstart.tickdeltams.md)
+
+## HYTOPIA.WorldLoopEventPayload.TickStart.tickDeltaMs property
+
+**Signature:**
+
+```typescript
+tickDeltaMs: number;
+```

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