summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZughy <63455151+Zughy@users.noreply.github.com>2022-01-01 22:46:00 +0100
committerGitHub <noreply@github.com>2022-01-01 22:46:00 +0100
commit8910c7f8ae1862d3d81e6f635789e765ae2e80b9 (patch)
tree080f253151b9d8ffa3731e6e8dc9679ad378590c
parent29d2b2ccd06cdd831a7fac66928bfa612003945c (diff)
downloadminetest-8910c7f8ae1862d3d81e6f635789e765ae2e80b9.tar.gz
minetest-8910c7f8ae1862d3d81e6f635789e765ae2e80b9.tar.bz2
minetest-8910c7f8ae1862d3d81e6f635789e765ae2e80b9.zip
Better document sky_color scope (#11892)
-rw-r--r--doc/lua_api.txt30
1 files changed, 15 insertions, 15 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index 0879dcfb5..81b05abb0 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -6803,29 +6803,29 @@ object you are working with still exists.
* `textures`: A table containing up to six textures in the following
order: Y+ (top), Y- (bottom), X- (west), X+ (east), Z+ (north), Z- (south).
* `clouds`: Boolean for whether clouds appear. (default: `true`)
- * `sky_color`: A table containing the following values, alpha is ignored:
- * `day_sky`: ColorSpec, for the top half of the `"regular"`
- sky during the day. (default: `#61b5f5`)
- * `day_horizon`: ColorSpec, for the bottom half of the
- `"regular"` sky during the day. (default: `#90d3f6`)
- * `dawn_sky`: ColorSpec, for the top half of the `"regular"`
- sky during dawn/sunset. (default: `#b4bafa`)
+ * `sky_color`: A table used in `"regular"` type only, containing the
+ following values (alpha is ignored):
+ * `day_sky`: ColorSpec, for the top half of the sky during the day.
+ (default: `#61b5f5`)
+ * `day_horizon`: ColorSpec, for the bottom half of the sky during the day.
+ (default: `#90d3f6`)
+ * `dawn_sky`: ColorSpec, for the top half of the sky during dawn/sunset.
+ (default: `#b4bafa`)
The resulting sky color will be a darkened version of the ColorSpec.
Warning: The darkening of the ColorSpec is subject to change.
- * `dawn_horizon`: ColorSpec, for the bottom half of the `"regular"`
- sky during dawn/sunset. (default: `#bac1f0`)
+ * `dawn_horizon`: ColorSpec, for the bottom half of the sky during dawn/sunset.
+ (default: `#bac1f0`)
The resulting sky color will be a darkened version of the ColorSpec.
Warning: The darkening of the ColorSpec is subject to change.
- * `night_sky`: ColorSpec, for the top half of the `"regular"`
- sky during the night. (default: `#006bff`)
+ * `night_sky`: ColorSpec, for the top half of the sky during the night.
+ (default: `#006bff`)
The resulting sky color will be a dark version of the ColorSpec.
Warning: The darkening of the ColorSpec is subject to change.
- * `night_horizon`: ColorSpec, for the bottom half of the `"regular"`
- sky during the night. (default: `#4090ff`)
+ * `night_horizon`: ColorSpec, for the bottom half of the sky during the night.
+ (default: `#4090ff`)
The resulting sky color will be a dark version of the ColorSpec.
Warning: The darkening of the ColorSpec is subject to change.
- * `indoors`: ColorSpec, for when you're either indoors or
- underground. Only applies to the `"regular"` sky.
+ * `indoors`: ColorSpec, for when you're either indoors or underground.
(default: `#646464`)
* `fog_sun_tint`: ColorSpec, changes the fog tinting for the sun
at sunrise and sunset.