aboutsummaryrefslogtreecommitdiff
path: root/doc/client_lua_api.txt
diff options
context:
space:
mode:
authorElias Fleckenstein <eliasfleckenstein@web.de>2020-10-19 13:09:38 +0200
committerElias Fleckenstein <eliasfleckenstein@web.de>2020-10-19 13:09:38 +0200
commitf1ff05bf5932a7825509dbe896e60183a96a6d36 (patch)
tree73f2e361a7fd8010345880071aa29f0495171879 /doc/client_lua_api.txt
parent35da7306dcd07fd43252468cdf71c9d8c09faeeb (diff)
downloaddragonfireclient-f1ff05bf5932a7825509dbe896e60183a96a6d36.tar.xz
Added ThroughWalls, InventoryActions API and AutoTotem
Diffstat (limited to 'doc/client_lua_api.txt')
-rw-r--r--doc/client_lua_api.txt46
1 files changed, 46 insertions, 0 deletions
diff --git a/doc/client_lua_api.txt b/doc/client_lua_api.txt
index 735173580..50c33940e 100644
--- a/doc/client_lua_api.txt
+++ b/doc/client_lua_api.txt
@@ -1012,6 +1012,9 @@ Passed to `HTTPApiTable.fetch` callback. Returned by
* e.g. minetest.set_keypress("jump", true) will cause te player to jump until minetest.set_keypress("jump", false) is called or the player presses & releases the space bar himself
* `minetest.get_inventory(location)`
* Returns the inventory at location
+* `minetest.find_item(item)`
+ * finds and an item in the inventory
+ * returns index on success or nil if item is not found
* `minetest.switch_to_item(item)`
* `item` is an Itemstring
* searches to item in inventory, sets the wield index to it if found
@@ -1706,3 +1709,46 @@ Same as `image`, but does not accept a `position`; the position is instead deter
-- ^ Uses texture (string)
}
+### InventoryAction
+A reference to a C++ InventoryAction. You can move, drop and craft items in all accessible inventories using InventoryActions.
+
+#### methods
+
+* `InventoryAction(type)`:
+ * creates a new InventoryAction
+ * type is on of "move", "drop", or "craft", else returns nil
+* `apply()`:
+ * applies the InventoryAction (InventoryActions can be applied multible times)
+* `from(inventorylocation, listname, stack)`
+ * this is valid for move or drop actions
+ * when `apply()` is called items are moved / dropped from `listname` `inventorylocation` in` at `stack`
+* `to(inventorylocation, listname, stack)`
+ * this is valid for move actions
+ * when `apply()` is called items are moved to `listname` in`inventorylocation` at `stack`
+* `craft(inventoryaction)`
+ * this is valid for craft actions
+ * when `apply()` is called a craft event for this inventory will be triggered
+* `set_count(count)`
+ * this is valid for all actions
+ * it specifies how many items to drop / craft / move
+ * `0` means move all items
+ * default count: `0`
+
+#### example
+ `local move_act = InventoryAction("move")
+ move_act:from("current_player", "main", 0)
+ move_act:to("current_player", "craft", 0)
+ move_act:set_count(1)
+ local craft_act = InventoryAction("craft")
+ craft_act:craft("current_player")
+ local drop_act = InventoryAction("drop")
+ drop_act:from("current_player", "craft", 0)
+ move_act:apply()
+ craft_act:apply()
+ drop_act:apply()
+ `
+ * e.g. In first hotbar slot there are tree logs: Move one to craft field, then craft wood out of it and immediately drop it
+
+
+
+