From aba2b6638ec76488a5e12a940c35eff0d80fda96 Mon Sep 17 00:00:00 2001 From: Xeno333 <149852758+Xeno333@users.noreply.github.com> Date: Sat, 7 Jun 2025 07:44:35 -0500 Subject: [PATCH] Add documentation for ValueNoise during load time (#16235) --- doc/lua_api.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/lua_api.md b/doc/lua_api.md index 5a2e16707..ca3a5fee7 100644 --- a/doc/lua_api.md +++ b/doc/lua_api.md @@ -6586,6 +6586,7 @@ Environment access * `core.get_value_noise(noiseparams)` * Return world-specific value noise. * The actual seed used is the noiseparams seed plus the world seed. + * **Important**: Requires the mapgen environment to be initalized, do not use at load time. * `core.get_value_noise(seeddiff, octaves, persistence, spread)` * Deprecated: use `core.get_value_noise(noiseparams)` instead. * `core.get_perlin(noiseparams)` @@ -9270,6 +9271,8 @@ It can be created via `ValueNoise()` or `core.get_value_noise()`. For `core.get_value_noise()`, the actual seed used is the noiseparams seed plus the world seed, to create world-specific noise. +**Important**: These require the mapgen environment to be initalized, do not use at load time. + * `ValueNoise(noiseparams)` * `ValueNoise(seed, octaves, persistence, spread)` (deprecated) * `core.get_value_noise(noiseparams)` @@ -9306,6 +9309,8 @@ For each of the functions with an optional `buffer` parameter: If `buffer` is not nil, this table will be used to store the result instead of creating a new table. +**Important**: These require the mapgen environment to be initalized, do not use at load time. + ### Methods * `get_2d_map(pos)`: returns a `` times `` 2D array of 2D noise