From: Paramat <paramat@users.noreply.github.com>
Date: Sun, 29 Jul 2018 21:07:55 +0000 (+0100)
Subject: Lua_api.txt: Clarify entity 'initial_properties' and related deprecation (#7596)
X-Git-Tag: 5.0.0~277
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=bf45644041693f959ac95154b00f15aa27b34145;p=oweals%2Fminetest.git

Lua_api.txt: Clarify entity 'initial_properties' and related deprecation (#7596)
---

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),