Where is documentation for wesnoth.map.filter?

[dwarftough]

I'm trying to find documentation for wesnoth.map.filter() function but I fail to do so on the page https://wiki.wesnoth.org/LuaAPI/wesnoth/map

More to it, when I try to find a lua definition of this function in data/lua directory, I fail as well. Where to find docs and the definition?

[Soliton]

It's implemented in C++ (over lots of functions and classes...) not in lua. Looks like it builds an internal representation of a terrain filter based on the lua table you hand in. What is called filter userdata on the wiki.

I think if you use wesnoth.map.filter_tags to generate the argument then you don't need to understand more about it. Though formula seems to be missing there.

[dwarftough]

Well, for example here https://github.com/wesnoth/wesnoth/blob ... ine.lua#L5

Code: Select all

function get_locations(t)
	local filter = wesnoth.map.filter(t.filter, t.filter_extra or {})
	return map:find(filter, t.locs)
end

it's not clear what the second argument t.filter_extra means. Is wesnoth.map.filter takes one argument, two arguments or a variable number? If several, what does it mean (AND for all filters or what?)

I just wanted to play around with custom map generators, there are useful examples such as the cave map generator but some things are still obscure

[Soliton]

wesnoth.map.filter takes two arguments. Second argument is optional. A comment says "lua table that describes the filter resources". No clue what that means in practice. Hard to tell just from reading the code. I guess you can somehow use that table inside the filter.

[Celtic_Minstrel]

The closest we have to documentation for it right now is the example here. The idea is to use various filter_tags to build up the table, rather than manually constructing a filter table.

For details on how to use the various filter_tags, you can check out their definition in data/lua/core/map.lua starting at line 346 – they're fully documented inline there.