MTSR/minetest
3
0
Fork 0
mirror of https://github.com/minetest/minetest.git synced 2024-09-20 07:20:46 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve documentation for liquid_alternative_* (#12810)

Browse Source
This commit is contained in:
Wuzzy 2022-10-09 14:05:40 +02:00 committed by GitHub
parent c1c68775b2
commit b2a3f53b29
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
doc/lua_api.txt
View File

@ -1189,12 +1189,14 @@ Look for examples in `games/devtest` or `games/minetest_game`.
* The cubic source node for a liquid. * The cubic source node for a liquid.
* Faces bordering to the same node are never rendered. * Faces bordering to the same node are never rendered.
* Connects to node specified in `liquid_alternative_flowing`. * Connects to node specified in `liquid_alternative_flowing`.
* You *must* set `liquid_alternative_source` to the node's own name.
* Use `backface_culling = false` for the tiles you want to make * Use `backface_culling = false` for the tiles you want to make
visible when inside the node. visible when inside the node.
* `flowingliquid` * `flowingliquid`
* The flowing version of a liquid, appears with various heights and slopes. * The flowing version of a liquid, appears with various heights and slopes.
* Faces bordering to the same node are never rendered. * Faces bordering to the same node are never rendered.
* Connects to node specified in `liquid_alternative_source`. * Connects to node specified in `liquid_alternative_source`.
* You *must* set `liquid_alternative_flowing` to the node's own name.
* Node textures are defined with `special_tiles` where the first tile * Node textures are defined with `special_tiles` where the first tile
is for the top and bottom faces and the second tile is for the side is for the top and bottom faces and the second tile is for the side
faces. faces.
@ -8233,14 +8235,31 @@ Used by `minetest.register_node`.
-- around it until `liquid_range` is reached; -- around it until `liquid_range` is reached;
-- will drain out without a source; -- will drain out without a source;
-- recommended drawtype: "flowingliquid". -- recommended drawtype: "flowingliquid".
-- If it's "source" or "flowing" and `liquid_range > 0`, then -- If it's "source" or "flowing", then the
-- both `liquid_alternative_*` fields must be specified -- `liquid_alternative_*` fields _must_ be specified
liquid_alternative_flowing = "", liquid_alternative_flowing = "",
-- Node that represents the flowing version of the liquid
liquid_alternative_source = "", liquid_alternative_source = "",
-- Node that represents the source version of the liquid -- These fields may contain node names that represent the
-- flowing version (`liquid_alternative_flowing`) and
-- source version (`liquid_alternative_source`) of a liquid.
--
-- Specifically, these fields are required if any of these is true:
-- * `liquidtype ~= "none" or
-- * `drawtype == "liquid" or
-- * `drawtype == "flowingliquid"
--
-- Liquids consist of up to two nodes: source and flowing.
--
-- There are two ways to define a liquid:
-- 1) Source node and flowing node. This requires both fields to be
-- specified for both nodes.
-- 2) Standalone source node (cannot flow). `liquid_alternative_source`
-- must be specified and `liquid_range` must be set to 0.
--
-- Example:
-- liquid_alternative_flowing = "example:water_flowing",
-- liquid_alternative_source = "example:water_source",
liquid_viscosity = 0, liquid_viscosity = 0,
-- Controls speed at which the liquid spreads/flows (max. 7). -- Controls speed at which the liquid spreads/flows (max. 7).