aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorparamat <paramat@users.noreply.github.com>2018-03-04 18:47:39 +0000
committerparamat <mat.gregory@virginmedia.com>2018-03-09 03:16:34 +0000
commit1137f469e2cec17708756d5263c3ffdbf6174099 (patch)
treeb358bdeb27f1a5093b7aa477085b00611dc9f064
parentf091de9a2fb0e6d5861999705b9a555f07e02265 (diff)
downloadminetest-1137f469e2cec17708756d5263c3ffdbf6174099.tar.gz
minetest-1137f469e2cec17708756d5263c3ffdbf6174099.tar.bz2
minetest-1137f469e2cec17708756d5263c3ffdbf6174099.zip
Gennotify docs: Clarify returned positions for decorations
-rw-r--r--doc/lua_api.txt5
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index 570906a89..07ed27cdf 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -4317,9 +4317,12 @@ generated chunk by the current mapgen.
### `gennotify`
Returns a table mapping requested generation notification types to arrays of
-positions at which the corresponding generated structures are located at within
+positions at which the corresponding generated structures are located within
the current chunk. To set the capture of positions of interest to be recorded
on generate, use `minetest.set_gen_notify()`.
+For decorations, the returned positions are the ground surface 'place_on' nodes,
+not the decorations themselves. A 'simple' type decoration is often 1 node above
+the returned position and possibly displaced by 'place_offset_y'.
Possible fields of the table returned are: