From: paramat Date: Sun, 4 Mar 2018 18:47:39 +0000 (+0000) Subject: Gennotify docs: Clarify returned positions for decorations X-Git-Tag: 5.0.0~542 X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=1137f469e2cec17708756d5263c3ffdbf6174099;p=oweals%2Fminetest.git Gennotify docs: Clarify returned positions for decorations --- 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: