Clarified what get_node does.
authorRobert Zenz <Robert.Zenz@bonsaimind.org>
Thu, 7 Jan 2016 22:16:56 +0000 (23:16 +0100)
committerparamat <mat.gregory@virginmedia.com>
Sat, 9 Jan 2016 01:07:03 +0000 (01:07 +0000)
doc/lua_api.txt

index 2ef25a9bd0945bd73fccdf4f4c1c487f2a25f568..9088bd69d6f1e1e3007b1b8ad6f2d2d4b29cedc0 100644 (file)
@@ -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