aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMatthew I <matttpt@gmail.com>2012-09-08 14:44:26 -0400
committerPerttu Ahola <celeron55@gmail.com>2012-11-30 19:26:51 +0200
commit6c8fa83ecd3f40a8e2fec890caaaa955f9d4255c (patch)
tree6bf4d32fc0f9ad1d22ac1d76f5a447bf7d6c58e4 /doc
parentab45133ab4826359ca9a5ed50b68150eb462c8ef (diff)
downloadminetest-6c8fa83ecd3f40a8e2fec890caaaa955f9d4255c.tar.gz
minetest-6c8fa83ecd3f40a8e2fec890caaaa955f9d4255c.tar.bz2
minetest-6c8fa83ecd3f40a8e2fec890caaaa955f9d4255c.zip
Add shutdown hook interface to Lua API
Scripts can call minetest.register_on_shutdown() to register a shutdown hook. Document that minetest.register_on_shutdown() callbacks may not be run If the server crashes, it is unlikely that callbacks registered using minetest.register_on_shutdown() will be called.
Diffstat (limited to 'doc')
-rw-r--r--doc/lua_api.txt5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index 550716cef..e32efc6df 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -792,6 +792,11 @@ minetest.register_craft(recipe)
Global callback registration functions: (Call these only at load time)
minetest.register_globalstep(func(dtime))
^ Called every server step, usually interval of 0.05s
+minetest.register_on_shutdown(func())
+^ Called before server shutdown
+^ WARNING: If the server terminates abnormally (i.e. crashes), the registered
+ callbacks WILL LIKELY NOT BE RUN. Data should be saved at
+ semi-frequent intervals as well as on server shutdown.
minetest.register_on_placenode(func(pos, newnode, placer, oldnode))
^ Called when a node has been placed
^ Deprecated: Use on_construct or after_place_node in node definition instead