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;}
110 virtual float getCookTime(){return 3.0;}
111 // Result of cooking (can randomize)
112 virtual InventoryItem *createCookResult() const {return NULL;}
114 // Eat, press, activate, whatever.
115 // Called when item is right-clicked when lying on ground.
116 // If returns true, item shall be deleted.
117 virtual bool use(ServerEnvironment *env,
118 ServerActiveObject *user){return false;}
125 class MaterialItem : public InventoryItem
128 MaterialItem(IGameDef *gamedef, content_t content, u16 count):
129 InventoryItem(gamedef, count)
134 Implementation interface
136 virtual const char* getName() const
138 return "MaterialItem";
140 virtual void serialize(std::ostream &os) const
142 //os.imbue(std::locale("C"));
145 os<<(unsigned int)m_content;
149 virtual InventoryItem* clone()
151 return new MaterialItem(m_gamedef, m_content, m_count);
154 video::ITexture * getImage(ITextureSource *tsrc) const;
156 std::string getText()
158 std::ostringstream os;
163 virtual bool addableTo(const InventoryItem *other) const
165 if(std::string(other->getName()) != "MaterialItem")
167 MaterialItem *m = (MaterialItem*)other;
168 if(m->getMaterial() != m_content)
172 u16 freeSpace() const
174 if(m_count > QUANTITY_ITEM_MAX_COUNT)
176 return QUANTITY_ITEM_MAX_COUNT - m_count;
181 bool isCookable() const;
182 InventoryItem *createCookResult() const;
186 content_t getMaterial()
195 An item that is used as a mid-product when crafting.
199 class CraftItem : public InventoryItem
202 CraftItem(IGameDef *gamedef, std::string subname, u16 count):
203 InventoryItem(gamedef, count)
208 Implementation interface
210 virtual const char* getName() const
214 virtual void serialize(std::ostream &os) const
222 virtual InventoryItem* clone()
224 return new CraftItem(m_gamedef, m_subname, m_count);
227 video::ITexture * getImage(ITextureSource *tsrc) const;
229 std::string getText()
231 std::ostringstream os;
236 ServerActiveObject* createSAO(ServerEnvironment *env, u16 id, v3f pos);
237 u16 getDropCount() const;
239 virtual bool addableTo(const InventoryItem *other) const
241 if(std::string(other->getName()) != "CraftItem")
243 CraftItem *m = (CraftItem*)other;
244 if(m->m_subname != m_subname)
248 u16 freeSpace() const
250 if(m_count > QUANTITY_ITEM_MAX_COUNT)
252 return QUANTITY_ITEM_MAX_COUNT - m_count;
259 bool isCookable() const;
260 InventoryItem *createCookResult() const;
262 bool use(ServerEnvironment *env, ServerActiveObject *user);
267 std::string getSubName()
272 std::string m_subname;
275 class ToolItem : public InventoryItem
278 ToolItem(IGameDef *gamedef, std::string toolname, u16 wear):
279 InventoryItem(gamedef, 1)
281 m_toolname = toolname;
285 Implementation interface
287 virtual const char* getName() const
291 virtual void serialize(std::ostream &os) const
299 virtual InventoryItem* clone()
301 return new ToolItem(m_gamedef, m_toolname, m_wear);
304 std::string getImageBasename() const;
306 video::ITexture * getImage(ITextureSource *tsrc) const;
307 video::ITexture * getImageRaw(ITextureSource *tsrc) const;
310 std::string getText()
314 /*std::ostringstream os;
318 for(i=0; i<(65535-m_wear)/d; i++)
324 /*std::ostringstream os;
333 std::string getToolName()
341 // Returns true if weared out
342 bool addWear(u16 add)
344 if(m_wear >= 65535 - add)
356 std::string m_toolname;
363 InventoryList(std::string name, u32 size);
366 void serialize(std::ostream &os) const;
367 void deSerialize(std::istream &is, IGameDef *gamedef);
369 InventoryList(const InventoryList &other);
370 InventoryList & operator = (const InventoryList &other);
372 const std::string &getName() const;
378 /*bool getDirty(){ return m_dirty; }
379 void setDirty(bool dirty=true){ m_dirty = dirty; }*/
381 // Get pointer to item
382 const InventoryItem * getItem(u32 i) const;
383 InventoryItem * getItem(u32 i);
384 // Returns old item (or NULL). Parameter can be NULL.
385 InventoryItem * changeItem(u32 i, InventoryItem *newitem);
387 void deleteItem(u32 i);
389 // Adds an item to a suitable place. Returns leftover item.
390 // If all went into the list, returns NULL.
391 InventoryItem * addItem(InventoryItem *newitem);
393 // If possible, adds item to given slot.
394 // If cannot be added at all, returns the item back.
395 // If can be added partly, decremented item is returned back.
396 // If can be added fully, NULL is returned.
397 InventoryItem * addItem(u32 i, InventoryItem *newitem);
399 // Checks whether the item could be added to the given slot
400 bool itemFits(const u32 i, const InventoryItem *newitem);
402 // Checks whether there is room for a given item
403 bool roomForItem(const InventoryItem *item);
405 // Checks whether there is room for a given item aftr it has been cooked
406 bool roomForCookedItem(const InventoryItem *item);
408 // Takes some items from a slot.
409 // If there are not enough, takes as many as it can.
410 // Returns NULL if couldn't take any.
411 InventoryItem * takeItem(u32 i, u32 count);
413 // Decrements amount of every material item
414 void decrementMaterials(u16 count);
416 void print(std::ostream &o);
419 core::array<InventoryItem*> m_items;
433 Inventory(const Inventory &other);
434 Inventory & operator = (const Inventory &other);
436 void serialize(std::ostream &os) const;
437 void deSerialize(std::istream &is, IGameDef *gamedef);
439 InventoryList * addList(const std::string &name, u32 size);
440 InventoryList * getList(const std::string &name);
441 const InventoryList * getList(const std::string &name) const;
442 bool deleteList(const std::string &name);
443 // A shorthand for adding items.
444 // Returns NULL if the item was fully added, leftover otherwise.
445 InventoryItem * addItem(const std::string &listname, InventoryItem *newitem)
447 InventoryList *list = getList(listname);
450 return list->addItem(newitem);
455 const s32 getListIndex(const std::string &name) const;
457 core::array<InventoryList*> m_lists;
462 struct InventoryContext
464 Player *current_player;
471 struct InventoryAction;
473 class InventoryManager
477 virtual ~InventoryManager(){}
480 Get a pointer to an inventory specified by id.
485 virtual Inventory* getInventory(InventoryContext *c, std::string id)
487 // Used on the server by InventoryAction::apply and other stuff
488 virtual void inventoryModified(InventoryContext *c, std::string id)
490 // Used on the client
491 virtual void inventoryAction(InventoryAction *a)
495 #define IACTION_MOVE 0
497 struct InventoryAction
499 static InventoryAction * deSerialize(std::istream &is);
501 virtual u16 getType() const = 0;
502 virtual void serialize(std::ostream &os) const = 0;
503 virtual void apply(InventoryContext *c, InventoryManager *mgr) = 0;
506 struct IMoveAction : public InventoryAction
508 // count=0 means "everything"
510 std::string from_inv;
511 std::string from_list;
524 IMoveAction(std::istream &is);
531 void serialize(std::ostream &os) const
543 void apply(InventoryContext *c, InventoryManager *mgr);
547 Craft checking system
561 enum ItemSpecType type;
562 // Only other one of these is used
570 ItemSpec(enum ItemSpecType a_type, std::string a_name):
576 ItemSpec(enum ItemSpecType a_type, u16 a_num):
583 bool checkItem(const InventoryItem *item) const;
587 items: a pointer to an array of 9 pointers to items
588 specs: a pointer to an array of 9 ItemSpecs
590 bool checkItemCombination(const InventoryItem * const*items, const ItemSpec *specs);