minetest-mods/i3
1
0
Fork 0
mirror of https://github.com/minetest-mods/i3.git synced 2025-10-31 08:15:26 +01:00
Code Issues Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Jean-Patrick Guerrero
2021-01-29 02:51:46 +01:00
parent 6e1e50ae20
commit 3e5b7cbb55
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
API.md
View File

@@ -41,19 +41,19 @@ i3.new_tab {
- `fs` is the formspec table which is callable with a metamethod. Each call adds a new entry. - `fs` is the formspec table which is callable with a metamethod. Each call adds a new entry.
- `i3.set_fs(player)` must be called to update the formspec. - `i3.set_fs(player)` must be called to update the formspec.
##### `i3.delete_tab(tabname)` #### `i3.delete_tab(tabname)`
Deletes a tab by name. Deletes a tab by name.
##### `i3.set_tab(player, tabname)` #### `i3.set_tab(player, tabname)`
Sets the current tab by name. `player` is an `ObjectRef` to the user. Sets the current tab by name. `player` is an `ObjectRef` to the user.
##### `i3.override_tab(tabname, def)` #### `i3.override_tab(tabname, def)`
Overrides a tab by name. `def` is the tab definition like seen in `i3.set_tab`. Overrides a tab by name. `def` is the tab definition like seen in `i3.set_tab`.
##### `i3.get_tabs()` #### `i3.get_tabs()`
Returns the list of registered tabs. Returns the list of registered tabs.
@@ -199,12 +199,12 @@ They can be used like so: `<optional_name> +<filter name>=<value1>,<value2>,<...
Example usages: Example usages:
- `+groups=cracky,crumbly`: search for groups `cracky` and `crumbly` in all items. - `+groups=cracky,crumbly`: search for groups `cracky` and `crumbly` in all items.
- `wood +groups=flammable +type=node`: search for group `flammable` amongst items which contain - `wood +groups=flammable +types=node`: search for group `flammable` amongst items which contain
`wood` in their names AND have a `node` drawtype. `wood` in their names AND have a `node` drawtype.
Notes: Notes:
- If `optional_name` is omitted, the search filter will apply to all items, without pre-filtering. - If `optional_name` is omitted, the search filter will apply to all items, without pre-filtering.
- The `groups` and `type` filters are currently implemented by default. - The `+groups` and `+types` filters are currently implemented by default.
#### `i3.add_search_filter(name, function(item, values))` #### `i3.add_search_filter(name, function(item, values))`