src/inventory.h

   1 /*
   2 Minetest
   3 Copyright (C) 2010-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 #ifndef INVENTORY_HEADER
  21 #define INVENTORY_HEADER
  22
  23 #include "debug.h"
  24 #include "itemdef.h"
  25 #include "irrlichttypes.h"
  26 #include <istream>
  27 #include <ostream>
  28 #include <string>
  29 #include <vector>
  30
  31 struct ToolCapabilities;
  32
  33 struct ItemStack
  34 {
  35         ItemStack(): name(""), count(0), wear(0), metadata("") {}
  36         ItemStack(std::string name_, u16 count_,
  37                         u16 wear, std::string metadata_,
  38                         IItemDefManager *itemdef);
  39         ~ItemStack() {}
  40
  41         // Serialization
  42         void serialize(std::ostream &os) const;
  43         // Deserialization.  Pass itemdef unless you don't want aliases resolved.
  44         void deSerialize(std::istream &is, IItemDefManager *itemdef = NULL);
  45         void deSerialize(const std::string &s, IItemDefManager *itemdef = NULL);
  46
  47         // Returns the string used for inventory
  48         std::string getItemString() const;
  49
  50         /*
  51                 Quantity methods
  52         */
  53
  54         bool empty() const
  55         {
  56                 return count == 0;
  57         }
  58
  59         void clear()
  60         {
  61                 name = "";
  62                 count = 0;
  63                 wear = 0;
  64                 metadata = "";
  65         }
  66
  67         void add(u16 n)
  68         {
  69                 count += n;
  70         }
  71
  72         void remove(u16 n)
  73         {
  74                 assert(count >= n); // Pre-condition
  75                 count -= n;
  76                 if(count == 0)
  77                         clear(); // reset name, wear and metadata too
  78         }
  79
  80         // Maximum size of a stack
  81         u16 getStackMax(IItemDefManager *itemdef) const
  82         {
  83                 return itemdef->get(name).stack_max;
  84         }
  85
  86         // Number of items that can be added to this stack
  87         u16 freeSpace(IItemDefManager *itemdef) const
  88         {
  89                 u16 max = getStackMax(itemdef);
  90                 if (count >= max)
  91                         return 0;
  92                 return max - count;
  93         }
  94
  95         // Returns false if item is not known and cannot be used
  96         bool isKnown(IItemDefManager *itemdef) const
  97         {
  98                 return itemdef->isKnown(name);
  99         }
 100
 101         // Returns a pointer to the item definition struct,
 102         // or a fallback one (name="unknown") if the item is unknown.
 103         const ItemDefinition& getDefinition(
 104                         IItemDefManager *itemdef) const
 105         {
 106                 return itemdef->get(name);
 107         }
 108
 109         // Get tool digging properties, or those of the hand if not a tool
 110         const ToolCapabilities& getToolCapabilities(
 111                         IItemDefManager *itemdef) const
 112         {
 113                 ToolCapabilities *cap;
 114                 cap = itemdef->get(name).tool_capabilities;
 115                 if(cap == NULL)
 116                         cap = itemdef->get("").tool_capabilities;
 117                 assert(cap != NULL);
 118                 return *cap;
 119         }
 120
 121         // Wear out (only tools)
 122         // Returns true if the item is (was) a tool
 123         bool addWear(s32 amount, IItemDefManager *itemdef)
 124         {
 125                 if(getDefinition(itemdef).type == ITEM_TOOL)
 126                 {
 127                         if(amount > 65535 - wear)
 128                                 clear();
 129                         else if(amount < -wear)
 130                                 wear = 0;
 131                         else
 132                                 wear += amount;
 133                         return true;
 134                 }
 135                 else
 136                 {
 137                         return false;
 138                 }
 139         }
 140
 141         // If possible, adds newitem to this item.
 142         // If cannot be added at all, returns the item back.
 143         // If can be added partly, decremented item is returned back.
 144         // If can be added fully, empty item is returned.
 145         ItemStack addItem(const ItemStack &newitem,
 146                         IItemDefManager *itemdef);
 147
 148         // Checks whether newitem could be added.
 149         // If restitem is non-NULL, it receives the part of newitem that
 150         // would be left over after adding.
 151         bool itemFits(const ItemStack &newitem,
 152                         ItemStack *restitem,  // may be NULL
 153                         IItemDefManager *itemdef) const;
 154
 155         // Takes some items.
 156         // If there are not enough, takes as many as it can.
 157         // Returns empty item if couldn't take any.
 158         ItemStack takeItem(u32 takecount);
 159
 160         // Similar to takeItem, but keeps this ItemStack intact.
 161         ItemStack peekItem(u32 peekcount) const;
 162
 163         /*
 164                 Properties
 165         */
 166         std::string name;
 167         u16 count;
 168         u16 wear;
 169         std::string metadata;
 170 };
 171
 172 class InventoryList
 173 {
 174 public:
 175         InventoryList(std::string name, u32 size, IItemDefManager *itemdef);
 176         ~InventoryList();
 177         void clearItems();
 178         void setSize(u32 newsize);
 179         void setWidth(u32 newWidth);
 180         void setName(const std::string &name);
 181         void serialize(std::ostream &os) const;
 182         void deSerialize(std::istream &is);
 183
 184         InventoryList(const InventoryList &other);
 185         InventoryList & operator = (const InventoryList &other);
 186         bool operator == (const InventoryList &other) const;
 187         bool operator != (const InventoryList &other) const
 188         {
 189                 return !(*this == other);
 190         }
 191
 192         const std::string &getName() const;
 193         u32 getSize() const;
 194         u32 getWidth() const;
 195         // Count used slots
 196         u32 getUsedSlots() const;
 197         u32 getFreeSlots() const;
 198
 199         // Get reference to item
 200         const ItemStack& getItem(u32 i) const;
 201         ItemStack& getItem(u32 i);
 202         // Returns old item. Parameter can be an empty item.
 203         ItemStack changeItem(u32 i, const ItemStack &newitem);
 204         // Delete item
 205         void deleteItem(u32 i);
 206
 207         // Adds an item to a suitable place. Returns leftover item (possibly empty).
 208         ItemStack addItem(const ItemStack &newitem);
 209
 210         // If possible, adds item to given slot.
 211         // If cannot be added at all, returns the item back.
 212         // If can be added partly, decremented item is returned back.
 213         // If can be added fully, empty item is returned.
 214         ItemStack addItem(u32 i, const ItemStack &newitem);
 215
 216         // Checks whether the item could be added to the given slot
 217         // If restitem is non-NULL, it receives the part of newitem that
 218         // would be left over after adding.
 219         bool itemFits(const u32 i, const ItemStack &newitem,
 220                         ItemStack *restitem = NULL) const;
 221
 222         // Checks whether there is room for a given item
 223         bool roomForItem(const ItemStack &item) const;
 224
 225         // Checks whether the given count of the given item name
 226         // exists in this inventory list.
 227         bool containsItem(const ItemStack &item) const;
 228
 229         // Removes the given count of the given item name from
 230         // this inventory list. Walks the list in reverse order.
 231         // If not as many items exist as requested, removes as
 232         // many as possible.
 233         // Returns the items that were actually removed.
 234         ItemStack removeItem(const ItemStack &item);
 235
 236         // Takes some items from a slot.
 237         // If there are not enough, takes as many as it can.
 238         // Returns empty item if couldn't take any.
 239         ItemStack takeItem(u32 i, u32 takecount);
 240
 241         // Similar to takeItem, but keeps the slot intact.
 242         ItemStack peekItem(u32 i, u32 peekcount) const;
 243
 244         // Move an item to a different list (or a different stack in the same list)
 245         // count is the maximum number of items to move (0 for everything)
 246         // returns number of moved items
 247         u32 moveItem(u32 i, InventoryList *dest, u32 dest_i,
 248                 u32 count = 0, bool swap_if_needed = true, bool *did_swap = NULL);
 249
 250         // like moveItem, but without a fixed destination index
 251         // also with optional rollback recording
 252         void moveItemSomewhere(u32 i, InventoryList *dest, u32 count);
 253
 254 private:
 255         std::vector<ItemStack> m_items;
 256         u32 m_size, m_width;
 257         std::string m_name;
 258         IItemDefManager *m_itemdef;
 259 };
 260
 261 class Inventory
 262 {
 263 public:
 264         ~Inventory();
 265
 266         void clear();
 267         void clearContents();
 268
 269         Inventory(IItemDefManager *itemdef);
 270         Inventory(const Inventory &other);
 271         Inventory & operator = (const Inventory &other);
 272         bool operator == (const Inventory &other) const;
 273         bool operator != (const Inventory &other) const
 274         {
 275                 return !(*this == other);
 276         }
 277
 278         void serialize(std::ostream &os) const;
 279         void deSerialize(std::istream &is);
 280
 281         InventoryList * addList(const std::string &name, u32 size);
 282         InventoryList * getList(const std::string &name);
 283         const InventoryList * getList(const std::string &name) const;
 284         std::vector<const InventoryList*> getLists();
 285         bool deleteList(const std::string &name);
 286         // A shorthand for adding items. Returns leftover item (possibly empty).
 287         ItemStack addItem(const std::string &listname, const ItemStack &newitem)
 288         {
 289                 m_dirty = true;
 290                 InventoryList *list = getList(listname);
 291                 if(list == NULL)
 292                         return newitem;
 293                 return list->addItem(newitem);
 294         }
 295
 296         bool checkModified() const
 297         {
 298                 return m_dirty;
 299         }
 300
 301         void setModified(const bool x)
 302         {
 303                 m_dirty = x;
 304         }
 305
 306 private:
 307         // -1 if not found
 308         const s32 getListIndex(const std::string &name) const;
 309
 310         std::vector<InventoryList*> m_lists;
 311         IItemDefManager *m_itemdef;
 312         bool m_dirty;
 313 };
 314
 315 #endif
 316