Add on_flood() callback.
authorAuke Kok <sofar@foo-projects.org>
Thu, 20 Apr 2017 06:10:39 +0000 (23:10 -0700)
committerparamat <mat.gregory@virginmedia.com>
Sat, 22 Apr 2017 00:23:51 +0000 (01:23 +0100)
commitcca58fe0fd1aac4246a23e1fc4f8469bdd280c6d
tree0dad1131f8cb0d9ec8c7bc7e35f4e3fc378c4ca0
parent8464da75857c1556f64984c0b014300638e38d4f
Add on_flood() callback.

This callback is called if a liquid definitely floods a non-air
node on the map. The callback arguments are (pos, oldnode, newnode)
and can return a `bool` value indicating whether flooding the
node should be cancelled (`return true` will prevent the node
from flooding).

Documentation is added, the callback function was tested with a
modified minetest_game.

Note that `return true` will likely cause the node's `on_flood()`
callback to be called every second until the node gets removed,
so care must be taken to prevent many callbacks from using this
return value. The current default liquid update interval is 1.0
seconds, which isn't unmanageable.

The larger aim of this patch is to remove the lava cooling ABM,
which is a significant cost to idle servers that have lava on their
map. This callback will be much more efficient.
doc/lua_api.txt
src/map.cpp
src/map.h
src/script/cpp_api/s_node.cpp
src/script/cpp_api/s_node.h
src/server.cpp