liquid_physics/README.md
2025-01-06 22:30:54 +01:00

42 lines
1.2 KiB
Markdown

# Liquid Physics
This Luanti mod adds physics to liquids.
This mod is in early alpha.
## What NOT to expect
- Proper water equalization and water pressure
- Removing weeds and other wall mounted items
- Interaction of different liquid types, e.g. lava and water
- Ability to scoop up liquids with a level below 8
- Interaction with pistons or pipes
- Perfect performance
- Integration with any other mods
- A smooth liquid surface
- Viscosity for different liquid types
## What to expect
- Water leveling for flat surfaces
- Settling water
- Multi-level liquids from 1 to 8
- Draining all oceans in a jiffy
- Water duplication due to a [bug](https://github.com/minetest/minetest/issues/15647) in the Luanti Engine
## API
- Other developers may chose to support this mod by using the API.
```lua
--Example: Register default:water_source
liquid_physics.register_liquid("default", "water_source", "water_flowing")
--Example: Check if block underneath is liquid and then proceed to reduce its level
local id_water = liquid_physics.get_liquid_id("default:water_source")
local liquid = liquid_physics.get_liquid_at(pos)
if liquid and liquid.liquid_id == id_water then
liquid_physics.set_liquid_at(pos, id_water, liquid.liquid_level - 1)
end
```