Skip to content

Commit 1137f46

Browse files
committed
Gennotify docs: Clarify returned positions for decorations
1 parent f091de9 commit 1137f46

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

doc/lua_api.txt

+4-1
Original file line numberDiff line numberDiff line change
@@ -4317,9 +4317,12 @@ generated chunk by the current mapgen.
43174317

43184318
### `gennotify`
43194319
Returns a table mapping requested generation notification types to arrays of
4320-
positions at which the corresponding generated structures are located at within
4320+
positions at which the corresponding generated structures are located within
43214321
the current chunk. To set the capture of positions of interest to be recorded
43224322
on generate, use `minetest.set_gen_notify()`.
4323+
For decorations, the returned positions are the ground surface 'place_on' nodes,
4324+
not the decorations themselves. A 'simple' type decoration is often 1 node above
4325+
the returned position and possibly displaced by 'place_offset_y'.
43234326

43244327
Possible fields of the table returned are:
43254328

0 commit comments

Comments
 (0)