From fe6575b8d38b29026adb9bf3d6226b5b3ceb4cab Mon Sep 17 00:00:00 2001
From: Robert Zenz <Robert.Zenz@bonsaimind.org>
Date: Mon, 7 Sep 2015 18:51:45 +0200
Subject: [PATCH] Add more information about how get_node_light works.
---
doc/lua_api.txt | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index 5372cb834..b07d046c4 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -1914,9 +1914,13 @@ and `minetest.auth_reload` call the authetification handler.
* Returns `{name="ignore", ...}` for unloaded area
* `minetest.get_node_or_nil(pos)`
* Returns `nil` for unloaded area
-* `minetest.get_node_light(pos, timeofday)` returns a number between `0` and `15` or `nil`
+* `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
+ to get the light value of a neighbor.
+ * `pos`: The position where to measure the light.
* `timeofday`: `nil` for current time, `0` for night, `0.5` for day
-
+ * Returns a number between `0` and `15` or `nil`
* `minetest.place_node(pos, node)`
* Place node with the same effects that a player would cause
* `minetest.dig_node(pos)`
--
GitLab