aboutsummaryrefslogtreecommitdiff
path: root/doc/lua_api.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/lua_api.txt')
-rw-r--r--doc/lua_api.txt6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index d3165b9fd..cb2f685e2 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -2040,6 +2040,12 @@ Some of the values in the key-value store are handled specially:
* `palette_index`: If the item has a palette, this is used to get the
current color from the palette.
+Item metadata is usually not fully sent to client (except the client has
+local map saving enabled or it is disabled globaly by the server). Only
+the fields `description`, `short_description`, `color`, `palette_index`
+and `tool_capabilities` are always sent. If there are any other fields,
+they will be hashed into an additional `_hash` field.
+
Example:
local meta = stack:get_meta()