Melonity Docs

GridNav ​

The GridNav namespace provides helpers for traversability checks and pathfinding queries.

Interfaces ​

PathInfo ​

The PathInfo interface describes the corresponding object shape exposed by the declarations.

  • hasPathboolean - The has path.
  • pathVector[] - The path.

Functions ​

IsTraversable(pos: Vector, noTreeMode?: boolean)boolean ​

Checks whether it is traversable.

  • posVector - The world position value.
  • noTreeModeboolean (optional) - Whether trees should be ignored during the query.

Returned:

  • boolean - True if the condition is met, false otherwise.

FindPath(start: Vector, end: Vector, noTreeMode?: boolean, allowIncomplete?: boolean)PathInfo ​

Finds the path.

  • startVector - The start position.
  • endVector - The end position.
  • noTreeModeboolean (optional) - Whether trees should be ignored during the query.
  • allowIncompleteboolean (optional) - Whether incomplete paths are allowed.

Returned:

  • PathInfo - The result of the call.