@recast-navigation/core 0.0.4 → 0.0.6

package/dist/nav-mesh.d.ts

@@ -5,62 +5,97 @@ import type { BoxObstacle, CylinderObstacle, Obstacle, ObstacleRef } from './obs
 import type { NavPath, Vector3 } from './utils';
 export declare type NavMeshConfig = {
     /**
+     * The size of the non-navigable border around the heightfield.
+     * [Limit: >=0] [Units: vx]
      * @default 0
      */
     borderSize: number;
     /**
+     * The width/height size of tile's on the xz-plane.
+     * [Limit: >= 0] [Units: vx]
+     *
+     * If tileSize is provided, a tiled navmesh will be created.
+     * If tileSize is not provided, or is set to zero, a solo navmesh will be created.
+     *
+     * To use obstacles, a tiled navmesh must be generated.
      * @default 0
      */
     tileSize: number;
     /**
+     * The xz-plane cell size to use for fields.
+     * [Limit: > 0] [Units: wu]
      * @default 0.2
      */
     cs: number;
     /**
+     * The y-axis cell size to use for fields.
+     * Limit: > 0] [Units: wu]
      * @default 0.2
      */
     ch: number;
     /**
+     * The maximum slope that is considered walkable.
+     * [Limits: 0 <= value < 90] [Units: Degrees]
      * @default 60
      */
     walkableSlopeAngle: number;
     /**
+     * Minimum floor to 'ceiling' height that will still allow the floor area to be considered walkable.
+     * [Limit: >= 3] [Units: vx]
      * @default 2
      */
     walkableHeight: number;
     /**
+     * Maximum ledge height that is considered to still be traversable.
+     * [Limit: >=0] [Units: vx]
      * @default 2
      */
     walkableClimb: number;
     /**
+     * The distance to erode/shrink the walkable area of the heightfield away from obstructions.
+     * [Limit: >=0] [Units: vx]
      * @default 0.5
      */
     walkableRadius: number;
     /**
+     * The maximum allowed length for contour edges along the border of the mesh.
+     * [Limit: >=0] [Units: vx]
      * @default 12
      */
     maxEdgeLen: number;
     /**
+     * The maximum distance a simplfied contour's border edges should deviate the original raw contour.
+     * [Limit: >=0] [Units: vx]
      * @default 1.3
      */
     maxSimplificationError: number;
     /**
+     * The minimum number of cells allowed to form isolated island areas.
+     * [Limit: >=0] [Units: vx]
      * @default 8
      */
     minRegionArea: number;
     /**
+     * Any regions with a span count smaller than this value will, if possible, be merged with larger regions.
+     * [Limit: >=0] [Units: vx]
      * @default 20
      */
     mergeRegionArea: number;
     /**
+     * The maximum number of vertices allowed for polygons generated during the be merged with larger regions.
+     * [Limit: >=0] [Units: vx]
      * @default 6
      */
     maxVertsPerPoly: number;
     /**
+     * Sets the sampling distance to use when generating the detail mesh. (For height detail only.)
+     * [Limits: 0 or >= 0.9] [Units: wu]
      * @default 6
      */
     detailSampleDist: number;
     /**
+     * The maximum distance the detail mesh surface should deviate from heightfield data. (For height detail only.)
+     * [Limit: >=0] [Units: wu]
      * @default 1
      */
     detailSampleMaxError: number;
@@ -69,8 +104,21 @@ export declare class NavMesh {
     raw: R.NavMesh;
     obstacles: Map<ObstacleRef, Obstacle>;
     constructor();
+    /**
+     * Updates the NavMesh tile cache by rebuilding tiles touched by unfinished obstacle requests.
+     * This should be called after adding or removing obstacles.
+     */
     update(): void;
+    /**
+     * Destroys the NavMesh.
+     */
     destroy(): void;
+    /**
+     * Builds a NavMesh from the given positions and indices.
+     * @param positions a flat array of positions
+     * @param indices a flat array of indices
+     * @param navMeshConfig optional configuration for the NavMesh
+     */
     build(positions: ArrayLike<number>, indices: ArrayLike<number>, navMeshConfig?: Partial<NavMeshConfig>): void;
     /**
      * Build the navmesh from a previously saved state using getNavMeshData
@@ -82,15 +130,49 @@ export declare class NavMesh {
      * @returns data the Uint8Array that can be saved and reused
      */
     getNavMeshData(): Uint8Array;
+    /**
+     * Returns a DebugNavMesh that can be used to visualize the NavMesh.
+     */
     getDebugNavMesh(): DebugNavMesh;
+    /**
+     * Returns the closest point on the NavMesh to the given position.
+     */
     getClosestPoint(position: Vector3): Vector3;
+    /**
+     * Returns a random point on the NavMesh within the given radius of the given position.
+     */
     getRandomPointAround(position: Vector3, radius: number): Vector3;
+    /**
+     * Compute the final position from a segment made of destination-position
+     */
     moveAlong(position: Vector3, destination: Vector3): Vector3;
+    /**
+     * Finds a path from the start position to the end position.
+     *
+     * @returns an array of Vector3 positions that make up the path, or an empty array if no path was found.
+     */
     computePath(start: Vector3, end: Vector3): NavPath;
+    /**
+     * Gets the Bounding box extent specified by setDefaultQueryExtent
+     */
     getDefaultQueryExtent(): Vector3;
+    /**
+     * Sets the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
+     * The queries will try to find a solution within those bounds.
+     * The default is (1,1,1)
+     */
     setDefaultQueryExtent(extent: Vector3): void;
+    /**
+     * Creates a cylinder obstacle and adds it to the navigation mesh.
+     */
     addCylinderObstacle(position: Vector3, radius: number, height: number): CylinderObstacle;
+    /**
+     * Creates a box obstacle and adds it to the navigation mesh.
+     */
     addBoxObstacle(position: Vector3, extent: Vector3, angle: number): BoxObstacle;
+    /**
+     * Removes an obstacle from the navigation mesh.
+     */
     removeObstacle(obstacle: Obstacle | ObstacleRef): void;
     createCrowd(config: {
         maxAgents: number;

package/package.json

@@ -6,7 +6,7 @@
     "email": "isaac@isaacmason.com",
     "url": "https://isaacmason.com/"
   },
-  "version": "0.0.4",
+  "version": "0.0.6",
   "license": "MIT",
   "homepage": "https://github.com/isaac-mason/recast-navigation-js",
   "bugs": {
@@ -26,7 +26,7 @@
   },
   "devDependencies": {
     "@babel/core": "^7.18.6",
-    "@recast-navigation/wasm": "0.0.4",
+    "@recast-navigation/wasm": "0.0.6",
     "@rollup/plugin-commonjs": "^24.0.1",
     "@rollup/plugin-node-resolve": "^15.0.1",
     "@rollup/plugin-terser": "^0.4.0",