diff options
Diffstat (limited to 'doc/lua_api.txt')
| -rw-r--r-- | doc/lua_api.txt | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt index e9a95c9e7..e8e32c536 100644 --- a/doc/lua_api.txt +++ b/doc/lua_api.txt @@ -6532,12 +6532,16 @@ Misc. * You may want to cache and call the old function to allow multiple mods to change knockback behavior. -* `minetest.forceload_block(pos[, transient])` +* `minetest.forceload_block(pos[, transient[, limit]])` * forceloads the position `pos`. * returns `true` if area could be forceloaded * 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). + * `limit` is an optional limit on the number of blocks that can be + forceloaded at once. If `limit` is negative, there is no limit. If it is + absent, the limit is the value of the setting `"max_forceloaded_blocks"`. + If the call would put the number of blocks over the limit, the call fails. * `minetest.forceload_free_block(pos[, transient])` * stops forceloading the position `pos` |