oss/luanti
oss/luanti
1
0
Fork 0
mirror of https://github.com/luanti-org/luanti.git synced 2025-08-01 17:38:41 +00:00
Code Wiki Activity

Docs: Less redundancy in noise API docs

Browse source 
was created by deprecated aliases being documented too prominently/verbosely
This commit is contained in:
grorp 2025-05-23 11:03:02 -04:00
parent 4dd7468237
commit a7d1a9d4ab
1 changed files with 13 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

30
doc/lua_api.md
View file

@ -6565,13 +6565,10 @@ Environment access
* The actual seed used is the noiseparams seed plus the world seed. * The actual seed used is the noiseparams seed plus the world seed.
* `core.get_value_noise(seeddiff, octaves, persistence, spread)` * `core.get_value_noise(seeddiff, octaves, persistence, spread)`
* Deprecated: use `core.get_value_noise(noiseparams)` instead. * Deprecated: use `core.get_value_noise(noiseparams)` instead.
* Return world-specific value noise
* `core.get_perlin(noiseparams)` * `core.get_perlin(noiseparams)`
* Deprecated: use `core.get_value_noise(noiseparams)` instead. * Deprecated: renamed to `core.get_value_noise` in version 5.12.0.
* Return world-specific value noise (was not Perlin noise)
* `core.get_perlin(seeddiff, octaves, persistence, spread)` * `core.get_perlin(seeddiff, octaves, persistence, spread)`
* Deprecated: use `core.get_value_noise(noiseparams)` instead. * Deprecated: renamed to `core.get_value_noise` in version 5.12.0.
* Return world-specific value noise (was not Perlin noise)
* `core.get_voxel_manip([pos1, pos2])` * `core.get_voxel_manip([pos1, pos2])`
* Return voxel manipulator object. * Return voxel manipulator object.
* Loads the manipulator from the map if positions are passed. * Loads the manipulator from the map if positions are passed.
@ -9243,20 +9240,17 @@ to restrictions of JSON.
A value noise generator. A value noise generator.
It can be created via `ValueNoise()` or `core.get_value_noise()`. It can be created via `ValueNoise()` or `core.get_value_noise()`.
For legacy reasons, it can also be created via `PerlinNoise()` or `core.get_perlin()`,
but the implemented noise is not Perlin noise.
For `core.get_value_noise()`, the actual seed used is the noiseparams seed For `core.get_value_noise()`, the actual seed used is the noiseparams seed
plus the world seed, to create world-specific noise. plus the world seed, to create world-specific noise.
* `ValueNoise(noiseparams) * `ValueNoise(noiseparams)`
* `ValueNoise(seed, octaves, persistence, spread)` (Deprecated) * `ValueNoise(seed, octaves, persistence, spread)` (deprecated)
* `PerlinNoise(noiseparams)` (Deprecated)
* `PerlinNoise(seed, octaves, persistence, spread)` (Deprecated)
* `core.get_value_noise(noiseparams)` * `core.get_value_noise(noiseparams)`
* `core.get_value_noise(seeddiff, octaves, persistence, spread)` (Deprecated) * `core.get_value_noise(seeddiff, octaves, persistence, spread)` (deprecated)
* `core.get_perlin(noiseparams)` (Deprecated)
* `core.get_perlin(seeddiff, octaves, persistence, spread)` (Deprecated) These were previously called `PerlinNoise()` and `core.get_perlin()`, but the
implemented noise was not Perlin noise. They were renamed in 5.12.0. The old
names still exist as aliases.
### Methods ### Methods
@ -9270,11 +9264,13 @@ A fast, bulk noise generator.
It can be created via `ValueNoiseMap(noiseparams, size)` or It can be created via `ValueNoiseMap(noiseparams, size)` or
`core.get_value_noise_map(noiseparams, size)`. `core.get_value_noise_map(noiseparams, size)`.
For legacy reasons, it can also be created via `PerlinNoiseMap(noiseparams, size)`
or `core.get_perlin_map(noiseparams, size)`, but it is not Perlin noise.
For `core.get_value_noise_map()`, the actual seed used is the noiseparams seed For `core.get_value_noise_map()`, the actual seed used is the noiseparams seed
plus the world seed, to create world-specific noise. plus the world seed, to create world-specific noise.
These were previously called `PerlinNoiseMap()` and `core.get_perlin_map()`,
but the implemented noise was not Perlin noise. They were renamed in 5.12.0.
The old names still exist as aliases.
Format of `size` is `{x=dimx, y=dimy, z=dimz}`. The `z` component is omitted Format of `size` is `{x=dimx, y=dimy, z=dimz}`. The `z` component is omitted
for 2D noise, and it must be larger than 1 for 3D noise (otherwise for 2D noise, and it must be larger than 1 for 3D noise (otherwise
`nil` is returned). `nil` is returned).