aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Zenz <Robert.Zenz@bonsaimind.org>2016-01-07 23:16:56 +0100
committerparamat <mat.gregory@virginmedia.com>2016-01-09 01:07:03 +0000
commit386d190e0915a7ed270c313b4e9998f25d219e41 (patch)
treecce26b868d648f2269f9f8507b902d0261c5e174
parent95c1b66722bbad9e82ef14bcc53d31d035b49012 (diff)
downloadminetest-386d190e0915a7ed270c313b4e9998f25d219e41.tar.gz
minetest-386d190e0915a7ed270c313b4e9998f25d219e41.tar.bz2
minetest-386d190e0915a7ed270c313b4e9998f25d219e41.zip
Clarified what get_node does.
-rw-r--r--doc/lua_api.txt6
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index 2ef25a9bd..9088bd69d 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -1958,9 +1958,11 @@ and `minetest.auth_reload` call the authetification handler.
* `minetest.remove_node(pos)`
* Equivalent to `set_node(pos, "air")`
* `minetest.get_node(pos)`
- * Returns `{name="ignore", ...}` for unloaded area
+ * Returns the node at the given position as table in the format
+ `{name="node_name", param1=0, param2=0}`, returns `{name="ignore", param1=0, param2=0}`
+ for unloaded areas.
* `minetest.get_node_or_nil(pos)`
- * Returns `nil` for unloaded area
+ * Same as `get_node` but returns `nil` for unloaded areas.
* `minetest.get_node_light(pos, timeofday)`
* Gets the light value at the given position. Note that the light value
"inside" the node at the given position is returned, so you usually want