minetest-mods
/
craftguide
mirror of https://github.com/minetest-mods/craftguide.git
1
0
Fork 1
Code Issues Releases Wiki Activity

Add examples in doc

This commit is contained in:
Jean-Patrick Guerrero 2019-03-07 13:43:47 +01:00
parent e0e57b45ea
commit b1a67eb632
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
API.md
View File

@ -70,10 +70,15 @@ Returns a map of recipe filters, indexed by name.
Search filters are used to perform specific searches inside the search field.
They can be used like so: `<optional name>+<filter name>=<value1>,<value2>,<...>`
Examples:
- `+groups=cracky,crumbly`: search for groups `cracky` and `crumbly` in all items.
- `sand+groups=falling_node`: search for group `falling_node` for items which contain `sand` in their names.
Notes:
- If `optional name` is omitted, the search filter will apply to all items, without pre-filtering.
- Filters can be combined.
- The `+groups=` filter is currently implemented by default.
- The `groups` filter is currently implemented by default.
#### `craftguide.add_search_filter(name, function(item, values))`