From 2516c516bc018e2ff58c7d07c5f2ee8fd5f67167 Mon Sep 17 00:00:00 2001 From: raymoo Date: Fri, 2 Sep 2016 21:37:51 -0700 Subject: Forceloading: Transient forceloads Adds a flag to forceload_block which lets you turn off persistence for that forceload. --- doc/lua_api.txt | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) (limited to 'doc') diff --git a/doc/lua_api.txt b/doc/lua_api.txt index e0e984c0f..c82027148 100644 --- a/doc/lua_api.txt +++ b/doc/lua_api.txt @@ -2622,13 +2622,17 @@ These functions return the leftover itemstack. the creative mode setting, and checks for "sneak" to set the `invert_wall` parameter. -* `minetest.forceload_block(pos)` +* `minetest.forceload_block(pos[, transient])` * forceloads the position `pos`. * returns `true` if area could be forceloaded - * Please note that forceloaded areas are saved when the server restarts. + * If `transient` is `false` or absent, the forceload will be persistent + (saved between server runs). If `true`, the forceload will be transient + (not saved between server runs). -* `minetest.forceload_free_block(pos)` +* `minetest.forceload_free_block(pos[, transient])` * stops forceloading the position `pos` + * If `transient` is `false` or absent, frees a persistent forceload. + If `true`, frees a transient forceload. * `minetest.request_insecure_environment()`: returns an environment containing insecure functions if the calling mod has been listed as trusted in the -- cgit v1.2.3