Gennotify docs: Clarify returned positions for decorations
authorparamat <paramat@users.noreply.github.com>
Sun, 4 Mar 2018 18:47:39 +0000 (18:47 +0000)
committerparamat <mat.gregory@virginmedia.com>
Fri, 9 Mar 2018 03:16:34 +0000 (03:16 +0000)
doc/lua_api.txt

index 570906a89fc2d6b9ec45a3515cecbff6cb5adf0b..07ed27cdfcb2274650b82acc4efb92216bbcb336 100644 (file)
@@ -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: