# lua-star
-[![Build Status](https://travis-ci.org/wesleywerner/lua-star.svg?branch=master)](https://travis-ci.org/wesleywerner/lua-star) Lua-star is a pure Lua A* path-finding library.
+[![Build Status](https://www.travis-ci.com/wesleywerner/lua-star.svg?branch=master)](https://www.travis-ci.com/wesleywerner/lua-star)
+
+Lua-star is a pure Lua A* path-finding library.
![lua star example screenshot](example/example.gif)
return mymap[x][y] == walkable
end
- local path = luastar:find(width, height, start, goal, positionIsOpenFunc, useCache)
+ local path = luastar:find(width, height, start, goal, positionIsOpenFunc, useCache, excludeDiagonalMoving)
`path` will be false if no path was found, otherwise it contains a list of points that travel from `start` to `goal`:
luastar:clearCached()
+`excludeDiagonalMoving` also optional value defaults to `false`. If you want to exclude the possibility of moving diagonally set the value `true`. i.e, by default, diagonal movement is **enabled**
+
# Requirements
* [Lua 5.x](http://www.lua.org/)