diff options
| author | raymoo <uguu@installgentoo.com> | 2016-09-02 21:37:51 -0700 |
|---|---|---|
| committer | paramat <mat.gregory@virginmedia.com> | 2016-10-03 01:54:36 +0100 |
| commit | 2516c516bc018e2ff58c7d07c5f2ee8fd5f67167 (patch) | |
| tree | da9111ca7be262cff5a3ab7bf049387f39ab6378 /doc | |
| parent | 077b6cfa21fe323434e704bb7a81870ff689c433 (diff) | |
| download | minetest-2516c516bc018e2ff58c7d07c5f2ee8fd5f67167.tar.gz minetest-2516c516bc018e2ff58c7d07c5f2ee8fd5f67167.tar.bz2 minetest-2516c516bc018e2ff58c7d07c5f2ee8fd5f67167.zip | |
Forceloading: Transient forceloads
Adds a flag to forceload_block which lets you turn off persistence for
that forceload.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lua_api.txt | 10 |
1 files changed, 7 insertions, 3 deletions
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 |