recast-navigation 0.23.0 → 0.24.0

package/README.md

@@ -28,6 +28,7 @@ This library provides high level APIs that make it easy to get started creating
 ## Examples
 
 Go to the [examples website](https://recast-navigation-js.isaacmason.com) to see the project in action:
+
 - live: [https://recast-navigation-js.isaacmason.com](https://recast-navigation-js.isaacmason.com).
 - examples source code: [./packages/recast-navigation/.storybook/stories](./packages/recast-navigation/.storybook/stories).
 
@@ -161,26 +162,24 @@ import { NavMeshQuery } from 'recast-navigation';
 
 const navMeshQuery = new NavMeshQuery({ navMesh });
 
-/* get the closest point on the NavMesh to the given position */
+/* find the closest point on the NavMesh to the given position */
 const position = { x: 0, y: 0, z: 0 };
-navMeshQuery.getClosestPoint(position);
+const { success, status, point, polyRef, isPointOverPoly } =
+  navMeshQuery.findClosestPoint(position);
 
 /* get a random point around the given position */
 const radius = 0.5;
-navMeshQuery.getRandomPointAround(position, radius);
+const {
+  success,
+  status,
+  randomPolyRef,
+  randomPoint: initialAgentPosition,
+} = navMeshQuery.findRandomPointAroundCircle(position, radius);
 
 /* compute a straight path between two points */
-const computePathResult = navMeshQuery.computePath(
-  { x: 0, y: 0, z: 0 }, // start position
-  { x: 2, y: 0, z: 0 } // end position
-);
-
-if (!computePathResult.success) {
-  console.log(computePathResult.error);
-}
-
-const path = computePathResult.path; // { x: number, y: number, z: number }[]
-
+const start = { x: 0, y: 0, z: 0 };
+const end = { x: 2, y: 0, z: 0 };
+const { success, error, path } = navMeshQuery.computePath(start, end);
 ```
 
 ### Crowds and Agents
@@ -199,10 +198,15 @@ const crowd = new Crowd({ maxAgents, maxAgentRadius, navMesh });
 Next, create and interface with agents in the crowd.
 
 ```ts
-const initialAgentPosition = navMeshQuery.getRandomPointAround(
-  { x: 0, y: 0, z: 0 }, // position
-  2 // radius
-);
+const position = { x: 0, y: 0, z: 0 };
+const radius = 2;
+
+const {
+  success,
+  status,
+  randomPolyRef,
+  randomPoint: initialAgentPosition,
+} = navMeshQuery.findRandomPointAroundCircle(position, radius);
 
 const agent = crowd.addAgent(initialAgentPosition, {
   radius: 0.5,
@@ -275,7 +279,7 @@ const { success, navMesh, tileCache } = generateTileCache(positions, indices, {
 });
 ```
 
-You can use `addCylinderObstacle`, `addBoxObstacle`, and `removeObstacle` to add and remove obstacles from the TileCache. 
+You can use `addCylinderObstacle`, `addBoxObstacle`, and `removeObstacle` to add and remove obstacles from the TileCache.
 
 After adding or removing obstacles you can call `tileCache.update(navMesh)` to rebuild navmesh tiles.
 
@@ -314,7 +318,7 @@ const removeObstacleResult = tileCache.removeObstacle(boxObstacle);
 tileCache.update(navMesh);
 
 // if your obstacle requests affect many tiles, you may need to call update multiple times
-const maxTileCacheUpdates = 5
+const maxTileCacheUpdates = 5;
 for (let i = 0; i < maxTileCacheUpdates; i++) {
   const { upToDate } = tileCache.update(navMesh);
   if (upToDate) break;
@@ -416,7 +420,12 @@ console.log(statusToReadableString(status));
 If you need to work with status codes programmatically, you can use these utilities:
 
 ```ts
-import { statusSucceed, statusInProgress, statusFailed, statusDetail } from 'recast-navigation';
+import {
+  statusSucceed,
+  statusInProgress,
+  statusFailed,
+  statusDetail,
+} from 'recast-navigation';
 
 // returns true if the status is a success
 const succeeded = statusSucceed(status);

package/package.json

@@ -18,7 +18,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": {
@@ -66,9 +66,9 @@
     "lint": "eslint --ext .ts src"
   },
   "dependencies": {
-    "@recast-navigation/core": "0.23.0",
-    "@recast-navigation/generators": "0.23.0",
-    "@recast-navigation/three": "0.23.0"
+    "@recast-navigation/core": "0.24.0",
+    "@recast-navigation/generators": "0.24.0",
+    "@recast-navigation/three": "0.24.0"
   },
   "devDependencies": {
     "@babel/core": "^7.24.4",