recast-navigation 0.10.0 → 0.10.2

package/README.md

@@ -21,7 +21,7 @@
 
 **recast-navigation-js** is a WebAssembly port of [the Recast and Detour libraries](https://github.com/recastnavigation/recastnavigation). Recast is a state of the art navigation mesh construction toolset for games, and Detour is a path-finding and spatial reasoning toolkit.
 
-This library provides high level APIs that make it easy to get started creating navigation meshes, querying them, and simulating crowds. It also provides lower-level APIs that give you fine-grained control over the navmesh generation process. 
+This library provides high level APIs that make it easy to get started creating navigation meshes, querying them, and simulating crowds. It also provides lower-level APIs that give you fine-grained control over the navmesh generation process.
 
 > **Warning** This library is still in early development. Versions in the 0.x.x range may have breaking changes.
 
@@ -230,6 +230,33 @@ tileCache.removeObstacle(boxObstacle);
 tileCache.removeObstacle(cylinderObstacle);
 ```
 
+### Off Mesh Connections
+
+Off mesh connections are user-defined connections between two points on a NavMesh. You can use them to create things like ladders, teleporters, jump pads, etc.
+
+Off mesh connections can be bidirectional or unidirectional.
+
+You can provide list of off mesh connections to the high level generator functions.
+
+```ts
+const { success, navMesh } = generateSoloNavMesh(positions, indices, {
+  // ...
+  offMeshConnections: [
+    {
+      startPosition: { x: 0, y: 5, z: 0 },
+      endPosition: { x: 2, y: 0, z: 0 },
+      radius: 0.5,
+      bidirectional: false,
+      area: 0,
+      flags: 1,
+      userId: 0, // optional
+    },
+  ],
+});
+```
+
+You can use `agent.state()` to determine if an agent is currently traversing an off mesh connection.
+
 ### Debugging
 
 You can use `getDebugNavMesh` to get a debug representation of the NavMesh.

package/package.json

@@ -18,7 +18,7 @@
     "email": "isaac@isaacmason.com",
     "url": "https://isaacmason.com/"
   },
-  "version": "0.10.0",
+  "version": "0.10.2",
   "license": "MIT",
   "homepage": "https://github.com/isaac-mason/recast-navigation-js",
   "bugs": {
@@ -56,8 +56,8 @@
     "build-storybook": "storybook build"
   },
   "dependencies": {
-    "@recast-navigation/core": "0.10.0",
-    "@recast-navigation/three": "0.10.0"
+    "@recast-navigation/core": "0.10.2",
+    "@recast-navigation/three": "0.10.2"
   },
   "devDependencies": {
     "@babel/core": "^7.22.11",