hytopia 0.1.96 → 0.1.97

package/docs/server.md

@@ -203,6 +203,17 @@ Manages Light instances in a world.
 Manages model data for all known models of the game.
 
 
+</td></tr>
+<tr><td>
+
+[PathfindingEntityController](./server.pathfindingentitycontroller.md)
+
+
+</td><td>
+
+A pathfinding entity controller built on top of [SimpleEntityController](./server.simpleentitycontroller.md)<!-- -->.
+
+
 </td></tr>
 <tr><td>
 
@@ -1144,6 +1155,39 @@ A callback function called when the entity associated with the SimpleEntityContr
 Options for the [SimpleEntityController.move()](./server.simpleentitycontroller.move.md) method.
 
 
+</td></tr>
+<tr><td>
+
+[PathfindAbortCallback](./server.pathfindabortcallback.md)
+
+
+</td><td>
+
+A callback function called when the pathfinding algorithm aborts.
+
+
+</td></tr>
+<tr><td>
+
+[PathfindCompleteCallback](./server.pathfindcompletecallback.md)
+
+
+</td><td>
+
+A callback function called when the entity associated with the PathfindingEntityController finishes pathfinding and is now at the target coordinate.
+
+
+</td></tr>
+<tr><td>
+
+[PathfindingOptions](./server.pathfindingoptions.md)
+
+
+</td><td>
+
+Options for the [PathfindingEntityController.pathfind()](./server.pathfindingentitycontroller.pathfind.md) method.
+
+
 </td></tr>
 <tr><td>
 
@@ -1210,5 +1254,27 @@ Options for raycasting.
 Additional mass properties for a RigidBody.
 
 
+</td></tr>
+<tr><td>
+
+[WaypointMoveCompleteCallback](./server.waypointmovecompletecallback.md)
+
+
+</td><td>
+
+A callback function called when the entity associated with the PathfindingEntityController finishes moving to a calculate waypoint of its current path.
+
+
+</td></tr>
+<tr><td>
+
+[WaypointMoveSkippedCallback](./server.waypointmoveskippedcallback.md)
+
+
+</td><td>
+
+A callback function called when the entity associated with the PathfindingEntityController skips a waypoint because it took too long to reach.
+
+
 </td></tr>
 </tbody></table>

package/docs/server.pathfindabortcallback.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; [PathfindAbortCallback](./server.pathfindabortcallback.md)
+
+## PathfindAbortCallback type
+
+A callback function called when the pathfinding algorithm aborts.
+
+**Signature:**
+
+```typescript
+export type PathfindAbortCallback = () => void;
+```

package/docs/server.pathfindcompletecallback.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; [PathfindCompleteCallback](./server.pathfindcompletecallback.md)
+
+## PathfindCompleteCallback type
+
+A callback function called when the entity associated with the PathfindingEntityController finishes pathfinding and is now at the target coordinate.
+
+**Signature:**
+
+```typescript
+export type PathfindCompleteCallback = () => void;
+```

package/docs/server.pathfindingentitycontroller.debug.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; [PathfindingEntityController](./server.pathfindingentitycontroller.md) &gt; [debug](./server.pathfindingentitycontroller.debug.md)
+
+## PathfindingEntityController.debug property
+
+Whether to enable debug mode or not. When debug mode is enabled, the pathfinding algorithm will log debug information to the console. Defaults to false.
+
+**Signature:**
+
+```typescript
+get debug(): boolean;
+```

package/docs/server.pathfindingentitycontroller.maxfall.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; [PathfindingEntityController](./server.pathfindingentitycontroller.md) &gt; [maxFall](./server.pathfindingentitycontroller.maxfall.md)
+
+## PathfindingEntityController.maxFall property
+
+The maximum fall distance the entity can fall.
+
+**Signature:**
+
+```typescript
+get maxFall(): number;
+```

package/docs/server.pathfindingentitycontroller.maxjump.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; [PathfindingEntityController](./server.pathfindingentitycontroller.md) &gt; [maxJump](./server.pathfindingentitycontroller.maxjump.md)
+
+## PathfindingEntityController.maxJump property
+
+The maximum jump distance the entity can jump.
+
+**Signature:**
+
+```typescript
+get maxJump(): number;
+```

package/docs/server.pathfindingentitycontroller.maxopensetiterations.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; [PathfindingEntityController](./server.pathfindingentitycontroller.md) &gt; [maxOpenSetIterations](./server.pathfindingentitycontroller.maxopensetiterations.md)
+
+## PathfindingEntityController.maxOpenSetIterations property
+
+The maximum number of open set iterations that can be processed before aborting pathfinding. Defaults to 200.
+
+**Signature:**
+
+```typescript
+get maxOpenSetIterations(): number;
+```

package/docs/server.pathfindingentitycontroller.md

@@ -0,0 +1,287 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PathfindingEntityController](./server.pathfindingentitycontroller.md)
+
+## PathfindingEntityController class
+
+A pathfinding entity controller built on top of [SimpleEntityController](./server.simpleentitycontroller.md)<!-- -->.
+
+**Signature:**
+
+```typescript
+export default class PathfindingEntityController extends SimpleEntityController 
+```
+**Extends:** [SimpleEntityController](./server.simpleentitycontroller.md)
+
+## Remarks
+
+This class implements pathfinding using the A\* algorithm. Pathfinding when frequently called can cause performance issues, use it sparingly. The .pathfind() method should only need to be called once in nearly all cases when attempting to move an entity to a target coordinate.
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[debug](./server.pathfindingentitycontroller.debug.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether to enable debug mode or not. When debug mode is enabled, the pathfinding algorithm will log debug information to the console. Defaults to false.
+
+
+</td></tr>
+<tr><td>
+
+[maxFall](./server.pathfindingentitycontroller.maxfall.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The maximum fall distance the entity can fall.
+
+
+</td></tr>
+<tr><td>
+
+[maxJump](./server.pathfindingentitycontroller.maxjump.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The maximum jump distance the entity can jump.
+
+
+</td></tr>
+<tr><td>
+
+[maxOpenSetIterations](./server.pathfindingentitycontroller.maxopensetiterations.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The maximum number of open set iterations that can be processed before aborting pathfinding. Defaults to 200.
+
+
+</td></tr>
+<tr><td>
+
+[speed](./server.pathfindingentitycontroller.speed.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The speed of the entity.
+
+
+</td></tr>
+<tr><td>
+
+[target](./server.pathfindingentitycontroller.target.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md) \| undefined
+
+
+</td><td>
+
+The target coordinate to pathfind to.
+
+
+</td></tr>
+<tr><td>
+
+[verticalPenalty](./server.pathfindingentitycontroller.verticalpenalty.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The vertical penalty for the pathfinding algorithm. A higher value will prefer paths with less vertical movement.
+
+
+</td></tr>
+<tr><td>
+
+[waypointNextIndex](./server.pathfindingentitycontroller.waypointnextindex.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The index representing the next waypoint moving towards of the current set of waypoints being followed.
+
+
+</td></tr>
+<tr><td>
+
+[waypoints](./server.pathfindingentitycontroller.waypoints.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)<!-- -->\[\]
+
+
+</td><td>
+
+The current waypoints being followed.
+
+
+</td></tr>
+<tr><td>
+
+[waypointTimeoutMs](./server.pathfindingentitycontroller.waypointtimeoutms.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The timeout in milliseconds for a waypoint to be considered reached. Defaults to 2000ms divided by the speed of the entity.
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[pathfind(target, speed, options)](./server.pathfindingentitycontroller.pathfind.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Calculate a path and move to the target if a path is found. Returns true if a path is found, false if no path is found.
+
+
+</td></tr>
+</tbody></table>

package/docs/server.pathfindingentitycontroller.pathfind.md

@@ -0,0 +1,87 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PathfindingEntityController](./server.pathfindingentitycontroller.md) &gt; [pathfind](./server.pathfindingentitycontroller.pathfind.md)
+
+## PathfindingEntityController.pathfind() method
+
+Calculate a path and move to the target if a path is found. Returns true if a path is found, false if no path is found.
+
+**Signature:**
+
+```typescript
+pathfind(target: Vector3Like, speed: number, options?: PathfindingOptions): boolean;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+target
+
+
+</td><td>
+
+[Vector3Like](./server.vector3like.md)
+
+
+</td><td>
+
+The target coordinate to pathfind to.
+
+
+</td></tr>
+<tr><td>
+
+speed
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The speed of the entity.
+
+
+</td></tr>
+<tr><td>
+
+options
+
+
+</td><td>
+
+[PathfindingOptions](./server.pathfindingoptions.md)
+
+
+</td><td>
+
+_(Optional)_ The pathfinding options.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+boolean
+
+Whether the path was found.
+

package/docs/server.pathfindingentitycontroller.speed.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; [PathfindingEntityController](./server.pathfindingentitycontroller.md) &gt; [speed](./server.pathfindingentitycontroller.speed.md)
+
+## PathfindingEntityController.speed property
+
+The speed of the entity.
+
+**Signature:**
+
+```typescript
+get speed(): number;
+```

package/docs/server.pathfindingentitycontroller.target.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; [PathfindingEntityController](./server.pathfindingentitycontroller.md) &gt; [target](./server.pathfindingentitycontroller.target.md)
+
+## PathfindingEntityController.target property
+
+The target coordinate to pathfind to.
+
+**Signature:**
+
+```typescript
+get target(): Vector3Like | undefined;
+```

package/docs/server.pathfindingentitycontroller.verticalpenalty.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; [PathfindingEntityController](./server.pathfindingentitycontroller.md) &gt; [verticalPenalty](./server.pathfindingentitycontroller.verticalpenalty.md)
+
+## PathfindingEntityController.verticalPenalty property
+
+The vertical penalty for the pathfinding algorithm. A higher value will prefer paths with less vertical movement.
+
+**Signature:**
+
+```typescript
+get verticalPenalty(): number;
+```

package/docs/server.pathfindingentitycontroller.waypointnextindex.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; [PathfindingEntityController](./server.pathfindingentitycontroller.md) &gt; [waypointNextIndex](./server.pathfindingentitycontroller.waypointnextindex.md)
+
+## PathfindingEntityController.waypointNextIndex property
+
+The index representing the next waypoint moving towards of the current set of waypoints being followed.
+
+**Signature:**
+
+```typescript
+get waypointNextIndex(): number;
+```

package/docs/server.pathfindingentitycontroller.waypoints.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; [PathfindingEntityController](./server.pathfindingentitycontroller.md) &gt; [waypoints](./server.pathfindingentitycontroller.waypoints.md)
+
+## PathfindingEntityController.waypoints property
+
+The current waypoints being followed.
+
+**Signature:**
+
+```typescript
+get waypoints(): Vector3Like[];
+```

package/docs/server.pathfindingentitycontroller.waypointtimeoutms.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; [PathfindingEntityController](./server.pathfindingentitycontroller.md) &gt; [waypointTimeoutMs](./server.pathfindingentitycontroller.waypointtimeoutms.md)
+
+## PathfindingEntityController.waypointTimeoutMs property
+
+The timeout in milliseconds for a waypoint to be considered reached. Defaults to 2000ms divided by the speed of the entity.
+
+**Signature:**
+
+```typescript
+get waypointTimeoutMs(): number;
+```

package/docs/server.pathfindingoptions.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [server](./server.md) &gt; [PathfindingOptions](./server.pathfindingoptions.md)
+
+## PathfindingOptions type
+
+Options for the [PathfindingEntityController.pathfind()](./server.pathfindingentitycontroller.pathfind.md) method.
+
+**Signature:**
+
+```typescript
+export type PathfindingOptions = {
+    debug?: boolean;
+    maxFall?: number;
+    maxJump?: number;
+    maxOpenSetIterations?: number;
+    pathfindAbortCallback?: PathfindAbortCallback;
+    pathfindCompleteCallback?: PathfindCompleteCallback;
+    verticalPenalty?: number;
+    waypointMoveCompleteCallback?: WaypointMoveCompleteCallback;
+    waypointMoveSkippedCallback?: WaypointMoveSkippedCallback;
+    waypointTimeoutMs?: number;
+};
+```
+**References:** [PathfindAbortCallback](./server.pathfindabortcallback.md)<!-- -->, [PathfindCompleteCallback](./server.pathfindcompletecallback.md)<!-- -->, [WaypointMoveCompleteCallback](./server.waypointmovecompletecallback.md)<!-- -->, [WaypointMoveSkippedCallback](./server.waypointmoveskippedcallback.md)
+

package/docs/server.playerentitycontroller.autocancelmouseleftclick.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; [autoCancelMouseLeftClick](./server.playerentitycontroller.autocancelmouseleftclick.md)
+
+## PlayerEntityController.autoCancelMouseLeftClick property
+
+Whether to automatically cancel left click input after first processed tick, defaults to true.
+
+**Signature:**
+
+```typescript
+autoCancelMouseLeftClick: boolean;
+```

package/docs/server.playerentitycontroller.md

@@ -91,6 +91,25 @@ Description
 </th></tr></thead>
 <tbody><tr><td>
 
+[autoCancelMouseLeftClick](./server.playerentitycontroller.autocancelmouseleftclick.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Whether to automatically cancel left click input after first processed tick, defaults to true.
+
+
+</td></tr>
+<tr><td>
+
 [canJump](./server.playerentitycontroller.canjump.md)