diff options
| author | Zughy <63455151+Zughy@users.noreply.github.com> | 2022-03-05 22:15:41 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-03-05 22:15:41 +0100 |
| commit | 44fc888bd64cc00836b0fea0666aa763b2565513 (patch) | |
| tree | 74593dc8e5ddc98dbdc04b01753a7aca71f98e6a /doc | |
| parent | f2d1295fe646105f1b98b0c204f47f781336e211 (diff) | |
| download | minetest-44fc888bd64cc00836b0fea0666aa763b2565513.tar.gz minetest-44fc888bd64cc00836b0fea0666aa763b2565513.tar.bz2 minetest-44fc888bd64cc00836b0fea0666aa763b2565513.zip | |
Allow get_sky to return a table (#11963)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lua_api.txt | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt index 571ddf40e..8af261e0c 100644 --- a/doc/lua_api.txt +++ b/doc/lua_api.txt @@ -4634,6 +4634,8 @@ Utilities abm_min_max_y = true, -- dynamic_add_media supports passing a table with options (5.5.0) dynamic_add_media_table = true, + -- allows get_sky to return a table instead of separate values (5.6.0) + get_sky_as_table = true, } * `minetest.has_feature(arg)`: returns `boolean, missing_features` @@ -6869,9 +6871,15 @@ object you are working with still exists. * `"plain"`: Uses 0 textures, `bgcolor` used * `clouds`: Boolean for whether clouds appear in front of `"skybox"` or `"plain"` custom skyboxes (default: `true`) -* `get_sky()`: returns base_color, type, table of textures, clouds. -* `get_sky_color()`: returns a table with the `sky_color` parameters as in - `set_sky`. +* `get_sky(as_table)`: + * `as_table`: boolean that determines whether the deprecated version of this + function is being used. + * `true` returns a table containing sky parameters as defined in `set_sky(sky_parameters)`. + * Deprecated: `false` or `nil` returns base_color, type, table of textures, + clouds. +* `get_sky_color()`: + * Deprecated: Use `get_sky(as_table)` instead. + * returns a table with the `sky_color` parameters as in `set_sky`. * `set_sun(sun_parameters)`: * Passing no arguments resets the sun to its default values. * `sun_parameters` is a table with the following optional fields: |