Lua_api.txt: Clarify entity 'initial_properties' and related deprecat…

…ion (#7596)
minetest · Jul 29, 2018 · bf45644 · bf45644
1 parent 0e1915c
commit bf45644
Showing 1 changed file with 9 additions and 4 deletions.
diff --git 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),