Class: PathFinder

Constructor

new PathFinder(source)

Parameters:

Name	Type	Description
`source`	TileCollisionLayer \| Vector2	Either a TileCollisionLayer (size and walkability auto-derived) or a Vector2 grid size (user overrides isWalkable).

Source: plugins/pathFinder.js, line 89

Example

// Tile-layer driven (most common):
 const pf = new PathFinder(myTileCollisionLayer);
 const path = pf.findPath(player.pos, mousePos);

 // Bare grid with custom walkability:
 const pf = new PathFinder(vec2(50, 50));
 pf.isWalkable = (x, y) => myGrid[y*50 + x] === 0;

Members

debug

Properties

Type	Description
boolean	If true, draw debug visualization during findPath

Source: plugins/pathFinder.js, line 128

debugTime

Properties

Type	Description
number	Debug primitive lifetime in seconds (0 disables drawing)

Source: plugins/pathFinder.js, line 130

heuristicWeight

Properties

Type	Description
number	A* heuristic multiplier (1 = admissible, higher = greedier)

Source: plugins/pathFinder.js, line 117

maxLoop :number|undefined

Type:

number | undefined

Properties

Type	Description
number \| undefined	Most A* expansions before giving up, undefined for the number of cells, so a search always finishes; a lower one caps the time a search takes, see searchGaveUp

Source: plugins/pathFinder.js, line 121

nodes :Array.<PathFinderNode>

Type:

Array.<PathFinderNode>

Properties

Type	Description
Array.<PathFinderNode>	Flat row-major array of size.x*size.y nodes

Source: plugins/pathFinder.js, line 134

searchGaveUp

Properties

Type	Description
boolean	True when the last search stopped at maxLoop with no path, so it gave up rather than that there is no way through

Source: plugins/pathFinder.js, line 124

size :Vector2

Type:

Vector2

Properties

Type	Description
Vector2	Grid dimensions in tiles

Source: plugins/pathFinder.js, line 101

smoothPath

Properties

Type	Description
boolean	If true, post-process paths with two-pass smoothing

Source: plugins/pathFinder.js, line 126

tileLayer :TileCollisionLayer|undefined

Type:

TileCollisionLayer | undefined

Properties

Type	Description
TileCollisionLayer \| undefined	Tile layer driving walkability, if any

Source: plugins/pathFinder.js, line 104

Methods

buildNodeData()

Reset all nodes and re-populate walkable / cost / posWorld from the current isWalkable / getCost overrides. Called at the start of findPath; call it directly before searches made with rebuild=false.

Source: plugins/pathFinder.js, line 211

findPath(startPos, endPos, rebuildopt) → {Array.<Vector2>}

Find a path from startPos to endPos in world space. Returns an array of world-space Vector2 points; empty array if no path exists.

Start and end are snapped to the nearest walkable tile (a costed one counts), within 10 tiles. Intermediate points are tile centers unless the string-pulling smoothing pass moves them off-grid.

By default, calls buildNodeData() first, which asks isWalkable and getCost about every cell. When finding many paths with unchanged walkability, pass rebuild=false and call buildNodeData() once externally; the paths found are the same.

Parameters:

Name	Type	Attributes	Default	Description
`startPos`	Vector2			World-space start
`endPos`	Vector2			World-space end
`rebuild`	boolean	<optional>	true	Whether to call buildNodeData first

Source: plugins/pathFinder.js, line 735

Returns:

Type:: Array.<Vector2>

getCost(x, y) → {number}

Default extra cost for stepping on a cell. Returns 0 (free) by default. Override to add cost-weighted terrain (mud, swamp, etc).

Parameters:

Name	Type	Description
`x`	number	Tile x
`y`	number	Tile y

Source: plugins/pathFinder.js, line 172

Returns:

Type:: number

getNearestClearNode(worldPos, searchRangeopt, rebuildopt) → {PathFinderNode|null}

Find the clear (walkable, zero-cost) node closest to the given world position. Spirals outward in expanding boxes until a clear node is found or the search range is exhausted. Useful for snapping a click or NPC spawn position to the nearest open tile.

By default, calls buildNodeData() first so it works correctly on a fresh PathFinder. If you're calling it many times in a row with unchanged walkability, pass rebuild=false and call buildNodeData() once externally to avoid redundant work.

Parameters:

Name	Type	Attributes	Default	Description
`worldPos`	Vector2
`searchRange`	number	<optional>	10	Max box-radius in tiles
`rebuild`	boolean	<optional>	true	Whether to call buildNodeData first

Source: plugins/pathFinder.js, line 391

Returns:

Type:: PathFinderNode | null

getNode(x, y) → {PathFinderNode|null}

Get the node at tile coords, or null if out of bounds.

Parameters:

Name	Type	Description
`x`	number
`y`	number

Source: plugins/pathFinder.js, line 181

Returns:

Type:: PathFinderNode | null

isWalkable(x, y) → {boolean}

Default walkability: if a tile layer was provided, returns true when the cell has no solid (positive) collision data, so negative data is open like it is to the engine's collision; otherwise returns true. Override on the instance or via a subclass.

Parameters:

Name	Type	Description
`x`	number	Tile x
`y`	number	Tile y

Source: plugins/pathFinder.js, line 161

Returns:

Type:: boolean

tileToWorld(x, y) → {Vector2}

Convert integer tile coords to the world-space center of that tile.

Parameters:

Name	Type	Description
`x`	number
`y`	number

Source: plugins/pathFinder.js, line 201

Returns:

Type:: Vector2

worldToTile(worldPos) → {Vector2}

Convert a world-space position to integer tile coords (no clamping).

Parameters:

Name	Type	Description
`worldPos`	Vector2

Source: plugins/pathFinder.js, line 190

Returns:

Type:: Vector2