Skip to content

Commit 1bb8449

Browse files
authored
Improve liquid documentation (#11158)
1 parent 225d454 commit 1bb8449

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

doc/lua_api.txt

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1112,8 +1112,20 @@ Look for examples in `games/devtest` or `games/minetest_game`.
11121112
* Invisible, uses no texture.
11131113
* `liquid`
11141114
* The cubic source node for a liquid.
1115+
* Faces bordering to the same node are never rendered.
1116+
* Connects to node specified in `liquid_alternative_flowing`.
1117+
* Use `backface_culling = false` for the tiles you want to make
1118+
visible when inside the node.
11151119
* `flowingliquid`
11161120
* The flowing version of a liquid, appears with various heights and slopes.
1121+
* Faces bordering to the same node are never rendered.
1122+
* Connects to node specified in `liquid_alternative_source`.
1123+
* Node textures are defined with `special_tiles` where the first tile
1124+
is for the top and bottom faces and the second tile is for the side
1125+
faces.
1126+
* `tiles` is used for the item/inventory/wield image rendering.
1127+
* Use `backface_culling = false` for the special tiles you want to make
1128+
visible when inside the node
11171129
* `glasslike`
11181130
* Often used for partially-transparent nodes.
11191131
* Only external sides of textures are visible.
@@ -7453,7 +7465,16 @@ Used by `minetest.register_node`.
74537465
-- If true, liquids flow into and replace this node.
74547466
-- Warning: making a liquid node 'floodable' will cause problems.
74557467

7456-
liquidtype = "none", -- "none" / "source" / "flowing"
7468+
liquidtype = "none", -- specifies liquid physics
7469+
-- * "none": no liquid physics
7470+
-- * "source": spawns flowing liquid nodes at all 4 sides and below;
7471+
-- recommended drawtype: "liquid".
7472+
-- * "flowing": spawned from source, spawns more flowing liquid nodes
7473+
-- around it until `liquid_range` is reached;
7474+
-- will drain out without a source;
7475+
-- recommended drawtype: "flowingliquid".
7476+
-- If it's "source" or "flowing" and `liquid_range > 0`, then
7477+
-- both `liquid_alternative_*` fields must be specified
74577478

74587479
liquid_alternative_flowing = "", -- Flowing version of source liquid
74597480

@@ -7476,7 +7497,10 @@ Used by `minetest.register_node`.
74767497
-- `minetest.set_node_level` and `minetest.add_node_level`.
74777498
-- Values above 124 might causes collision detection issues.
74787499

7479-
liquid_range = 8, -- Number of flowing nodes around source (max. 8)
7500+
liquid_range = 8,
7501+
-- Maximum distance that flowing liquid nodes can spread around
7502+
-- source on flat land;
7503+
-- maximum = 8; set to 0 to disable liquid flow
74807504

74817505
drowning = 0,
74827506
-- Player will take this amount of damage if no bubbles are left

0 commit comments

Comments
 (0)