3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
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.
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.
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.
20 #ifndef INVENTORY_HEADER
21 #define INVENTORY_HEADER
27 #include "irrlichttypes_bloated.h"
31 struct ToolCapabilities;
35 ItemStack(): name(""), count(0), wear(0), metadata("") {}
36 ItemStack(std::string name_, u16 count_,
37 u16 wear, std::string metadata_,
38 IItemDefManager *itemdef);
42 void serialize(std::ostream &os) const;
43 void deSerialize(std::istream &is, IItemDefManager *itemdef);
44 void deSerialize(const std::string &s, IItemDefManager *itemdef);
46 // Returns the string used for inventory
47 std::string getItemString() const;
76 clear(); // reset name, wear and metadata too
79 // Maximum size of a stack
80 u16 getStackMax(IItemDefManager *itemdef) const
82 s16 max = itemdef->get(name).stack_max;
83 return (max >= 0) ? max : 0;
86 // Number of items that can be added to this stack
87 u16 freeSpace(IItemDefManager *itemdef) const
89 u16 max = getStackMax(itemdef);
95 // Returns false if item is not known and cannot be used
96 bool isKnown(IItemDefManager *itemdef) const
98 return itemdef->isKnown(name);
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
106 return itemdef->get(name);
109 // Get tool digging properties, or those of the hand if not a tool
110 const ToolCapabilities& getToolCapabilities(
111 IItemDefManager *itemdef) const
113 ToolCapabilities *cap;
114 cap = itemdef->get(name).tool_capabilities;
116 cap = itemdef->get("").tool_capabilities;
121 // Wear out (only tools)
122 // Returns true if the item is (was) a tool
123 bool addWear(s32 amount, IItemDefManager *itemdef)
125 if(getDefinition(itemdef).type == ITEM_TOOL)
127 if(amount > 65535 - wear)
129 else if(amount < -wear)
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);
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;
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);
160 // Similar to takeItem, but keeps this ItemStack intact.
161 ItemStack peekItem(u32 peekcount) const;
169 std::string metadata;
175 InventoryList(std::string name, u32 size, IItemDefManager *itemdef);
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);
184 InventoryList(const InventoryList &other);
185 InventoryList & operator = (const InventoryList &other);
186 bool operator == (const InventoryList &other);
188 const std::string &getName() const;
190 u32 getWidth() const;
192 u32 getUsedSlots() const;
193 u32 getFreeSlots() const;
195 // Get reference to item
196 const ItemStack& getItem(u32 i) const;
197 ItemStack& getItem(u32 i);
198 // Returns old item. Parameter can be an empty item.
199 ItemStack changeItem(u32 i, const ItemStack &newitem);
201 void deleteItem(u32 i);
203 // Adds an item to a suitable place. Returns leftover item (possibly empty).
204 ItemStack addItem(const ItemStack &newitem);
206 // If possible, adds item to given slot.
207 // If cannot be added at all, returns the item back.
208 // If can be added partly, decremented item is returned back.
209 // If can be added fully, empty item is returned.
210 ItemStack addItem(u32 i, const ItemStack &newitem);
212 // Checks whether the item could be added to the given slot
213 // If restitem is non-NULL, it receives the part of newitem that
214 // would be left over after adding.
215 bool itemFits(const u32 i, const ItemStack &newitem,
216 ItemStack *restitem = NULL) const;
218 // Checks whether there is room for a given item
219 bool roomForItem(const ItemStack &item) const;
221 // Checks whether the given count of the given item name
222 // exists in this inventory list.
223 bool containsItem(const ItemStack &item) const;
225 // Removes the given count of the given item name from
226 // this inventory list. Walks the list in reverse order.
227 // If not as many items exist as requested, removes as
229 // Returns the items that were actually removed.
230 ItemStack removeItem(const ItemStack &item);
232 // Takes some items from a slot.
233 // If there are not enough, takes as many as it can.
234 // Returns empty item if couldn't take any.
235 ItemStack takeItem(u32 i, u32 takecount);
237 // Similar to takeItem, but keeps the slot intact.
238 ItemStack peekItem(u32 i, u32 peekcount) const;
240 // Move an item to a different list (or a different stack in the same list)
241 // count is the maximum number of items to move (0 for everything)
242 void moveItem(u32 i, InventoryList *dest, u32 dest_i, u32 count = 0);
245 std::vector<ItemStack> m_items;
248 IItemDefManager *m_itemdef;
257 void clearContents();
259 Inventory(IItemDefManager *itemdef);
260 Inventory(const Inventory &other);
261 Inventory & operator = (const Inventory &other);
262 bool operator == (const Inventory &other);
264 void serialize(std::ostream &os) const;
265 void deSerialize(std::istream &is);
267 InventoryList * addList(const std::string &name, u32 size);
268 InventoryList * getList(const std::string &name);
269 const InventoryList * getList(const std::string &name) const;
270 std::vector<const InventoryList*> getLists();
271 bool deleteList(const std::string &name);
272 // A shorthand for adding items. Returns leftover item (possibly empty).
273 ItemStack addItem(const std::string &listname, const ItemStack &newitem)
275 InventoryList *list = getList(listname);
278 return list->addItem(newitem);
283 const s32 getListIndex(const std::string &name) const;
285 std::vector<InventoryList*> m_lists;
286 IItemDefManager *m_itemdef;