3 Copyright (C) 2010-2011 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 General Public License as published by
7 the Free Software Foundation; either version 2 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 General Public License for more details.
15 You should have received a copy of the GNU 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
26 #include "common_irrlicht.h"
28 #include "mapnode.h" // For content_t
30 #define QUANTITY_ITEM_MAX_COUNT 99
32 class ServerActiveObject;
33 class ServerEnvironment;
40 InventoryItem(IGameDef *gamedef, u16 count);
41 virtual ~InventoryItem();
43 static InventoryItem* deSerialize(std::istream &is, IGameDef *gamedef);
45 virtual const char* getName() const = 0;
46 // Shall write the name and the parameters
47 virtual void serialize(std::ostream &os) const = 0;
48 // Shall make an exact clone of the item
49 virtual InventoryItem* clone() = 0;
50 // Return the name of the image for this item
51 virtual std::string getImageBasename() const { return ""; }
53 // Shall return an image of the item (or NULL)
54 virtual video::ITexture * getImage(ITextureSource *tsrc) const
56 // Shall return an image of the item without embellishments (or NULL)
57 virtual video::ITexture * getImageRaw(ITextureSource *tsrc) const
58 { return getImage(tsrc); }
60 // Shall return a text to show in the GUI
61 virtual std::string getText() { return ""; }
62 // Returns the string used for inventory
63 virtual std::string getItemString();
64 // Creates an object from the item, to be placed in the world.
65 virtual ServerActiveObject* createSAO(ServerEnvironment *env, u16 id, v3f pos);
66 // Gets amount of items that dropping one SAO will decrement
67 virtual u16 getDropCount() const { return getCount(); }
73 // Shall return true if the item can be add()ed to the other
74 virtual bool addableTo(const InventoryItem *other) const
83 void setCount(u16 count)
87 // This should return something else for stackable items
88 virtual u16 freeSpace() const
94 assert(m_count + count <= QUANTITY_ITEM_MAX_COUNT);
97 void remove(u16 count)
99 assert(m_count >= count);
107 // Whether it can be cooked
108 virtual bool isCookable() const {return false;}
109 // Result of cooking (can randomize)
110 virtual InventoryItem *createCookResult() const {return NULL;}
112 virtual float getCookTime() const {return 3.0;}
113 // Whether it can be burned (<0 = cannot be burned)
114 virtual float getBurnTime() const {return -1;}
116 // Eat, press, activate, whatever.
117 // Called when item is right-clicked when lying on ground.
118 // If returns true, item shall be deleted.
119 virtual bool use(ServerEnvironment *env,
120 ServerActiveObject *user){return false;}
127 class MaterialItem : public InventoryItem
130 MaterialItem(IGameDef *gamedef, content_t content, u16 count):
131 InventoryItem(gamedef, count)
136 Implementation interface
138 virtual const char* getName() const
140 return "MaterialItem";
142 virtual void serialize(std::ostream &os) const
144 //os.imbue(std::locale("C"));
147 os<<(unsigned int)m_content;
151 virtual InventoryItem* clone()
153 return new MaterialItem(m_gamedef, m_content, m_count);
156 video::ITexture * getImage(ITextureSource *tsrc) const;
158 std::string getText()
160 std::ostringstream os;
165 virtual bool addableTo(const InventoryItem *other) const
167 if(std::string(other->getName()) != "MaterialItem")
169 MaterialItem *m = (MaterialItem*)other;
170 if(m->getMaterial() != m_content)
174 u16 freeSpace() const
176 if(m_count > QUANTITY_ITEM_MAX_COUNT)
178 return QUANTITY_ITEM_MAX_COUNT - m_count;
183 bool isCookable() const;
184 InventoryItem *createCookResult() const;
185 float getCookTime() const;
186 float getBurnTime() const;
190 content_t getMaterial()
199 An item that is used as a mid-product when crafting.
203 class CraftItem : public InventoryItem
206 CraftItem(IGameDef *gamedef, std::string subname, u16 count):
207 InventoryItem(gamedef, count)
212 Implementation interface
214 virtual const char* getName() const
218 virtual void serialize(std::ostream &os) const
226 virtual InventoryItem* clone()
228 return new CraftItem(m_gamedef, m_subname, m_count);
231 video::ITexture * getImage(ITextureSource *tsrc) const;
233 std::string getText()
235 std::ostringstream os;
240 ServerActiveObject* createSAO(ServerEnvironment *env, u16 id, v3f pos);
241 u16 getDropCount() const;
243 virtual bool addableTo(const InventoryItem *other) const
245 if(std::string(other->getName()) != "CraftItem")
247 CraftItem *m = (CraftItem*)other;
248 if(m->m_subname != m_subname)
252 u16 freeSpace() const
254 if(m_count > QUANTITY_ITEM_MAX_COUNT)
256 return QUANTITY_ITEM_MAX_COUNT - m_count;
263 bool isCookable() const;
264 InventoryItem *createCookResult() const;
265 float getCookTime() const;
266 float getBurnTime() const;
268 bool use(ServerEnvironment *env, ServerActiveObject *user);
273 std::string getSubName()
278 std::string m_subname;
281 class ToolItem : public InventoryItem
284 ToolItem(IGameDef *gamedef, std::string toolname, u16 wear):
285 InventoryItem(gamedef, 1)
287 m_toolname = toolname;
291 Implementation interface
293 virtual const char* getName() const
297 virtual void serialize(std::ostream &os) const
305 virtual InventoryItem* clone()
307 return new ToolItem(m_gamedef, m_toolname, m_wear);
310 std::string getImageBasename() const;
312 video::ITexture * getImage(ITextureSource *tsrc) const;
313 video::ITexture * getImageRaw(ITextureSource *tsrc) const;
316 std::string getText()
320 /*std::ostringstream os;
324 for(i=0; i<(65535-m_wear)/d; i++)
330 /*std::ostringstream os;
339 std::string getToolName()
347 // Returns true if weared out
348 bool addWear(u16 add)
350 if(m_wear >= 65535 - add)
362 std::string m_toolname;
369 InventoryList(std::string name, u32 size);
372 void serialize(std::ostream &os) const;
373 void deSerialize(std::istream &is, IGameDef *gamedef);
375 InventoryList(const InventoryList &other);
376 InventoryList & operator = (const InventoryList &other);
378 const std::string &getName() const;
384 /*bool getDirty(){ return m_dirty; }
385 void setDirty(bool dirty=true){ m_dirty = dirty; }*/
387 // Get pointer to item
388 const InventoryItem * getItem(u32 i) const;
389 InventoryItem * getItem(u32 i);
390 // Returns old item (or NULL). Parameter can be NULL.
391 InventoryItem * changeItem(u32 i, InventoryItem *newitem);
393 void deleteItem(u32 i);
395 // Adds an item to a suitable place. Returns leftover item.
396 // If all went into the list, returns NULL.
397 InventoryItem * addItem(InventoryItem *newitem);
399 // If possible, adds item to given slot.
400 // If cannot be added at all, returns the item back.
401 // If can be added partly, decremented item is returned back.
402 // If can be added fully, NULL is returned.
403 InventoryItem * addItem(u32 i, InventoryItem *newitem);
405 // Checks whether the item could be added to the given slot
406 bool itemFits(const u32 i, const InventoryItem *newitem);
408 // Checks whether there is room for a given item
409 bool roomForItem(const InventoryItem *item);
411 // Checks whether there is room for a given item aftr it has been cooked
412 bool roomForCookedItem(const InventoryItem *item);
414 // Takes some items from a slot.
415 // If there are not enough, takes as many as it can.
416 // Returns NULL if couldn't take any.
417 InventoryItem * takeItem(u32 i, u32 count);
419 // Decrements amount of every material item
420 void decrementMaterials(u16 count);
422 void print(std::ostream &o);
425 core::array<InventoryItem*> m_items;
439 Inventory(const Inventory &other);
440 Inventory & operator = (const Inventory &other);
442 void serialize(std::ostream &os) const;
443 void deSerialize(std::istream &is, IGameDef *gamedef);
445 InventoryList * addList(const std::string &name, u32 size);
446 InventoryList * getList(const std::string &name);
447 const InventoryList * getList(const std::string &name) const;
448 bool deleteList(const std::string &name);
449 // A shorthand for adding items.
450 // Returns NULL if the item was fully added, leftover otherwise.
451 InventoryItem * addItem(const std::string &listname, InventoryItem *newitem)
453 InventoryList *list = getList(listname);
456 return list->addItem(newitem);
461 const s32 getListIndex(const std::string &name) const;
463 core::array<InventoryList*> m_lists;
468 struct InventoryContext
470 Player *current_player;
477 struct InventoryAction;
479 class InventoryManager
483 virtual ~InventoryManager(){}
486 Get a pointer to an inventory specified by id.
491 virtual Inventory* getInventory(InventoryContext *c, std::string id)
493 // Used on the server by InventoryAction::apply and other stuff
494 virtual void inventoryModified(InventoryContext *c, std::string id)
496 // Used on the client
497 virtual void inventoryAction(InventoryAction *a)
501 #define IACTION_MOVE 0
503 struct InventoryAction
505 static InventoryAction * deSerialize(std::istream &is);
507 virtual u16 getType() const = 0;
508 virtual void serialize(std::ostream &os) const = 0;
509 virtual void apply(InventoryContext *c, InventoryManager *mgr) = 0;
512 struct IMoveAction : public InventoryAction
514 // count=0 means "everything"
516 std::string from_inv;
517 std::string from_list;
530 IMoveAction(std::istream &is);
537 void serialize(std::ostream &os) const
549 void apply(InventoryContext *c, InventoryManager *mgr);
553 Craft checking system
567 enum ItemSpecType type;
568 // Only other one of these is used
576 ItemSpec(enum ItemSpecType a_type, std::string a_name):
582 ItemSpec(enum ItemSpecType a_type, u16 a_num):
589 bool checkItem(const InventoryItem *item) const;
593 items: a pointer to an array of 9 pointers to items
594 specs: a pointer to an array of 9 ItemSpecs
596 bool checkItemCombination(const InventoryItem * const*items, const ItemSpec *specs);