aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorParamat <paramat@users.noreply.github.com>2017-09-03 21:32:21 +0100
committerLoïc Blot <nerzhul@users.noreply.github.com>2017-09-03 22:32:21 +0200
commit9f6d90aa811dd8f523b137d602127d31307ea15c (patch)
treefa92018a3ddd212f30fbfe08804313218153d0b9 /doc
parent5bef3393889e0a29155a7e777d19344eaaae96b7 (diff)
downloadhax-minetest-server-9f6d90aa811dd8f523b137d602127d31307ea15c.tar.gz
hax-minetest-server-9f6d90aa811dd8f523b137d602127d31307ea15c.zip
Ores: Add stratum ore (#6352)
Creates a single undulating ore stratum that is continuous across mapchunk borders and horizontally spans the world. Due to being continuous is ideal for creating bands of alternative stone type running through cliffs and mountains, or underground layers. Add missing documentation of 'ore_param2' parameter.
Diffstat (limited to 'doc')
-rw-r--r--doc/lua_api.txt19
1 files changed, 18 insertions, 1 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index 13227260c..a6d02ebb5 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -1069,7 +1069,6 @@ within the currently generated chunk.
The vertical top and bottom displacement of each puff are determined by the noise
parameters `np_puff_top` and `np_puff_bottom`, respectively.
-
### `blob`
Creates a deformed sphere of ore according to 3d perlin noise described by
`noise_params`. The maximum size of the blob is `clust_size`, and
@@ -1099,6 +1098,22 @@ to small changes. The following is a decent set of parameters to work from:
**WARNING**: Use this ore type *very* sparingly since it is ~200x more
computationally expensive than any other ore.
+### `stratum`
+Creates a single undulating ore stratum that is continuous across mapchunk
+borders and horizontally spans the world.
+The 2D perlin noise described by `noise_params` varies the Y co-ordinate of the
+stratum midpoint. The 2D perlin noise described by `np_stratum_thickness`
+varies the stratum's vertical thickness (in units of nodes). Due to being
+continuous across mapchunk borders the stratum's vertical thickness is
+unlimited.
+`y_min` and `y_max` define the limits of the ore generation and for performance
+reasons should be set as close together as possible but without clipping the
+stratum's Y variation.
+Each node in the stratum has a 1-in-`clust_scarcity` chance of being ore, so a
+solid-ore stratum would require a `clust_scarcity` of 1.
+The parameters `clust_num_ores`, `clust_size`, `noise_threshold` and
+`random_factor` are ignored by this ore type.
+
Ore attributes
--------------
See section "Flag Specifier Format".
@@ -4558,6 +4573,8 @@ Definition tables
{
ore_type = "scatter", -- See "Ore types"
ore = "default:stone_with_coal",
+ ore_param2 = 3,
+ -- ^ Facedir rotation. Default is 0 (unchanged rotation)
wherein = "default:stone",
-- ^ a list of nodenames is supported too
clust_scarcity = 8*8*8,