summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorParamat <paramat@users.noreply.github.com>2018-07-29 22:07:55 +0100
committerGitHub <noreply@github.com>2018-07-29 22:07:55 +0100
commitbf45644041693f959ac95154b00f15aa27b34145 (patch)
tree794cb8e77acff881cc37a395f298977d9465b993 /doc
parent0e1915cf47d87434713a96c1751e0928e13ee8d4 (diff)
downloadminetest-bf45644041693f959ac95154b00f15aa27b34145.tar.gz
minetest-bf45644041693f959ac95154b00f15aa27b34145.tar.bz2
minetest-bf45644041693f959ac95154b00f15aa27b34145.zip
Lua_api.txt: Clarify entity 'initial_properties' and related deprecation (#7596)
Diffstat (limited to 'doc')
-rw-r--r--doc/lua_api.txt13
1 files changed, 9 insertions, 4 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index 1f103c853..763393e34 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -5280,10 +5280,15 @@ Entity definition
Used by `minetest.register_entity`.
{
- -- Deprecated: Everything in object properties is read directly from here
-
- initial_properties = --[[<initial object properties>]],
-
+ initial_properties = {
+ visual = "mesh",
+ mesh = "boats_boat.obj",
+ ...,
+ },
+ -- ^ A table of object properties, see the `Object properties` section.
+ -- ^ Object properties being read directly from the entity definition
+ -- table is deprecated. Define object properties in this
+ -- `initial_properties` table instead.
on_activate = function(self, staticdata, dtime_s),
on_step = function(self, dtime),
on_punch = function(self, puncher, time_from_last_punch, tool_capabilities, dir),