Class NavMesh

constructor

• new NavMesh(): NavMesh

  Constructs a new NavMesh

  Returns NavMesh

• new NavMesh(raw: RawModule.NavMesh): NavMesh

  Creates a wrapper around a raw NavMesh object

  Parameters

  • raw: RawModule.NavMesh

    raw object

  Returns NavMesh

raw

addTile

• addTile(
      navMeshData: UnsignedCharArray,
      flags: number,
      lastRef: number,
  ): { status: number; tileRef: number }

  Adds a tile to the NavMesh.

  Parameters

  • navMeshData: UnsignedCharArray

    the nav mesh data

  • flags: number

    the flags to use when building the nav mesh

  • lastRef: number

  Returns { status: number; tileRef: number }

  the status of the operation and the reference of the added tile

calcTileLoc

• calcTileLoc(pos: Vector3): NavMeshCalcTileLocResult

  Calculates the tile grid location for the specified world position.

  Parameters

  • pos: Vector3

    The world position for the query. [(x, y, z)]

  Returns NavMeshCalcTileLocResult

decodePolyId

• decodePolyId(polyRef: number): NavMeshDecodePolyIdResult

  Decodes a standard polygon reference.

  Parameters

  • polyRef: number

    The polygon reference to decode

  Returns NavMeshDecodePolyIdResult

  the decoded polygon reference

destroy

• destroy(): void

  Destroys the NavMesh.

  Returns void

encodePolyId

• encodePolyId(salt: number, tileIndex: number, tilePolygonIndex: number): number

  Derives a standard polygon reference.

  Parameters

  • salt: number

    The tile's salt value.

  • tileIndex: number

    The index of the tile. it in the C++ api.

  • tilePolygonIndex: number

    The index of the polygon within the tile. ip in the C++ api.

  Returns number

  the derived polygon reference

getMaxTiles

• getMaxTiles(): number

  Returns the maximum number of tiles supported by the navigation mesh.

  Returns number

getOffMeshConnectionByRef

• getOffMeshConnectionByRef(ref: number): DetourOffMeshConnection

  Gets the specified off-mesh connection.

  Parameters

  • ref: number

    The polygon reference of the off-mesh connection.

  Returns DetourOffMeshConnection

getOffMeshConnectionPolyEndPoints

• getOffMeshConnectionPolyEndPoints(
      prevRef: number,
      polyRef: number,
  ): {
      end: { x: number; y: number; z: number };
      start: { x: number; y: number; z: number };
      status: number;
      success: boolean;
  }

  Gets the endpoints for an off-mesh connection, ordered by "direction of travel".

  Parameters

  • prevRef: number

    The reference of the polygon before the connection.

  • polyRef: number

    The reference of the off-mesh connection polygon.

  Returns {
      end: { x: number; y: number; z: number };
      start: { x: number; y: number; z: number };
      status: number;
      success: boolean;
  }

getPolyArea

• getPolyArea(ref: number): { area: number; status: number }

  Gets the user defined area for the specified polygon.

  Parameters

  • ref: number

    The polygon reference.

  Returns { area: number; status: number }

getPolyFlags

• getPolyFlags(ref: number): { flags: number; status: number }

  Gets the user defined flags for the specified polygon.

  Parameters

  • ref: number

    The polygon reference.

  Returns { flags: number; status: number }

getPolyRefBase

• getPolyRefBase(tile: DetourMeshTile): number

  Gets the polygon reference for the tile's base polygon.

  Parameters

  • tile: DetourMeshTile

  Returns number

getTile

• getTile(i: number): DetourMeshTile

  Gets the tile at the specified index.

  Parameters

  • i: number

    the tile index. [Limit: 0 >= index < #getMaxTiles()]

  Returns DetourMeshTile

getTileAndPolyByRef

• getTileAndPolyByRef(
      ref: number,
  ): {
      poly: DetourPoly;
      status: number;
      success: boolean;
      tile: DetourMeshTile;
  }

  Gets the tile and polygon for the specified polygon reference.

  Parameters

  • ref: number

    The reference for the a polygon.

  Returns { poly: DetourPoly; status: number; success: boolean; tile: DetourMeshTile }

getTileAndPolyByRefUnsafe

• getTileAndPolyByRefUnsafe(
      ref: number,
  ): { poly: DetourPoly; tile: DetourMeshTile }

  Gets the tile and polygon for the specified polygon reference.

  Parameters

  • ref: number

    A known valid reference for a polygon.

  Returns { poly: DetourPoly; tile: DetourMeshTile }

getTileAt

• getTileAt(x: number, y: number, layer: number): DetourMeshTile | null

  Gets the tile at the specified grid location.

  Parameters

  • x: number

    The tile's x-location. (x, y, layer)

  • y: number

    The tile's y-location. (x, y, layer)

  • layer: number

    The tile's layer. (x, y, layer)

  Returns DetourMeshTile | null

  The tile, or null if the tile does not exist.

getTileByRef

• getTileByRef(ref: number): DetourMeshTile | null

  Gets the tile for the specified tile reference.

  Parameters

  • ref: number

    The tile reference of the tile to retrieve.

  Returns DetourMeshTile | null

  The tile for the specified reference, or null if the reference is invalid.

getTileRef

• getTileRef(tile: DetourMeshTile): number

  Gets the tile reference for the specified tile.

  Parameters

  • tile: DetourMeshTile

  Returns number

getTileRefAt

• getTileRefAt(x: number, y: number, layer: number): number

  Gets the tile reference for the tile at specified grid location.

  Parameters

  • x: number

    The tile's x-location. (x, y, layer)

  • y: number

    The tile's y-location. (x, y, layer)

  • layer: number

    The tile's layer. (x, y, layer)

  Returns number

  The tile reference of the tile, or 0 if there is none.

getTilesAt

• getTilesAt(x: number, y: number, maxTiles: number): NavMeshGetTilesAtResult

  Gets all tiles at the specified grid location. (All layers.)

  Parameters

  • x: number

    The tile's x-location. (x, y)

  • y: number

    The tile's y-location. (x, y)

  • maxTiles: number

    The maximum tiles the tiles parameter can hold.

  Returns NavMeshGetTilesAtResult

getTileStateSize

• getTileStateSize(tile: DetourMeshTile): number

  Gets the size of the buffer required by #storeTileState to store the specified tile's state.

  Parameters

  • tile: DetourMeshTile

  Returns number

  The size of the buffer required to store the state.

initSolo

• initSolo(navMeshData: UnsignedCharArray): boolean

  Initializes the NavMesh for use with a single tile.

  Parameters

  • navMeshData: UnsignedCharArray

    the nav mesh data

  Returns boolean

  the status of the operation

initTiled

• initTiled(params: NavMeshParams): boolean

  Initializes the NavMesh for use with multiple tiles.

  Parameters

  • params: NavMeshParams

    parameters for the NavMesh

  Returns boolean

  the status of the operation

isValidPolyRef

• isValidPolyRef(ref: number): boolean

  Checks the validity of a polygon reference.

  Parameters

  • ref: number

  Returns boolean

removeTile

• removeTile(ref: number): NavMeshRemoveTileResult

  Removes a tile from the NavMesh

  Parameters

  • ref: number

    the tile ref

  Returns NavMeshRemoveTileResult

  the nav mesh data, so it can be added back later

restoreTileState

• restoreTileState(
      tile: DetourMeshTile,
      data: number[],
      maxDataSize: number,
  ): number

  Restores the state of the tile.

  Parameters

  • tile: DetourMeshTile

    The tile.

  • data: number[]

    The new state. (Obtained from

  • maxDataSize: number

    The size of the state within the data buffer.

  Returns number

  See

  storeTileState)

setPolyArea

• setPolyArea(ref: number, area: number): number

  Sets the user defined area for the specified polygon.

  Parameters

  • ref: number

    The polygon reference.

  • area: number

  Returns number

setPolyFlags

• setPolyFlags(ref: number, flags: number): number

  Sets the user defined flags for the specified polygon.

  Parameters

  • ref: number

    The polygon reference.

  • flags: number

    The new flags for the polygon.

  Returns number

storeTileState

• storeTileState(
      tile: DetourMeshTile,
      maxDataSize: number,
  ): NavMeshStoreTileStateResult

  Stores the non-structural state of the tile in the specified buffer. (Flags, area ids, etc.)

  Parameters

  • tile: DetourMeshTile

    The tile.

  • maxDataSize: number

    The size of the data buffer. [Limit: >= #getTileStateSize]

  Returns NavMeshStoreTileStateResult