Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Various documentation fixes (#10692)
set_sky: New feature, keep note about the old syntax
get_us_time: Document overflow
localplayer: Document "nil" behaviour before initialization
collision_box: Safe limit of "1.45"
  • Loading branch information
SmallJoker committed Dec 10, 2020
1 parent 6d7067f commit af07343
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 6 deletions.
1 change: 1 addition & 0 deletions doc/client_lua_api.txt
Expand Up @@ -1001,6 +1001,7 @@ Please do not try to access the reference until the camera is initialized, other

### LocalPlayer
An interface to retrieve information about the player.
This object will only be available after the client is initialized. Earlier accesses will yield a `nil` value.

Methods:

Expand Down
20 changes: 18 additions & 2 deletions doc/lua_api.txt
Expand Up @@ -1247,6 +1247,9 @@ A box of a regular node would look like:

{-0.5, -0.5, -0.5, 0.5, 0.5, 0.5},

To avoid collision issues, keep each value within the range of +/- 1.45.
This also applies to leveled nodeboxes, where the final height shall not
exceed this soft limit.



Expand Down Expand Up @@ -3234,6 +3237,7 @@ Helper functions
* returns true when the passed number represents NaN.
* `minetest.get_us_time()`
* returns time with microsecond precision. May not return wall time.
* This value might overflow on certain 32-bit systems!
* `table.copy(table)`: returns a table
* returns a deep copy of `table`
* `table.indexof(list, val)`: returns the smallest numerical index containing
Expand Down Expand Up @@ -6425,6 +6429,8 @@ object you are working with still exists.
* `selected_mode` is the mode index to be selected after modes have been changed
(0 is the first mode).
* `set_sky(sky_parameters)`
* The presence of the function `set_sun`, `set_moon` or `set_stars` indicates
whether `set_sky` accepts this format. Check the legacy format otherwise.
* `sky_parameters` is a table with the following optional fields:
* `base_color`: ColorSpec, changes fog in "skybox" and "plain".
* `type`: Available types:
Expand Down Expand Up @@ -6466,6 +6472,15 @@ object you are working with still exists.
abides by, `"custom"` uses `sun_tint` and `moon_tint`, while
`"default"` uses the classic Minetest sun and moon tinting.
Will use tonemaps, if set to `"default"`. (default: `"default"`)
* `set_sky(base_color, type, {texture names}, clouds)`
* Deprecated. Use `set_sky(sky_parameters)`
* `base_color`: ColorSpec, defaults to white
* `type`: Available types:
* `"regular"`: Uses 0 textures, `bgcolor` ignored
* `"skybox"`: Uses 6 textures, `bgcolor` used
* `"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`.
Expand Down Expand Up @@ -7346,6 +7361,7 @@ Used by `minetest.register_node`.
leveled_max = 127,
-- Maximum value for `leveled` (0-127), enforced in
-- `minetest.set_node_level` and `minetest.add_node_level`.
-- Values above 124 might causes collision detection issues.

liquid_range = 8, -- Number of flowing nodes around source (max. 8)

Expand Down Expand Up @@ -7373,6 +7389,7 @@ Used by `minetest.register_node`.
type = "fixed",
fixed = {
{-2 / 16, -0.5, -2 / 16, 2 / 16, 3 / 16, 2 / 16},
-- Node box format: see [Node boxes]
},
},
-- Custom selection box definition. Multiple boxes can be defined.
Expand All @@ -7383,13 +7400,12 @@ Used by `minetest.register_node`.
type = "fixed",
fixed = {
{-2 / 16, -0.5, -2 / 16, 2 / 16, 3 / 16, 2 / 16},
-- Node box format: see [Node boxes]
},
},
-- Custom collision box definition. Multiple boxes can be defined.
-- If "nodebox" drawtype is used and collision_box is nil, then node_box
-- definition is used for the collision box.
-- Both of the boxes above are defined as:
-- {xmin, ymin, zmin, xmax, ymax, zmax} in nodes from node center.

-- Support maps made in and before January 2012
legacy_facedir_simple = false,
Expand Down
9 changes: 5 additions & 4 deletions games/devtest/mods/testnodes/nodeboxes.lua
Expand Up @@ -18,7 +18,7 @@ minetest.register_node("testnodes:nodebox_fixed", {

-- 50% higher than a regular node
minetest.register_node("testnodes:nodebox_overhigh", {
description = S("Overhigh Nodebox Test Node"),
description = S("+50% high Nodebox Test Node"),
tiles = {"testnodes_nodebox.png"},
drawtype = "nodebox",
paramtype = "light",
Expand All @@ -30,15 +30,16 @@ minetest.register_node("testnodes:nodebox_overhigh", {
groups = {dig_immediate=3},
})

-- 100% higher than a regular node
-- 95% higher than a regular node
minetest.register_node("testnodes:nodebox_overhigh2", {
description = S("Double-height Nodebox Test Node"),
description = S("+95% high Nodebox Test Node"),
tiles = {"testnodes_nodebox.png"},
drawtype = "nodebox",
paramtype = "light",
node_box = {
type = "fixed",
fixed = {-0.5, -0.5, -0.5, 0.5, 1.5, 0.5},
-- Y max: more is possible, but glitchy
fixed = {-0.5, -0.5, -0.5, 0.5, 1.45, 0.5},
},

groups = {dig_immediate=3},
Expand Down

0 comments on commit af07343

Please sign in to comment.