]> git.lizzy.rs Git - minetest.git/commitdiff
Document 'wield_item' entity property (#8694)
authorAlex <24834740+GreenXenith@users.noreply.github.com>
Fri, 26 Jul 2019 17:43:54 +0000 (10:43 -0700)
committerSmallJoker <SmallJoker@users.noreply.github.com>
Fri, 26 Jul 2019 17:43:54 +0000 (19:43 +0200)
doc/lua_api.txt

index c453a5dd204f00600b0790617df14018b5c6d2f4..be5eddd8a61965b9bf9d5b6cd3078d30a8525917 100644 (file)
@@ -5748,7 +5748,7 @@ Used by `ObjectRef` methods. Part of an Entity definition.
         -- "mesh" uses the defined mesh model.
         -- "wielditem" is used for dropped items.
         --   (see builtin/game/item_entity.lua).
-        --   For this use 'textures = {itemname}'.
+        --   For this use 'wield_item = itemname' (Deprecated: 'textures = {itemname}').
         --   If the item has a 'wield_image' the object will be an extrusion of
         --   that, otherwise:
         --   If 'itemname' is a cubic node or nodebox the object will appear
@@ -5757,6 +5757,8 @@ Used by `ObjectRef` methods. Part of an Entity definition.
         --   of its texture.
         --   Otherwise for non-node items, the object will be an extrusion of
         --   'inventory_image'.
+        --   If 'itemname' contains a ColorString or palette index (e.g. from
+        --   `minetest.itemstring_with_palette()`), the entity will inherit the color.
         -- "item" is similar to "wielditem" but ignores the 'wield_image' parameter.
 
         visual_size = {x = 1, y = 1, z = 1},