Skip to content

Commit

Permalink
0.4.1
Browse files Browse the repository at this point in the history
  • Loading branch information
vantreeseba committed Dec 23, 2018
1 parent bfa305f commit 521c5f5
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 85 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
## <small>0.4.1 (2018-12-23)</small>

* Add src to npm ignore, add src folder, change entry point to dist ([0906e66](https://github.com/vantreeseba/gamealgo/commit/0906e66))
* Fix path to index for webpack entry ([bfa305f](https://github.com/vantreeseba/gamealgo/commit/bfa305f))



## 0.4.0 (2018-08-24)

* 0.4.0 ([0fa3399](https://github.com/vantreeseba/gamealgo/commit/0fa3399))
* Make version build ([700b306](https://github.com/vantreeseba/gamealgo/commit/700b306))


Expand Down
83 changes: 0 additions & 83 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,85 +1,2 @@
A bunch of random utils for game development in js.

<a name="AStar"></a>

## AStar
A* Search algorithm implementation.

**Kind**: global class

* [AStar](#AStar)
* [.reset(graph, start, goal)](#AStar+reset)
* [.reconstructPath(current)](#AStar+reconstructPath)
* [.heuristicCostEstimate(start, goal)](#AStar+heuristicCostEstimate)
* [.distBetween(v1, v2)](#AStar+distBetween)
* [.step()](#AStar+step) ⇒ <code>Boolean</code> \| <code>Array</code>
* [.run(graph, start, goal)](#AStar+run)

<a name="AStar+reset"></a>

### aStar.reset(graph, start, goal)
Reset astar runner so you can use a diff graph, start or goal.

**Kind**: instance method of [<code>AStar</code>](#AStar)

| Param |
| --- |
| graph |
| start |
| goal |

<a name="AStar+reconstructPath"></a>

### aStar.reconstructPath(current)
Rebuild path from.

**Kind**: instance method of [<code>AStar</code>](#AStar)

| Param |
| --- |
| current |

<a name="AStar+heuristicCostEstimate"></a>

### aStar.heuristicCostEstimate(start, goal)
Calculate the heuristic cost.

**Kind**: instance method of [<code>AStar</code>](#AStar)

| Param |
| --- |
| start |
| goal |

<a name="AStar+distBetween"></a>

### aStar.distBetween(v1, v2)
Calculate distance between two nodes

**Kind**: instance method of [<code>AStar</code>](#AStar)

| Param | Type |
| --- | --- |
| v1 | <code>\*</code> |
| v2 | <code>\*</code> |

<a name="AStar+step"></a>

### aStar.step() ⇒ <code>Boolean</code> \| <code>Array</code>
Take a single step through the algorithm, this is mostly exposed for doing demos/visualization.

**Kind**: instance method of [<code>AStar</code>](#AStar)
**Returns**: <code>Boolean</code> \| <code>Array</code> - A bool indicating it's still running, or an array of the shortest path.
<a name="AStar+run"></a>

### aStar.run(graph, start, goal)
Find the shortest path from one node to another in a graph.

**Kind**: instance method of [<code>AStar</code>](#AStar)

| Param |
| --- |
| graph |
| start |
| goal |

2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "game-algo",
"version": "0.4.0",
"version": "0.4.1",
"description": "",
"main": "dist/index.js",
"browser": "dist/index.js",
Expand Down

0 comments on commit 521c5f5

Please sign in to comment.