https://github.com/tckerr/pathfinder

Pathfinder is a Javascript library that provides basic 2D pathfinding functionality. The algorithm is a simple implementation of the A-star search algorithm.
https://github.com/tckerr/pathfinder

Last synced: about 2 months ago
JSON representation

Pathfinder is a Javascript library that provides basic 2D pathfinding functionality. The algorithm is a simple implementation of the A-star search algorithm.

• Host: GitHub
• URL: https://github.com/tckerr/pathfinder
• Owner: tckerr
• Created: 2016-01-12T03:29:06.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2016-01-12T03:44:35.000Z (about 9 years ago)
• Last Synced: 2023-03-24T14:42:02.315Z (almost 2 years ago)
• Language: JavaScript
• Size: 110 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        

Description

---

Pathfinder is a Javascript library that provides basic 2D pathfinding functionality. The algorithm is a simple implementation of the [A-star search algorithm](https://en.wikipedia.org/wiki/A*_search_algorithm).

Instructions

---

Download and include the library:

```

```

You will then be able to access the library through the ```Pathfinder``` object.

Pathfinder has a single function that calculates a path between two points: ```Pathfinder.findPath(nodes, start_node, end_node)```. The arguments are as follows:

- ```nodes```: a 2D array of ```node``` objects (defined below.)

- ```start_node```: the starting ```node``` object from the ```nodes``` array. This node will **not** count as a step in the pathfinding sequence.

- ```end_node```: the destination```node``` object from the ```nodes``` array. Arriving at this node will complete the sequence.

To construct new nodes, use the following syntax: ```var node = new Pathfinder.node(column, row, is_open)```, where the arguments are as follows:

- ```column```: an index starting at 0, representing the nodes horizontal position in the grid.

- ```row```: an index starting at 0, representing the nodes vertical position in the grid.

- ```is_open```: a boolean representing whether the node is passable or not.

Example

---

Here is an example block of code that will construct a node array:

```

function buildNodes(){

    var nodeColumns = [];

    var columnCount = 50;

    var rowCount = 50;

    for ( var col = 0; col < columnCount; ++col ){

        nodeColumns.push([]);

        for ( var row = 0; row < rowCount; ++row ){

            var node = new Pathfinder.node(col, row, true, false);

            nodeColumns[col].push(node);                

        }

    }

    return nodeColumns;

}

```

From here, you could pathfind with the following:

```

//pathfind from the top left to the bottom right of our grid

var endCol = self.nodeColumns.length - 1;

var endRow = self.nodeColumns[endCol].length - 1;

var lastResult = window.Pathfinder.findPath(self.nodeColumns, self.nodeColumns[0][0], self.nodeColumns[endCol][endRow] );

```

Note that the ```findPath``` function will return a list of nodes that represent steps in the pathfinding sequence. It will return ```false``` if no path is possible.

See the example for an implementation demonstration.