From 000ec260017256016b62bb9936bbda1ff969e252 Mon Sep 17 00:00:00 2001
From: red-001 <red-001@outlook.ie>
Date: Tue, 4 Apr 2017 06:41:37 +0100
Subject: [CSM] Add local node meta reference. (#5508)

---
 doc/client_lua_api.md | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

(limited to 'doc')

diff --git a/doc/client_lua_api.md b/doc/client_lua_api.md
index c9ccbeefa..68156efd3 100644
--- a/doc/client_lua_api.md
+++ b/doc/client_lua_api.md
@@ -690,6 +690,8 @@ Call these functions only at load time!
       for unloaded areas.
 * `minetest.get_node_or_nil(pos)`
     * Same as `get_node` but returns `nil` for unloaded areas.
+* `minetest.get_meta(pos)`
+    * Get a `NodeMetaRef` at that position
 
 ### Player
 * `minetest.get_wielded_item()`
@@ -794,7 +796,18 @@ It can be created via `Settings(filename)`.
     * write changes to file
 * `to_table()`: returns `{[key1]=value1,...}`
 
-Definition tables
+### NodeMetaRef
+Node metadata: reference extra data and functionality stored in a node.
+Can be obtained via `minetest.get_meta(pos)`.
+
+#### Methods
+* `get_string(name)`
+* `get_int(name)`
+* `get_float(name)`
+* `to_table()`: returns `nil` or a table with keys:
+    * `fields`: key-value storage
+    * `inventory`: `{list1 = {}, ...}}`
+
 -----------------
 
 ### Chat command definition (`register_chatcommand`)
-- 
cgit v1.2.3