Class TileCache

constructor

• new TileCache(): TileCache

• Constructs a new TileCache

  Returns TileCache
• new TileCache(raw): TileCache

• Creates a wrapper around a raw TileCache object

  Parameters

  • raw: RawModule.TileCache

    raw object

  Returns TileCache

obstacles

raw

addBoxObstacle

• addBoxObstacle(position, halfExtents, angle): AddObstacleResult<BoxObstacle>

• Creates a box obstacle and adds it to the navigation mesh.

  Parameters

  • position: Vector3
  • halfExtents: Vector3
  • angle: number

  Returns AddObstacleResult<BoxObstacle>

addCylinderObstacle

• addCylinderObstacle(position, radius, height): AddObstacleResult<CylinderObstacle>

• Creates a cylinder obstacle and adds it to the navigation mesh.

  Parameters

  • position: Vector3
  • radius: number
  • height: number

  Returns AddObstacleResult<CylinderObstacle>

addTile

• addTile(data, flags?): TileCacheAddTileResult

• Parameters

  • data: UnsignedCharArray
  • Optional flags: number

  Returns TileCacheAddTileResult

buildNavMeshTile

• buildNavMeshTile(ref, navMesh): number

• Parameters

  • ref: dtCompressedTileRef
  • navMesh: NavMesh

  Returns number

buildNavMeshTilesAt

• buildNavMeshTilesAt(tx, ty, navMesh): number

• Parameters

  • tx: number
  • ty: number
  • navMesh: NavMesh

  Returns number

destroy

• destroy(): void

• Returns void

init

• init(params, alloc, compressor, meshProcess): boolean

• Initialises the TileCache

  Parameters

  • params: DetourTileCacheParams
  • alloc: RecastLinearAllocator
  • compressor: RecastFastLZCompressor
  • meshProcess: TileCacheMeshProcess

  Returns boolean

removeObstacle

• removeObstacle(obstacle): RemoveObstacleResult

• Removes an obstacle from the navigation mesh.

  Parameters

  • obstacle: dtObstacleRef | Obstacle

  Returns RemoveObstacleResult

update

• update(navMesh): TileCacheUpdateResult

• Updates the tile cache by rebuilding tiles touched by unfinished obstacle requests.

  After adding or removing obstacles you can call tileCache.update(navMesh) to rebuild navmesh tiles.

  Adding or removing an obstacle will internally create an "obstacle request". TileCache supports queuing up to 64 obstacle requests.

  The tileCache.update method returns upToDate, whether the tile cache is fully up to date with obstacle requests and tile rebuilds. Each update call processes up to 64 tiles touched by added or removed obstacles. If the tile cache isn't up to date another call will continue processing obstacle requests and tile rebuilds; otherwise it will have no effect.

  If not many obstacle requests occur between updates, an easy pattern is to call tileCache.update periodically, such as every game update. If many obstacle requests have been made and you need to avoid reaching the 64 obstacle request limit, you can call tileCache.update multiple times, bailing out when upToDate is true or after a maximum number of updates.

  Parameters

  • navMesh: NavMesh

  Returns TileCacheUpdateResult

  Example

  const { success, status, upToDate } = tileCache.update(navMesh);
  Copy