lua: inventory library

src/logic/scripting/LuaState.cpp

@@ -94,6 +94,7 @@ void lua::LuaState::createFuncs() {
     openlib("pack", packlib, 0);
     openlib("world", worldlib, 0);
     openlib("player", playerlib, 0);
+    openlib("inventory", inventorylib, 0);
     openlib("item", itemlib, 0);
     openlib("time", timelib, 0);
     openlib("file", filelib, 0);

src/logic/scripting/api_lua.h

@@ -17,7 +17,9 @@
 #include "../../voxels/Chunks.h"
 #include "../../voxels/voxel.h"
 #include "../../items/ItemDef.h"
+#include "../../items/ItemStack.h"
 #include "../../items/Inventory.h"
+#include "../../items/Inventories.h"
 #include "../../lighting/Lighting.h"
 #include "../../logic/BlocksController.h"
 #include "../../window/Window.h"
@@ -229,7 +231,83 @@ static const luaL_Reg playerlib [] = {
     {NULL, NULL}
 };
 
-/* == items-related functions == */
+static void validate_itemid(lua_State* L, itemid_t id) {
+    if (id >= scripting::indices->countItemDefs()) {
+        luaL_error(L, "invalid item id");
+    }
+}
+
+/* == inventory library == */
+static int l_inventory_get(lua_State* L) {
+    lua::luaint invid = lua_tointeger(L, 1);
+    lua::luaint slotid = lua_tointeger(L, 2);
+    auto inv = scripting::level->inventories->get(invid);
+    if (inv == nullptr) {
+        luaL_error(L, "inventory does not exists in runtime: %d", invid);
+    }
+    if (slotid < 0 || uint64_t(slotid) >= inv->size()) {
+        luaL_error(L, "slot index is out of range [0, inventory.size(invid)]");
+    }
+    ItemStack& item = inv->getSlot(slotid);
+    lua_pushinteger(L, item.getItemId());
+    lua_pushinteger(L, item.getCount());
+    return 2;
+}
+
+static int l_inventory_set(lua_State* L) {
+    lua::luaint invid = lua_tointeger(L, 1);
+    lua::luaint slotid = lua_tointeger(L, 2);
+    lua::luaint itemid = lua_tointeger(L, 3);
+    lua::luaint count = lua_tointeger(L, 4);
+    validate_itemid(L, itemid);
+
+    auto inv = scripting::level->inventories->get(invid);
+    if (inv == nullptr) {
+        luaL_error(L, "inventory does not exists in runtime: %d", invid);
+    }
+    if (slotid < 0 || uint64_t(slotid) >= inv->size()) {
+        luaL_error(L, "slot index is out of range [0, inventory.size(invid)]");
+    }
+    ItemStack& item = inv->getSlot(slotid);
+    item.set(ItemStack(itemid, count));
+    return 0;
+}
+
+static int l_inventory_size(lua_State* L) {
+    lua::luaint invid = lua_tointeger(L, 1);
+    auto inv = scripting::level->inventories->get(invid);
+    if (inv == nullptr) {
+        luaL_error(L, "inventory does not exists in runtime: %d", invid);
+    }
+    lua_pushinteger(L, inv->size());
+    return 1;
+}
+
+static int l_inventory_add(lua_State* L) {
+    lua::luaint invid = lua_tointeger(L, 1);
+    lua::luaint itemid = lua_tointeger(L, 2);
+    lua::luaint count = lua_tointeger(L, 3);
+    validate_itemid(L, itemid);
+
+    auto inv = scripting::level->inventories->get(invid);
+    if (inv == nullptr) {
+        luaL_error(L, "inventory does not exists in runtime: %d", invid);
+    }
+    ItemStack item(itemid, count);
+    inv->move(item, scripting::indices);
+    lua_pushinteger(L, item.getCount());
+    return 1;
+}
+
+static const luaL_Reg inventorylib [] = {
+    {"get", l_inventory_get},
+    {"set", l_inventory_set},
+    {"size", l_inventory_size},
+    {"add", l_inventory_add},
+    {NULL, NULL}
+};
+
+/* == item library == */
 static int l_item_name(lua_State* L) {
     auto indices = scripting::content->getIndices();
     lua::luaint id = lua_tointeger(L, 1);

src/logic/scripting/scripting.h

@@ -9,7 +9,7 @@ class LuaState;
 
 class Engine;
 class Content;
-class ContentPack;
+struct ContentPack;
 class ContentIndices;
 class Level;
 class Block;
@@ -29,6 +29,7 @@ namespace scripting {
     extern Level* level;
     extern BlocksController* blocks;
 
+    /* Lua environment wrapper for automatic deletion */
     class Environment {
         int env;
     public:
@@ -64,13 +65,28 @@ namespace scripting {
     void on_block_placed(Player* player, const Block* block, int x, int y, int z);
     void on_block_broken(Player* player, const Block* block, int x, int y, int z);
     bool on_block_interact(Player* player, const Block* block, int x, int y, int z);
+
+    /* Called on RMB click on block with the item selected 
+       @return true if prevents default action */
     bool on_item_use_on_block(Player* player, const ItemDef* item, int x, int y, int z);
+    /* Called on LMB click on block with the item selected 
+       @return true if prevents default action */
     bool on_item_break_block(Player* player, const ItemDef* item, int x, int y, int z);
+
+    /* Called on UI view show */
     void on_ui_open(UiDocument* layout, Inventory* inventory);
+    /* Called on UI view close*/
     void on_ui_close(UiDocument* layout, Inventory* inventory);
+
+    /* Load script associated with a Block */
     void load_block_script(int env, std::string prefix, fs::path file, block_funcs_set& funcsset);
+    /* Load script associated with an Item */
     void load_item_script(int env, std::string prefix, fs::path file, item_funcs_set& funcsset);
+    /* Load package-specific world script */
     void load_world_script(int env, std::string prefix, fs::path file);
+    /* Load script associated with an UiDocument */
     void load_layout_script(int env, std::string prefix, fs::path file, uidocscript& script);
+    /* Finalize lua state. Using scripting after will lead to Lua panic */
+
     void close();
 }