src/script/lua_api/l_inventory.h

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #pragma once
  21
  22 #include "lua_api/l_base.h"
  23
  24 #include "inventory.h"
  25 #include "inventorymanager.h"
  26
  27 class RemotePlayer;
  28
  29 /*
  30         InvRef
  31 */
  32
  33 class InvRef : public ModApiBase {
  34 private:
  35         InventoryLocation m_loc;
  36
  37         static const char className[];
  38         static const luaL_Reg methods[];
  39
  40         static InvRef *checkobject(lua_State *L, int narg);
  41
  42         static Inventory* getinv(lua_State *L, InvRef *ref);
  43
  44         static InventoryList* getlist(lua_State *L, InvRef *ref,
  45                         const char *listname);
  46
  47         static void reportInventoryChange(lua_State *L, InvRef *ref);
  48
  49         // Exported functions
  50
  51         // garbage collector
  52         static int gc_object(lua_State *L);
  53
  54         // is_empty(self, listname) -> true/false
  55         static int l_is_empty(lua_State *L);
  56
  57         // get_size(self, listname)
  58         static int l_get_size(lua_State *L);
  59
  60         // get_width(self, listname)
  61         static int l_get_width(lua_State *L);
  62
  63         // set_size(self, listname, size)
  64         static int l_set_size(lua_State *L);
  65
  66         // set_width(self, listname, size)
  67         static int l_set_width(lua_State *L);
  68
  69         // get_stack(self, listname, i) -> itemstack
  70         static int l_get_stack(lua_State *L);
  71
  72         // set_stack(self, listname, i, stack) -> true/false
  73         static int l_set_stack(lua_State *L);
  74
  75         // get_list(self, listname) -> list or nil
  76         static int l_get_list(lua_State *L);
  77
  78         // set_list(self, listname, list)
  79         static int l_set_list(lua_State *L);
  80
  81         // get_lists(self) -> list of InventoryLists
  82         static int l_get_lists(lua_State *L);
  83
  84         // set_lists(self, lists)
  85         static int l_set_lists(lua_State *L);
  86
  87         // add_item(self, listname, itemstack or itemstring or table or nil) -> itemstack
  88         // Returns the leftover stack
  89         static int l_add_item(lua_State *L);
  90
  91         // room_for_item(self, listname, itemstack or itemstring or table or nil) -> true/false
  92         // Returns true if the item completely fits into the list
  93         static int l_room_for_item(lua_State *L);
  94
  95         // contains_item(self, listname, itemstack or itemstring or table or nil, [match_meta]) -> true/false
  96         // Returns true if the list contains the given count of the given item name
  97         static int l_contains_item(lua_State *L);
  98
  99         // remove_item(self, listname, itemstack or itemstring or table or nil) -> itemstack
 100         // Returns the items that were actually removed
 101         static int l_remove_item(lua_State *L);
 102
 103         // get_location() -> location (like get_inventory(location))
 104         static int l_get_location(lua_State *L);
 105
 106 public:
 107         InvRef(const InventoryLocation &loc);
 108
 109         ~InvRef() = default;
 110
 111         // Creates an InvRef and leaves it on top of stack
 112         // Not callable from Lua; all references are created on the C side.
 113         static void create(lua_State *L, const InventoryLocation &loc);
 114         static void Register(lua_State *L);
 115 };
 116
 117 class ModApiInventory : public ModApiBase {
 118 private:
 119         static int l_create_detached_inventory_raw(lua_State *L);
 120
 121         static int l_remove_detached_inventory_raw(lua_State *L);
 122
 123         static int l_get_inventory(lua_State *L);
 124
 125 public:
 126         static void Initialize(lua_State *L, int top);
 127 };