Document changes

minetest · Apr 9, 2017 · fb9701b · fb9701b
1 parent 67207d2
commit fb9701b
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/builtin/game/item_entity.lua b/builtin/game/item_entity.lua
@@ -53,6 +53,8 @@ core.register_entity(":__builtin:item", {
 		if itemtable then
 			itemname = stack:to_table().name
 		end
+		-- Backwards compatibility: old clients use the texture
+		-- to get the type of the item
 		local item_texture = nil
 		local item_type = ""
 		if core.registered_items[itemname] then

diff --git a/doc/lua_api.txt b/doc/lua_api.txt
@@ -1480,6 +1480,9 @@ Item metadata only contains a key-value store.
 Some of the values in the key-value store are handled specially:
 
 * `description`: Set the itemstack's description. Defaults to idef.description
+* `color`: A `ColorString`, which sets the stack's color.
+* `paletteindex`: If the item has a palette, this is used to get the
+                  current color from the palette.
 
 Example stuff:
 
@@ -3737,6 +3740,19 @@ Definition tables
                             {hard = 1, metal = 1, spikes = 1}
         inventory_image = "default_tool_steelaxe.png",
         wield_image = "",
+        palette = "",
+        --[[
+        ^ An image file containing the palette of a node.
+        ^ You can set the currently used color as the
+        ^ "paletteindex" field of the item stack metadata.
+        ^ The palette is always stretched to fit indices
+        ^ between 0 and 255, to ensure compatibility with
+        ^ "colorfacedir" and "colorwallmounted" nodes.
+        ]]
+        color = "0xFFFFFFFF",
+        --[[
+        ^ The color of the item. The palette overrides this.
+        ]]
         wield_scale = {x = 1, y = 1, z = 1},
         stack_max = 99,
         range = 4.0,