aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorParamat <paramat@users.noreply.github.com>2019-07-20 02:54:42 +0100
committerGitHub <noreply@github.com>2019-07-20 02:54:42 +0100
commit9e005847302680dfc5c2fcadab81f5f1384db2d9 (patch)
tree3e1a94da860a31d75b852d1b041077b0dafecb80 /doc
parent76824bac9ff817d8072434997543464995b7e7e0 (diff)
downloadminetest-9e005847302680dfc5c2fcadab81f5f1384db2d9.tar.gz
minetest-9e005847302680dfc5c2fcadab81f5f1384db2d9.tar.bz2
minetest-9e005847302680dfc5c2fcadab81f5f1384db2d9.zip
Improve documentation of mapgen aliases (#8693)
Diffstat (limited to 'doc')
-rw-r--r--doc/lua_api.txt19
1 files changed, 10 insertions, 9 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index be19d9e3d..c453a5dd2 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -286,7 +286,9 @@ of the game's nodes are to be used for core mapgen generation. For example:
minetest.register_alias("mapgen_stone", "default:stone")
-### Aliases needed for all mapgens except Mapgen V6
+### Aliases for non-V6 mapgens
+
+#### Essential aliases
* mapgen_stone
* mapgen_water_source
@@ -296,17 +298,20 @@ of the game's nodes are to be used for core mapgen generation. For example:
it is necessary to have a river liquid node with a short `liquid_range` and
`liquid_renewable = false` to avoid flooding.
-#### Deprecated aliases
+#### Optional aliases
* mapgen_lava_source
+
+Fallback lava node used if cave liquids are not defined in biome definitions.
+Deprecated for non-V6 mapgens, define cave liquids in biome definitions instead.
+
* mapgen_cobble
-Use biome-defined cave liquids and dungeon nodes instead.
+Fallback node used if dungeon nodes are not defined in biome definitions.
+Deprecated for non-V6 mapgens, define dungeon nodes in biome definitions instead.
### Aliases needed for Mapgen V6
-#### Terrain and biomes
-
* mapgen_stone
* mapgen_water_source
* mapgen_lava_source
@@ -321,8 +326,6 @@ Use biome-defined cave liquids and dungeon nodes instead.
* mapgen_snow
* mapgen_ice
-#### Flora
-
* mapgen_tree
* mapgen_leaves
* mapgen_apple
@@ -332,8 +335,6 @@ Use biome-defined cave liquids and dungeon nodes instead.
* mapgen_pine_tree
* mapgen_pine_needles
-#### Dungeons
-
* mapgen_cobble
* mapgen_stair_cobble
* mapgen_mossycobble