aboutsummaryrefslogtreecommitdiff
path: root/doc/lua_api.txt
diff options
context:
space:
mode:
authorJude Melton-Houghton <jwmhjwmh@gmail.com>2022-11-24 17:56:43 -0500
committerGitHub <noreply@github.com>2022-11-24 17:56:43 -0500
commit8817af07fb72fd78fb753fe5d069d0a65a79742f (patch)
tree57b4fc5c96aa4065479a79bcb6001075f9091b72 /doc/lua_api.txt
parent3c7f26d93721d8d86ca5d9e894e8652b1e2a8672 (diff)
downloadminetest-8817af07fb72fd78fb753fe5d069d0a65a79742f.tar.xz
Deprecate special handling of `${key}` syntax in metadata values (#12970)
Diffstat (limited to 'doc/lua_api.txt')
-rw-r--r--doc/lua_api.txt5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index 1630b06dc..1c8cc1022 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -6861,6 +6861,11 @@ Can be obtained via `item:get_meta()`.
Base class used by [`StorageRef`], [`NodeMetaRef`], [`ItemStackMetaRef`],
and [`PlayerMetaRef`].
+Note: If a metadata value is in the format `${k}`, an attempt to get the value
+will return the value associated with key `k`. There is a low recursion limit.
+This behavior is **deprecated** and will be removed in a future version. Usage
+of the `${k}` syntax in formspecs is not deprecated.
+
### Methods
* `contains(key)`: Returns true if key present, otherwise false.