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

[LuaDoc] Document that mapgen wesnoth.map.find[_in_radius] can take a uncompiled filter table.

Browse source 
Also note the split-location, single location, and list overloads for find_in_radius's center and find's in_list.
This commit is contained in:
Celtic Minstrel 2024-02-06 22:14:53 -05:00 • committed by Celtic Minstrel
parent c2a19316a4
commit e92ee5cb1b
1 changed files with 13 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
utils/emmylua/wesnoth/map.lua
View file

@ -44,8 +44,15 @@ function wesnoth.map.replace_if_failed(terrain, mode) end
---Get a list of hexes matching a filter
---@param map terrain_map
---@param filter terrain_filter
---@param in_list? location[]
---@param in_list location[]
---@return location[]
---@overload fun(map:terrain_map, filter:terrain_filter):location[]
---@overload fun(map:terrain_map, filter:terrain_filter, at_loc:location):location[]
---@overload fun(map:terrain_map, filter:terrain_filter, at_x:integer, at_y:integer):location[]
---@overload fun(map:terrain_map, filter:terrain_filter_tag):location[]
---@overload fun(map:terrain_map, filter:terrain_filter_tag, in_list:location[]):location[]
---@overload fun(map:terrain_map, filter:terrain_filter_tag, at_loc:location):location[]
---@overload fun(map:terrain_map, filter:terrain_filter_tag, at_x:integer, at_y:integer):location[]
function wesnoth.map.find(map, filter, in_list) end
---Get a list of hexes matching a filter within a given circles
@ -54,6 +61,11 @@ function wesnoth.map.find(map, filter, in_list) end
---@param radius integer
---@param filter terrain_filter
---@return location[]
---@overload fun(map:terrain_map, centers:location[], radius:integer, filter:terrain_filter):location[]
---@overload fun(map:terrain_map, center_x:integer, center_y:integer, radius:integer, filter:terrain_filter):location[]
---@overload fun(map:terrain_map, center:location, radius:integer, filter:terrain_filter_tag):location[]
---@overload fun(map:terrain_map, centers:location[], radius:integer, filter:terrain_filter_tag):location[]
---@overload fun(map:terrain_map, center_x:integer, center_y:integer, radius:integer, filter:terrain_filter_tag):location[]
function wesnoth.map.find_in_radius(map, center, radius, filter) end
---Parse a mapgen location filter