Class RecastJSPlugin

constructor

• new RecastJSPlugin(recastInjection?: any): RecastJSPlugin

  Initializes the recastJS plugin

  Parameters

  • recastInjection: any = Recast

    can be used to inject your own recast reference

  Returns RecastJSPlugin

bjsRECAST

name

navMesh

timeFactor

• get timeFactor(): number

  Get the time factor used for crowd agent update

  Returns number

  the time factor

• set timeFactor(value: number): void

  Time factor applied when updating crowd agents (default 1). A value of 0 will pause crowd updates.

  Parameters

  • value: number

    the time factor applied at update

  Returns void

addBoxObstacle

• addBoxObstacle(
      position: Vector3,
      extent: Vector3,
      angle: number,
  ): Nullable<IObstacle>

  Creates an oriented box obstacle and add it to the navigation

  Parameters

  • position: Vector3

    world position

  • extent: Vector3

    box size

  • angle: number

    angle in radians of the box orientation on Y axis

  Returns Nullable<IObstacle>

  the obstacle freshly created

addCylinderObstacle

• addCylinderObstacle(
      position: Vector3,
      radius: number,
      height: number,
  ): Nullable<IObstacle>

  Creates a cylinder obstacle and add it to the navigation

  Parameters

  • position: Vector3

    world position

  • radius: number

    cylinder radius

  • height: number

    cylinder height

  Returns Nullable<IObstacle>

  the obstacle freshly created

buildFromNavmeshData

• buildFromNavmeshData(data: Uint8Array): void

  build the navmesh from a previously saved state using getNavmeshData

  Parameters

  • data: Uint8Array

    the Uint8Array returned by getNavmeshData

  Returns void

computePath

• computePath(start: Vector3, end: Vector3): Vector3[]

  Compute a navigation path from start to end. Returns an empty array if no path can be computed Path is straight.

  Parameters

  • start: Vector3

    world position

  • end: Vector3

    world position

  Returns Vector3[]

  array containing world position composing the path

computePathSmooth

• computePathSmooth(start: Vector3, end: Vector3): Vector3[]

  Compute a navigation path from start to end. Returns an empty array if no path can be computed. Path follows navigation mesh geometry.

  Parameters

  • start: Vector3

    world position

  • end: Vector3

    world position

  Returns Vector3[]

  array containing world position composing the path

createCrowd

• createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd

  Create a new Crowd so you can add agents

  Parameters

  • maxAgents: number

    the maximum agent count in the crowd

  • maxAgentRadius: number

    the maximum radius an agent can have

  • scene: Scene

    to attach the crowd to

  Returns ICrowd

  the crowd you can add agents to

createDebugNavMesh

• createDebugNavMesh(scene: Scene): Mesh

  Create a navigation mesh debug mesh

  Parameters

  • scene: Scene

    is where the mesh will be added

  Returns Mesh

  debug display mesh

createNavMesh

• createNavMesh(
      meshes: Mesh[],
      parameters: INavMeshParameters,
      completion?: (navmeshData: Uint8Array) => void,
  ): void

  Creates a navigation mesh

  Parameters

  • meshes: Mesh[]

    array of all the geometry used to compute the navigation mesh

  • parameters: INavMeshParameters

    bunch of parameters used to filter geometry

  • Optionalcompletion: (navmeshData: Uint8Array) => void

    callback when data is available from the worker. Not used without a worker

  Returns void

dispose

• dispose(): void

  Disposes of the plugin resources

  Returns void

getClosestPoint

• getClosestPoint(position: Vector3): Vector3

  Get a navigation mesh constrained position, closest to the parameter position

  Parameters

  • position: Vector3

    world position

  Returns Vector3

  the closest point to position constrained by the navigation mesh

getClosestPointToRef

• getClosestPointToRef(position: Vector3, result: Vector3): void

  Get a navigation mesh constrained position, closest to the parameter position

  Parameters

  • position: Vector3

    world position

  • result: Vector3

    output the closest point to position constrained by the navigation mesh

  Returns void

getDefaultQueryExtent

• getDefaultQueryExtent(): Vector3

  Get the Bounding box extent specified by setDefaultQueryExtent

  Returns Vector3

  the box extent values

getDefaultQueryExtentToRef

• getDefaultQueryExtentToRef(result: Vector3): void

  Get the Bounding box extent result specified by setDefaultQueryExtent

  Parameters

  • result: Vector3

    output the box extent values

  Returns void

getMaximumSubStepCount

• getMaximumSubStepCount(): number

  Get the maximum number of iterations per navigation tick update

  Returns number

  the maximum number of iterations

getNavmeshData

• getNavmeshData(): Uint8Array

  returns the navmesh data that can be used later. The navmesh must be built before retrieving the data

  Returns Uint8Array

  data the Uint8Array that can be saved and reused

getRandomPointAround

• getRandomPointAround(position: Vector3, maxRadius: number): Vector3

  Get a navigation mesh constrained position, within a particular radius

  Parameters

  • position: Vector3

    world position

  • maxRadius: number

    the maximum distance to the constrained world position

  Returns Vector3

  the closest point to position constrained by the navigation mesh

getRandomPointAroundToRef

• getRandomPointAroundToRef(
      position: Vector3,
      maxRadius: number,
      result: Vector3,
  ): void

  Get a navigation mesh constrained position, within a particular radius

  Parameters

  • position: Vector3

    world position

  • maxRadius: number

    the maximum distance to the constrained world position

  • result: Vector3

    output the closest point to position constrained by the navigation mesh

  Returns void

getRandomSeed

• getRandomSeed(): number

  Returns the seed used for randomized functions like getRandomPointAround

  Returns number

  seed number

getTimeStep

• getTimeStep(): number

  Get the time step of the navigation tick update.

  Returns number

  the current time step

isSupported

• isSupported(): boolean

  If this plugin is supported

  Returns boolean

  true if plugin is supported

moveAlong

• moveAlong(position: Vector3, destination: Vector3): Vector3

  Compute the final position from a segment made of destination-position

  Parameters

  • position: Vector3

    world position

  • destination: Vector3

    world position

  Returns Vector3

  the resulting point along the navmesh

moveAlongToRef

• moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void

  Compute the final position from a segment made of destination-position

  Parameters

  • position: Vector3

    world position

  • destination: Vector3

    world position

  • result: Vector3

    output the resulting point along the navmesh

  Returns void

removeObstacle

• removeObstacle(obstacle: IObstacle): void

  Removes an obstacle created by addCylinderObstacle or addBoxObstacle

  Parameters

  • obstacle: IObstacle

    obstacle to remove from the navigation

  Returns void

setDefaultQueryExtent

• setDefaultQueryExtent(extent: Vector3): void

  Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...) The queries will try to find a solution within those bounds default is (1,1,1)

  Parameters

  • extent: Vector3

    x,y,z value that define the extent around the queries point of reference

  Returns void

setMaximumSubStepCount

• setMaximumSubStepCount(newStepCount?: number): void

  If delta time in navigation tick update is greater than the time step a number of sub iterations are done. If more iterations are needed 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

  Parameters

  • newStepCount: number = 10

    the maximum number of iterations

  Returns void

setRandomSeed

• setRandomSeed(seed: number): void

  Set the seed used for randomized functions like getRandomPointAround

  Parameters

  • seed: number

    number used as seed for random functions

  Returns void

setTimeStep

• setTimeStep(newTimeStep?: number): void

  Set the time step of the navigation tick update. Default is 1/60. A value of 0 will disable fixed time update

  Parameters

  • newTimeStep: number = ...

    the new timestep to apply to this world.

  Returns void

setWorkerURL

• setWorkerURL(workerURL: string | URL): boolean

  Set worker URL to be used when generating a new navmesh

  Parameters

  • workerURL: string | URL

    url string

  Returns boolean

  boolean indicating if worker is created