hytopia 0.1.96 → 0.1.98

package/server.api.json

@@ -17451,6 +17451,544 @@
             "endIndex": 6
           }
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "server!PathfindAbortCallback:type",
+          "docComment": "/**\n * A callback function called when the pathfinding algorithm aborts.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type PathfindAbortCallback = "
+            },
+            {
+              "kind": "Content",
+              "text": "() => void"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/world/entities/controllers/PathfindingEntityController.ts",
+          "releaseTag": "Public",
+          "name": "PathfindAbortCallback",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "server!PathfindCompleteCallback:type",
+          "docComment": "/**\n * A callback function called when the entity associated with the PathfindingEntityController finishes pathfinding and is now at the target coordinate.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type PathfindCompleteCallback = "
+            },
+            {
+              "kind": "Content",
+              "text": "() => void"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/world/entities/controllers/PathfindingEntityController.ts",
+          "releaseTag": "Public",
+          "name": "PathfindCompleteCallback",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
+        {
+          "kind": "Class",
+          "canonicalReference": "server!PathfindingEntityController:class",
+          "docComment": "/**\n * A pathfinding entity controller built on top of {@link SimpleEntityController}.\n *\n * @remarks\n *\n * 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.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export default class PathfindingEntityController extends "
+            },
+            {
+              "kind": "Reference",
+              "text": "SimpleEntityController",
+              "canonicalReference": "server!SimpleEntityController:class"
+            },
+            {
+              "kind": "Content",
+              "text": " "
+            }
+          ],
+          "fileUrlPath": "src/world/entities/controllers/PathfindingEntityController.ts",
+          "releaseTag": "Public",
+          "isAbstract": false,
+          "name": "PathfindingEntityController",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "Property",
+              "canonicalReference": "server!PathfindingEntityController#debug:member",
+              "docComment": "/**\n * 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.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get debug(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "debug",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!PathfindingEntityController#maxFall:member",
+              "docComment": "/**\n * The maximum fall distance the entity can fall.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get maxFall(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "maxFall",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!PathfindingEntityController#maxJump:member",
+              "docComment": "/**\n * The maximum jump distance the entity can jump.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get maxJump(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "maxJump",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!PathfindingEntityController#maxOpenSetIterations:member",
+              "docComment": "/**\n * The maximum number of open set iterations that can be processed before aborting pathfinding. Defaults to 200.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get maxOpenSetIterations(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "maxOpenSetIterations",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!PathfindingEntityController#pathfind:member(1)",
+              "docComment": "/**\n * 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.\n *\n * @param target - The target coordinate to pathfind to.\n *\n * @param speed - The speed of the entity.\n *\n * @param options - The pathfinding options.\n *\n * @returns Whether the path was found.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "pathfind(target: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Vector3Like",
+                  "canonicalReference": "server!Vector3Like:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", speed: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", options?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "PathfindingOptions",
+                  "canonicalReference": "server!PathfindingOptions:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 7,
+                "endIndex": 8
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "target",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "speed",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "options",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 5,
+                    "endIndex": 6
+                  },
+                  "isOptional": true
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "pathfind"
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!PathfindingEntityController#speed:member",
+              "docComment": "/**\n * The speed of the entity.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get speed(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "speed",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!PathfindingEntityController#target:member",
+              "docComment": "/**\n * The target coordinate to pathfind to.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get target(): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Vector3Like",
+                  "canonicalReference": "server!Vector3Like:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | undefined"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "target",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!PathfindingEntityController#verticalPenalty:member",
+              "docComment": "/**\n * The vertical penalty for the pathfinding algorithm. A higher value will prefer paths with less vertical movement.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get verticalPenalty(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "verticalPenalty",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!PathfindingEntityController#waypointNextIndex:member",
+              "docComment": "/**\n * The index representing the next waypoint moving towards of the current set of waypoints being followed.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get waypointNextIndex(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "waypointNextIndex",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!PathfindingEntityController#waypoints:member",
+              "docComment": "/**\n * The current waypoints being followed.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get waypoints(): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Vector3Like",
+                  "canonicalReference": "server!Vector3Like:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "waypoints",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!PathfindingEntityController#waypointTimeoutMs:member",
+              "docComment": "/**\n * The timeout in milliseconds for a waypoint to be considered reached. Defaults to 2000ms divided by the speed of the entity.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "get waypointTimeoutMs(): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "waypointTimeoutMs",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            }
+          ],
+          "extendsTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "implementsTokenRanges": []
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "server!PathfindingOptions:type",
+          "docComment": "/**\n * Options for the {@link PathfindingEntityController.pathfind} method.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type PathfindingOptions = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    debug?: boolean;\n    maxFall?: number;\n    maxJump?: number;\n    maxOpenSetIterations?: number;\n    pathfindAbortCallback?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "PathfindAbortCallback",
+              "canonicalReference": "server!PathfindAbortCallback:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    pathfindCompleteCallback?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "PathfindCompleteCallback",
+              "canonicalReference": "server!PathfindCompleteCallback:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    verticalPenalty?: number;\n    waypointMoveCompleteCallback?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "WaypointMoveCompleteCallback",
+              "canonicalReference": "server!WaypointMoveCompleteCallback:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    waypointMoveSkippedCallback?: "
+            },
+            {
+              "kind": "Reference",
+              "text": "WaypointMoveSkippedCallback",
+              "canonicalReference": "server!WaypointMoveSkippedCallback:type"
+            },
+            {
+              "kind": "Content",
+              "text": ";\n    waypointTimeoutMs?: number;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/world/entities/controllers/PathfindingEntityController.ts",
+          "releaseTag": "Public",
+          "name": "PathfindingOptions",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 10
+          }
+        },
         {
           "kind": "Class",
           "canonicalReference": "server!Player:class",
@@ -20444,6 +20982,36 @@
               "isAbstract": false,
               "name": "attach"
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "server!PlayerEntityController#autoCancelMouseLeftClick:member",
+              "docComment": "/**\n * Whether to automatically cancel left click input after first processed tick, defaults to true.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "autoCancelMouseLeftClick: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "autoCancelMouseLeftClick",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Property",
               "canonicalReference": "server!PlayerEntityController#canJump:member",
@@ -21096,6 +21664,33 @@
           "name": "PlayerEntityControllerOptions",
           "preserveMemberOrder": false,
           "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "server!PlayerEntityControllerOptions#autoCancelMouseLeftClick:member",
+              "docComment": "/**\n * Whether to automatically cancel left click input after first processed tick, defaults to true.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "autoCancelMouseLeftClick?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "autoCancelMouseLeftClick",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
             {
               "kind": "PropertySignature",
               "canonicalReference": "server!PlayerEntityControllerOptions#canJump:member",
@@ -29502,6 +30097,54 @@
               "isAbstract": false,
               "name": "face"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "server!SimpleEntityController#jump:member(1)",
+              "docComment": "/**\n * Applies an upwards impulse to the entity to simulate a jump, only supported for entities with dynamic rigid body types.\n *\n * @param height - The height to jump to.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "jump(height: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "height",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "jump"
+            },
             {
               "kind": "Method",
               "canonicalReference": "server!SimpleEntityController#move:member(1)",
@@ -31813,6 +32456,76 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "server!WaypointMoveCompleteCallback:type",
+          "docComment": "/**\n * A callback function called when the entity associated with the PathfindingEntityController finishes moving to a calculate waypoint of its current path.\n *\n * @param waypoint - The waypoint that the entity has finished moving to.\n *\n * @param waypointIndex - The index of the waypoint that the entity has finished moving to.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type WaypointMoveCompleteCallback = "
+            },
+            {
+              "kind": "Content",
+              "text": "(waypoint: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Vector3Like",
+              "canonicalReference": "server!Vector3Like:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", waypointIndex: number) => void"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/world/entities/controllers/PathfindingEntityController.ts",
+          "releaseTag": "Public",
+          "name": "WaypointMoveCompleteCallback",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 4
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "server!WaypointMoveSkippedCallback:type",
+          "docComment": "/**\n * A callback function called when the entity associated with the PathfindingEntityController skips a waypoint because it took too long to reach.\n *\n * @param waypoint - The waypoint that the entity skipped.\n *\n * @param waypointIndex - The index of the waypoint that the entity skipped.\n *\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type WaypointMoveSkippedCallback = "
+            },
+            {
+              "kind": "Content",
+              "text": "(waypoint: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Vector3Like",
+              "canonicalReference": "server!Vector3Like:interface"
+            },
+            {
+              "kind": "Content",
+              "text": ", waypointIndex: number) => void"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/world/entities/controllers/PathfindingEntityController.ts",
+          "releaseTag": "Public",
+          "name": "WaypointMoveSkippedCallback",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 4
+          }
+        },
         {
           "kind": "Class",
           "canonicalReference": "server!World:class",