@recast-navigation/core 0.23.0 → 0.24.0

package/dist/nav-mesh-query.d.ts

@@ -124,9 +124,12 @@ export declare class NavMeshQuery {
         posOverPoly: boolean;
     };
     /**
-     * Returns the closest point on the NavMesh to the given position.
+     * Finds the closest point on the NavMesh to the given position.
+     * @param position the position to find the closest point to
+     * @param options additional options
+     * @returns the result of the find closest point operation
      */
-    getClosestPoint(position: Vector3, options?: {
+    findClosestPoint(position: Vector3, options?: {
         /**
          * The polygon filter to apply to the query.
          * @default this.defaultFilter
@@ -137,11 +140,30 @@ export declare class NavMeshQuery {
          * @default this.defaultQueryHalfExtents
          */
         halfExtents?: Vector3;
-    }): Vector3;
+    }): {
+        success: boolean;
+        status: number;
+        polyRef: number;
+        point: {
+            x: number;
+            y: number;
+            z: number;
+        };
+        isPointOverPoly: boolean;
+    };
     /**
      * Returns a random point on the NavMesh within the given radius of the given position.
+     *
+     * @param position the center of the search circle
+     * @param radius the radius of the search circle
+     * @param options additional options
      */
-    getRandomPointAround(position: Vector3, radius: number, options?: {
+    findRandomPointAroundCircle(position: Vector3, radius: number, options?: {
+        /**
+         * The reference id of the polygon to start the search from.
+         * If not provided, the nearest polygon to the position will be used.
+         */
+        startRef?: number;
         /**
          * The polygon filter to apply to the query.
          * @default this.defaultFilter
@@ -152,13 +174,18 @@ export declare class NavMeshQuery {
          * @default this.defaultQueryHalfExtents
          */
         halfExtents?: Vector3;
-    }): Vector3;
+    }): {
+        success: boolean;
+        status: number;
+        randomPolyRef: number;
+        randomPoint: Vector3;
+    };
     /**
      * Moves from the start to the end position constrained to the navigation mesh.
      *
-     * @param startRef The reference id of the start polygon.
-     * @param startPosition A position of the mover within the start polygon.
-     * @param endPosition The desired end position of the mover.
+     * @param startRef the reference id of the start polygon.
+     * @param startPosition a position of the mover within the start polygon.
+     * @param endPosition the desired end position of the mover.
      *
      * @returns The result of the move along surface operation.
      */
@@ -207,8 +234,8 @@ export declare class NavMeshQuery {
     /**
      * Gets the height of the polygon at the provided position using the height detail.
      *
-     * @param polyRef The reference id of the polygon.
-     * @param position A position within the xz-bounds of the polygon.
+     * @param polyRef the reference id of the polygon.
+     * @param position a position within the xz-bounds of the polygon.
      */
     getPolyHeight(polyRef: number, position: Vector3): {
         success: boolean;
@@ -218,8 +245,9 @@ export declare class NavMeshQuery {
     /**
      * Finds a straight path from the start position to the end position.
      *
-     * @param start The start position.
-     * @param end The end position.
+     * @param start the start position
+     * @param end the end position
+     * @param options additional options
      *
      * @returns an array of Vector3 positions that make up the path, or an empty array if no path was found.
      */

package/package.json

@@ -6,7 +6,7 @@
     "email": "isaac@isaacmason.com",
     "url": "https://isaacmason.com/"
   },
-  "version": "0.23.0",
+  "version": "0.24.0",
   "license": "MIT",
   "homepage": "https://github.com/isaac-mason/recast-navigation-js",
   "bugs": {
@@ -26,7 +26,7 @@
     "lint": "eslint --ext .ts src"
   },
   "dependencies": {
-    "@recast-navigation/wasm": "0.23.0"
+    "@recast-navigation/wasm": "0.24.0"
   },
   "devDependencies": {
     "@babel/core": "^7.24.4",