Add pointed_thing to lua_api.txt
authorPerttu Ahola <celeron55@gmail.com>
Sun, 17 Jun 2012 16:47:55 +0000 (19:47 +0300)
committerPerttu Ahola <celeron55@gmail.com>
Sun, 17 Jun 2012 16:47:55 +0000 (19:47 +0300)
doc/lua_api.txt

index 39267e34e242d3c99f291871b25e32f0e7a95583..511ec7c8ed5a7699f123b9f4d064b82e00a8dd34 100644 (file)
@@ -342,6 +342,11 @@ Position/vector:
 Currently the API does not provide any helper functions for addition,
 subtraction and whatever; you can define those that you need yourself.
 
+pointed_thing:
+  {type="nothing"}
+  {type="node", under=pos, above=pos}
+  {type="object", ref=ObjectRef}
+
 Items
 ------
 Node (register_node):
@@ -1167,8 +1172,10 @@ Item definition (register_node, register_craftitem, register_tool)
       actual result to client in a short moment.
 
     on_place = func(itemstack, placer, pointed_thing),
+    ^ Shall place item and return the leftover itemstack
     ^ default: minetest.item_place
     on_drop = func(itemstack, dropper, pos),
+    ^ Shall drop item and return the leftover itemstack
     ^ default: minetest.item_drop
     on_use = func(itemstack, user, pointed_thing),
     ^  default: nil