moparisthebest/minetest
1
0
Fork 0
mirror of https://github.com/moparisthebest/minetest synced 2024-12-22 07:38:48 -05:00
Code Issues Releases Wiki Activity

Lua_api.txt: Add biome and nodeupdate documentation

Browse Source 
Add missing documentation for 'register_biome' and
'clear_registered_biomes'.
Add documentation for 'nodeupdate_single'. 'nodeupdate'
is not yet documented due to a bug it causes.
This commit is contained in:
paramat 2016-10-06 23:03:55 +01:00
parent d4a2e23793
commit 0264e38bff
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/lua_api.txt
View File

@ -1935,13 +1935,14 @@ Call these functions only at load time!
* Warning! The type field ("shaped","cooking" or any other) will be ignored if the recipe * Warning! The type field ("shaped","cooking" or any other) will be ignored if the recipe
contains output. Erasing is then done independently from the crafting method. contains output. Erasing is then done independently from the crafting method.
* `minetest.register_ore(ore definition)` * `minetest.register_ore(ore definition)`
* `minetest.register_biome(biome definition)`
* `minetest.register_decoration(decoration definition)` * `minetest.register_decoration(decoration definition)`
* `minetest.override_item(name, redefinition)` * `minetest.override_item(name, redefinition)`
* Overrides fields of an item registered with register_node/tool/craftitem. * Overrides fields of an item registered with register_node/tool/craftitem.
* Note: Item must already be defined, (opt)depend on the mod defining it. * Note: Item must already be defined, (opt)depend on the mod defining it.
* Example: `minetest.override_item("default:mese", {light_source=LIGHT_MAX})` * Example: `minetest.override_item("default:mese", {light_source=LIGHT_MAX})`
* `minetest.clear_registered_ores()` * `minetest.clear_registered_ores()`
* `minetest.clear_registered_biomes()`
* `minetest.clear_registered_decorations()` * `minetest.clear_registered_decorations()`
### Global callback registration functions ### Global callback registration functions
@ -2270,6 +2271,11 @@ and `minetest.auth_reload` call the authetification handler.
* increase level of leveled node by level, default `level` equals `1` * increase level of leveled node by level, default `level` equals `1`
* if `totallevel > maxlevel`, returns rest (`total-max`) * if `totallevel > maxlevel`, returns rest (`total-max`)
* can be negative for decreasing * can be negative for decreasing
* `nodeupdate_single(pos)`
* causes an unsupported `group:falling_node` node to fall and causes an
unattached `group:attached_node` node to fall.
* does not spread these updates to neighbours
* a helper function, not officially part of the API, but useful
### Inventory ### Inventory
`minetest.get_inventory(location)`: returns an `InvRef` `minetest.get_inventory(location)`: returns an `InvRef`