0ct0pu5/wesnoth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[LuaDoc] Add documentation for the map generator version of wesnoth.paths.find_path

Browse source
This commit is contained in:
Celtic Minstrel 2024-02-10 21:24:16 -05:00
parent 94adca0fff
commit 0bb93d39fc
1 changed files with 5 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
utils/emmylua/wesnoth/paths.lua
View file

@ -27,6 +27,11 @@ wesnoth.paths = {}
---@overload fun(x1:integer, y1:integer, finish:location, calc:path_function):location[],integer
---@overload fun(start:location, x2:integer, y2:integer, calc:path_function):location[],integer
---@overload fun(x1:integer, y1:integer, x2:integer, y2:integer, calc:path_function):location[],integer
-- Mapgen overloads
---@overload fun(start:location, finish:location, location, calc:path_function, width:integer, height:integer):location[],integer
---@overload fun(x1:integer, y1:integer, finish:location, location, calc:path_function, width:integer, height:integer):location[],integer
---@overload fun(start:location, x2:integer, y2:integer, location, calc:path_function, width:integer, height:integer):location[],integer
---@overload fun(x1:integer, y1:integer, x2:integer, y2:integer, location, calc:path_function, width:integer, height:integer):location[],integer
function wesnoth.paths.find_path(start, finish, options) end
---Find a vacant hex as close as possible