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
25 #include "irrlichttypes.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 // 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);
47 // Returns the string used for inventory
48 std::string getItemString() const;
74 assert(count >= n); // Pre-condition
77 clear(); // reset name, wear and metadata too
80 // Maximum size of a stack
81 u16 getStackMax(IItemDefManager *itemdef) const
83 s16 max = itemdef->get(name).stack_max;
84 return (max >= 0) ? max : 0;
87 // Number of items that can be added to this stack
88 u16 freeSpace(IItemDefManager *itemdef) const
90 u16 max = getStackMax(itemdef);
96 // Returns false if item is not known and cannot be used
97 bool isKnown(IItemDefManager *itemdef) const
99 return itemdef->isKnown(name);
102 // Returns a pointer to the item definition struct,
103 // or a fallback one (name="unknown") if the item is unknown.
104 const ItemDefinition& getDefinition(
105 IItemDefManager *itemdef) const
107 return itemdef->get(name);
110 // Get tool digging properties, or those of the hand if not a tool
111 const ToolCapabilities& getToolCapabilities(
112 IItemDefManager *itemdef) const
114 ToolCapabilities *cap;
115 cap = itemdef->get(name).tool_capabilities;
117 cap = itemdef->get("").tool_capabilities;
122 // Wear out (only tools)
123 // Returns true if the item is (was) a tool
124 bool addWear(s32 amount, IItemDefManager *itemdef)
126 if(getDefinition(itemdef).type == ITEM_TOOL)
128 if(amount > 65535 - wear)
130 else if(amount < -wear)
142 // If possible, adds newitem to this item.
143 // If cannot be added at all, returns the item back.
144 // If can be added partly, decremented item is returned back.
145 // If can be added fully, empty item is returned.
146 ItemStack addItem(const ItemStack &newitem,
147 IItemDefManager *itemdef);
149 // Checks whether newitem could be added.
150 // If restitem is non-NULL, it receives the part of newitem that
151 // would be left over after adding.
152 bool itemFits(const ItemStack &newitem,
153 ItemStack *restitem, // may be NULL
154 IItemDefManager *itemdef) const;
157 // If there are not enough, takes as many as it can.
158 // Returns empty item if couldn't take any.
159 ItemStack takeItem(u32 takecount);
161 // Similar to takeItem, but keeps this ItemStack intact.
162 ItemStack peekItem(u32 peekcount) const;
170 std::string metadata;
176 InventoryList(std::string name, u32 size, IItemDefManager *itemdef);
179 void setSize(u32 newsize);
180 void setWidth(u32 newWidth);
181 void setName(const std::string &name);
182 void serialize(std::ostream &os) const;
183 void deSerialize(std::istream &is);
185 InventoryList(const InventoryList &other);
186 InventoryList & operator = (const InventoryList &other);
187 bool operator == (const InventoryList &other) const;
188 bool operator != (const InventoryList &other) const
190 return !(*this == other);
193 const std::string &getName() const;
195 u32 getWidth() const;
197 u32 getUsedSlots() const;
198 u32 getFreeSlots() const;
200 // Get reference to item
201 const ItemStack& getItem(u32 i) const;
202 ItemStack& getItem(u32 i);
203 // Returns old item. Parameter can be an empty item.
204 ItemStack changeItem(u32 i, const ItemStack &newitem);
206 void deleteItem(u32 i);
208 // Adds an item to a suitable place. Returns leftover item (possibly empty).
209 ItemStack addItem(const ItemStack &newitem);
211 // If possible, adds item to given slot.
212 // If cannot be added at all, returns the item back.
213 // If can be added partly, decremented item is returned back.
214 // If can be added fully, empty item is returned.
215 ItemStack addItem(u32 i, const ItemStack &newitem);
217 // Checks whether the item could be added to the given slot
218 // If restitem is non-NULL, it receives the part of newitem that
219 // would be left over after adding.
220 bool itemFits(const u32 i, const ItemStack &newitem,
221 ItemStack *restitem = NULL) const;
223 // Checks whether there is room for a given item
224 bool roomForItem(const ItemStack &item) const;
226 // Checks whether the given count of the given item name
227 // exists in this inventory list.
228 bool containsItem(const ItemStack &item) const;
230 // Removes the given count of the given item name from
231 // this inventory list. Walks the list in reverse order.
232 // If not as many items exist as requested, removes as
234 // Returns the items that were actually removed.
235 ItemStack removeItem(const ItemStack &item);
237 // Takes some items from a slot.
238 // If there are not enough, takes as many as it can.
239 // Returns empty item if couldn't take any.
240 ItemStack takeItem(u32 i, u32 takecount);
242 // Similar to takeItem, but keeps the slot intact.
243 ItemStack peekItem(u32 i, u32 peekcount) const;
245 // Move an item to a different list (or a different stack in the same list)
246 // count is the maximum number of items to move (0 for everything)
247 // returns number of moved items
248 u32 moveItem(u32 i, InventoryList *dest, u32 dest_i,
249 u32 count = 0, bool swap_if_needed = true);
251 // like moveItem, but without a fixed destination index
252 // also with optional rollback recording
253 void moveItemSomewhere(u32 i, InventoryList *dest, u32 count);
256 std::vector<ItemStack> m_items;
259 IItemDefManager *m_itemdef;
268 void clearContents();
270 Inventory(IItemDefManager *itemdef);
271 Inventory(const Inventory &other);
272 Inventory & operator = (const Inventory &other);
273 bool operator == (const Inventory &other) const;
274 bool operator != (const Inventory &other) const
276 return !(*this == other);
279 void serialize(std::ostream &os) const;
280 void deSerialize(std::istream &is);
282 InventoryList * addList(const std::string &name, u32 size);
283 InventoryList * getList(const std::string &name);
284 const InventoryList * getList(const std::string &name) const;
285 std::vector<const InventoryList*> getLists();
286 bool deleteList(const std::string &name);
287 // A shorthand for adding items. Returns leftover item (possibly empty).
288 ItemStack addItem(const std::string &listname, const ItemStack &newitem)
291 InventoryList *list = getList(listname);
294 return list->addItem(newitem);
297 bool checkModified() const
302 void setModified(const bool x)
309 const s32 getListIndex(const std::string &name) const;
311 std::vector<InventoryList*> m_lists;
312 IItemDefManager *m_itemdef;