summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex <24834740+GreenXenith@users.noreply.github.com>2019-07-26 10:43:54 -0700
committerSmallJoker <SmallJoker@users.noreply.github.com>2019-07-26 19:43:54 +0200
commita8446d29e8b7dd00afc542fc19a3fc3354a669b8 (patch)
treeb020abe09a13d8ae152527eda437d6a117feb75e
parentaf728769214b8a0aa9ec0f46494db4a2cf76b7d9 (diff)
downloadminetest-a8446d29e8b7dd00afc542fc19a3fc3354a669b8.tar.gz
minetest-a8446d29e8b7dd00afc542fc19a3fc3354a669b8.tar.bz2
minetest-a8446d29e8b7dd00afc542fc19a3fc3354a669b8.zip
Document 'wield_item' entity property (#8694)
-rw-r--r--doc/lua_api.txt4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index c453a5dd2..be5eddd8a 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -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},