summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSmallJoker <SmallJoker@users.noreply.github.com>2018-03-29 21:44:13 +0200
committerGitHub <noreply@github.com>2018-03-29 21:44:13 +0200
commit8f827ee6800974ee451f0e82ac5eafdff63b835e (patch)
treeac8d57b47b1a1593a72ad90005aa5b7a38a53e37 /doc
parent376ed5cd3c0c61135230a2a14b873436d551d266 (diff)
downloadminetest-8f827ee6800974ee451f0e82ac5eafdff63b835e.tar.gz
minetest-8f827ee6800974ee451f0e82ac5eafdff63b835e.tar.bz2
minetest-8f827ee6800974ee451f0e82ac5eafdff63b835e.zip
core.rotate_node: Do not trigger after_place_node (#6900)
Diffstat (limited to 'doc')
-rw-r--r--doc/lua_api.txt23
1 files changed, 14 insertions, 9 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index 946340cb3..69c4b3262 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -3461,9 +3461,11 @@ You can find mod channels communication scheme in `docs/mod_channels.png`.
### Defaults for the `on_*` item definition functions
These functions return the leftover itemstack.
-* `minetest.item_place_node(itemstack, placer, pointed_thing, param2)`
+* `minetest.item_place_node(itemstack, placer, pointed_thing[, param2, prevent_after_place])`
* Place item as a node
* `param2` overrides `facedir` and wallmounted `param2`
+ * `prevent_after_place`: if set to `true`, `after_place_node` is not called
+ for the newly placed node to prevent a callback and placement loop
* returns `itemstack, success`
* `minetest.item_place_object(itemstack, placer, pointed_thing)`
* Place item as-is
@@ -3784,13 +3786,14 @@ These functions return the leftover itemstack.
* Like `minetest.is_protected`, this function may be extended or
overwritten by mods to provide a faster implementation to check the
cuboid for intersections.
-* `minetest.rotate_and_place(itemstack, placer, pointed_thing, infinitestacks, orient_flags)`
+* `minetest.rotate_and_place(itemstack, placer, pointed_thing[, infinitestacks,
+ orient_flags, prevent_after_place])`
* Attempt to predict the desired orientation of the facedir-capable node
defined by `itemstack`, and place it accordingly (on-wall, on the floor,
- or hanging from the ceiling). Stacks are handled normally if the
- `infinitestacks` field is false or omitted (else, the itemstack is not
- changed). `orient_flags` is an optional table containing extra tweaks to
- the placement code:
+ or hanging from the ceiling).
+ * `infinitestacks`: if `true`, the itemstack is not changed. Otherwise the
+ stacks are handled normally.
+ * `orient_flags`: Optional table containing extra tweaks to the placement code:
* `invert_wall`: if `true`, place wall-orientation on the ground and
ground-orientation on the wall.
* `force_wall` : if `true`, always place the node in wall orientation.
@@ -3800,10 +3803,12 @@ These functions return the leftover itemstack.
when placing on the floor or ceiling.
* The first four options are mutually-exclusive; the last in the list
takes precedence over the first.
+ * `prevent_after_place` is directly passed to `minetest.item_place_node`
+ * Returns the new itemstack after placement
* `minetest.rotate_node(itemstack, placer, pointed_thing)`
- * calls `rotate_and_place()` with infinitestacks set according to the state
- of the creative mode setting, and checks for "sneak" to set the
- `invert_wall` parameter.
+ * calls `rotate_and_place()` with `infinitestacks` set according to the state
+ of the creative mode setting, checks for "sneak" to set the `invert_wall`
+ parameter and `prevent_after_place` set to `true`.
* `minetest.forceload_block(pos[, transient])`
* forceloads the position `pos`.