diff options
Diffstat (limited to 'doc/lua_api.txt')
| -rw-r--r-- | doc/lua_api.txt | 23 |
1 files changed, 14 insertions, 9 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt index b07d046c4..ae414406d 100644 --- a/doc/lua_api.txt +++ b/doc/lua_api.txt @@ -714,23 +714,28 @@ a non-equal distribution of ore. ### `sheet` Creates a sheet of ore in a blob shape according to the 2D perlin noise -described by `noise_params`. The relative height of the sheet can be -controlled by the same perlin noise as well, by specifying a non-zero -`scale` parameter in `noise_params`. +described by `noise_params`. This is essentially an improved version of +the so-called "stratus" ore seen in some unofficial mods. -**IMPORTANT**: The noise is not transformed by `offset` or `scale` when comparing -against the noise threshold, but scale is used to determine relative height. -The height of the blob is randomly scattered, with a maximum height of `clust_size`. +This sheet consists of vertical columns of uniform randomly distributed height, +varying between the inclusive range `column_height_min` and `column_height_max`. +If `column_height_min` is not specified, this parameter defaults to 1. +If `column_height_max` is not specified, this parameter defaults to `clust_size` +for reverse compatibility. New code should prefer `column_height_max`. -`clust_scarcity` and `clust_num_ores` are ignored. +The `column_midpoint_factor` parameter controls the position of the column at which +ore eminates from. If 1, columns grow upward. If 0, columns grow downward. If 0.5, +columns grow equally starting from each direction. `column_midpoint_factor` is a +decimal number ranging in value from 0 to 1. If this parameter is not specified, +the default is 0.5. -This is essentially an improved version of the so-called "stratus" ore seen in -some unofficial mods. +The ore parameters `clust_scarcity` and `clust_num_ores` are ignored for this ore type. ### `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 `clust_scarcity` has the same meaning as with the `scatter` type. + ### `vein Creates veins of ore varying in density by according to the intersection of two instances of 3d perlin noise with diffferent seeds, both described by |