summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authororwell96 <mono96.mml@gmail.com>2017-09-28 17:11:51 +0200
committerLoïc Blot <nerzhul@users.noreply.github.com>2017-09-28 17:11:51 +0200
commit08846cd05cd402cc7f8d025aaba96c5bb0aade2c (patch)
tree5c77ab4c23397bcb36bc9add361605296dcd3e0f /doc
parent2afe62952c52e9dc9cbd413db9a316ae4359c331 (diff)
downloadminetest-08846cd05cd402cc7f8d025aaba96c5bb0aade2c.tar.gz
minetest-08846cd05cd402cc7f8d025aaba96c5bb0aade2c.tar.bz2
minetest-08846cd05cd402cc7f8d025aaba96c5bb0aade2c.zip
Add static_save property to luaentites to not save them statically. (#5112)
* Add no_static_save property to luaentites to not save them statically. This allows for temporary objects that would get deleted anyway as soon as they are loaded again without the static saving overhead. * Use positive meaning for static_save object property * Invert meaning also for the LUA parameter Note: getboolfield() does not change &result when field does not exist, so it defaults to the default value in the header file, which is 'true'. * Extend push_object_properties()
Diffstat (limited to 'doc')
-rw-r--r--doc/lua_api.txt4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index 812b857f7..cd93ffc16 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -4199,6 +4199,10 @@ Definition tables
nametag = "", -- by default empty, for players their name is shown if empty
nametag_color = <color>, -- sets color of nametag as ColorSpec
infotext = "", -- by default empty, text to be shown when pointed at object
+ static_save = true,
+ -- ^ If false, never save this object statically. It will simply be deleted when the block gets unloaded.
+ -- ^ The get_staticdata() callback is never called then.
+ -- ^ Defaults to 'true'
}
### Entity definition (`register_entity`)