@recast-navigation/core 0.0.5 → 0.0.6

package/dist/crowd.d.ts

@@ -2,68 +2,96 @@ import type R from '@recast-navigation/wasm';
 import type { NavMesh } from './nav-mesh';
 import type { NavPath, Vector3 } from './utils';
 export declare type CrowdParams = {
+    /**
+     * The maximum number of agents that can be managed by the crowd.
+     * [Limit: >= 1]
+     */
     maxAgents: number;
+    /**
+     * The maximum radius of any agent that will be added to the crowd.
+     * [Limit: > 0]
+     */
     maxAgentRadius: number;
+    /**
+     * The navigation mesh to use for planning.
+     */
     navMesh: NavMesh;
 };
 export declare type CrowdAgentParams = {
     /**
+     * The radius of the agent.
      * @default 0.5
      */
     radius: number;
     /**
+     * The height of the agent.
      * @default 1
      */
     height: number;
     /**
+     * The maximum allowed acceleration for the agent.
      * @default 20
      */
     maxAcceleration: number;
     /**
+     * The maximum allowed speed for the agent.
      * @default 6
      */
     maxSpeed: number;
     /**
+     * Defines how close a collision element must be before it is considered for steering behaviors.
+     * [Limits: > 0]
      * @default 2.5
      */
     collisionQueryRange: number;
     /**
+     * The path visibility optimization range.
+     * [Limit: > 0]
      * @default 0
      */
     pathOptimizationRange: number;
     /**
+     * How aggresive the agent manager should be at avoiding collisions with this agent.
+     * [Limit: >= 0]
      * @default 0
      */
     separationWeight: number;
     /**
+     * Flags that impact steering behavior.
      * @default 7
      */
     updateFlags: number;
     /**
+     * The index of the avoidance configuration to use for the agent.
+     * [Limits: 0 <= value <= #DT_CROWD_MAX_OBSTAVOIDANCE_PARAMS]
      * @default 0
      */
     obstacleAvoidanceType: number;
     /**
+     * The index of the query filter used by this agent.
      * @default 0
      */
     queryFilterType: number;
     /**
+     * User defined data attached to the agent.
      * @default 0
      */
     userData: unknown;
 };
 export declare class Crowd {
     raw: R.Crowd;
+    /**
+     * The indices of the active agents in the crowd.
+     */
     agents: number[];
     /**
-     * The NavMesh the crowd is interacting with
+     * The NavMesh the crowd is interacting with.
      */
     navMesh: NavMesh;
     /**
-     * If delta time in navigation tick update is greater than the time step
-     * a number of sub iterations are done. If more iterations are need to reach deltatime
-     * they will be discarded.
-     * A value of 0 will set to no maximum and update will use as many substeps as needed
+     * If delta time in navigation tick update is greater than the time step a number of sub iterations are done.
+     * If more iterations are need to reach deltatime they will be discarded.
+     * A value of 0 will set to no maximum and update will use as many substeps as needed.
      */
     maximumSubStepCount: number;
     /**
@@ -75,12 +103,33 @@ export declare class Crowd {
      */
     timeFactor: number;
     constructor({ maxAgents, maxAgentRadius, navMesh }: CrowdParams);
+    /**
+     * Adds a new agent to the crowd.
+     */
     addAgent(position: Vector3, crowdAgentParams: Partial<CrowdAgentParams>): number;
+    /**
+     * Removes the agent from the crowd.
+     */
     removeAgent(agentIndex: number): void;
+    /**
+     * Submits a new move request for the specified agent.
+     */
     goto(agentIndex: number, position: Vector3): void;
+    /**
+     * Teleports the agent to the given position.
+     */
     teleport(agentIndex: number, position: Vector3): void;
+    /**
+     * Resets the current move request for the specified agent.
+     */
     resetMoveTarget(agentIndex: number): void;
+    /**
+     * Updates the crowd
+     */
     update(deltaTime: number): void;
+    /**
+     * Destroys the crowd.
+     */
     destroy(): void;
     /**
      * Returns the maximum number of agents that can be managed by the crowd.
@@ -90,15 +139,60 @@ export declare class Crowd {
      * Returns the number of active agents in the crowd.
      */
     getActiveAgentCount(): number;
+    /**
+     * Returns the indices of all active agents.
+     */
     getAgents(): number[];
+    /**
+     * Returns the position of the specified agent.
+     */
     getAgentPosition(agentIndex: number): Vector3;
+    /**
+     * Returns the velocity of the specified agent.
+     */
     getAgentVelocity(agentIndex: number): Vector3;
+    /**
+     * Returns the next target position on the path to the specified agents target.
+     */
     getAgentNextTargetPath(agentIndex: number): Vector3;
+    /**
+     * Returns the state of the specified agent.
+     *
+     * 0 = DT_CROWDAGENT_STATE_INVALID
+     * 1 = DT_CROWDAGENT_STATE_WALKING
+     * 2 = DT_CROWDAGENT_STATE_OFFMESH
+     */
     getAgentState(agentIndex: number): number;
+    /**
+     * Returns the local path corridor corners for the specified agent.
+     */
     getAgentCorners(agentIndex: number): NavPath;
+    /**
+     * Returns the parameters for the specified agent.
+     */
     getAgentParameters(agentIndex: number): CrowdAgentParams;
+    /**
+     * Sets the parameters for the specified agent.
+     * Any parameters not specified in the crowdAgentParams object will be set to their default values.
+     * @param agentIndex
+     * @param crowdAgentParams
+     */
     setAgentParameters(agentIndex: number, crowdAgentParams: Partial<CrowdAgentParams>): void;
+    /**
+     * Updates the parameters for the specified agent.
+     * Any parameters not specified in the crowdAgentParams object will be unchanged.
+     * @param agentIndex
+     * @param crowdAgentParams
+     */
     updateAgentParameters(agentIndex: number, crowdAgentParams: Partial<CrowdAgentParams>): void;
+    /**
+     * Gets the bounding box extent for doing spatial queries.
+     */
     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;
 }