]> git.lizzy.rs Git - dragonfireclient.git/blobdiff - src/inventory.h
Move ContentFeatures to mapnode_contentfeatures.{h,cpp} and clean stuff
[dragonfireclient.git] / src / inventory.h
index 761e664a9ec09737070259a52f0bce685680b0c4..c202d5533125c860dbf15030c2da54840f592ec3 100644 (file)
@@ -29,12 +29,14 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include <string>
 #include "common_irrlicht.h"
 #include "debug.h"
-#include "mapblockobject.h"
-// For g_materials
-#include "main.h"
+#include "main.h" // For g_materials
+#include "mapnode.h" // For content_t
 
 #define QUANTITY_ITEM_MAX_COUNT 99
 
+class ServerActiveObject;
+class ServerEnvironment;
+
 class InventoryItem
 {
 public:
@@ -45,26 +47,37 @@ class InventoryItem
        
        virtual const char* getName() const = 0;
        // Shall write the name and the parameters
-       virtual void serialize(std::ostream &os) = 0;
+       virtual void serialize(std::ostream &os) const = 0;
        // Shall make an exact clone of the item
        virtual InventoryItem* clone() = 0;
 #ifndef SERVER
-       // Shall return an image to show in the GUI (or NULL)
-       virtual video::ITexture * getImage() { return NULL; }
+       // Return the name of the image for this item
+       virtual std::string getBasename() const { return ""; }
+       // Shall return an image of the item (or NULL)
+       virtual video::ITexture * getImage() const { return NULL; }
+       // Shall return an image of the item without embellishments (or NULL)
+       virtual video::ITexture * getImageRaw() const { return getImage(); }
 #endif
        // Shall return a text to show in the GUI
        virtual std::string getText() { return ""; }
+       // Returns the string used for inventory
+       virtual std::string getItemString();
+       // Creates an object from the item, to be placed in the world.
+       virtual ServerActiveObject* createSAO(ServerEnvironment *env, u16 id, v3f pos);
+       // Gets amount of items that dropping one SAO will decrement
+       virtual u16 getDropCount() const { return getCount(); }
+
+       /*
+               Quantity methods
+       */
 
        // Shall return true if the item can be add()ed to the other
-       virtual bool addableTo(InventoryItem *other)
+       virtual bool addableTo(const InventoryItem *other) const
        {
                return false;
        }
        
-       /*
-               Quantity methods
-       */
-       u16 getCount()
+       u16 getCount() const
        {
                return m_count;
        }
@@ -73,7 +86,7 @@ class InventoryItem
                m_count = count;
        }
        // This should return something else for stackable items
-       virtual u16 freeSpace()
+       virtual u16 freeSpace() const
        {
                return 0;
        }
@@ -91,12 +104,19 @@ class InventoryItem
        /*
                Other properties
        */
+
        // Whether it can be cooked
-       virtual bool isCookable(){return false;}
+       virtual bool isCookable() const {return false;}
        // Time of cooking
        virtual float getCookTime(){return 3.0;}
-       // Result of cooking
-       virtual InventoryItem *createCookResult(){return NULL;}
+       // Result of cooking (can randomize)
+       virtual InventoryItem *createCookResult() const {return NULL;}
+       
+       // Eat, press, activate, whatever.
+       // Called when item is right-clicked when lying on ground.
+       // If returns true, item shall be deleted.
+       virtual bool use(ServerEnvironment *env,
+                       ServerActiveObject *user){return false;}
 
 protected:
        u16 m_count;
@@ -105,7 +125,7 @@ class InventoryItem
 class MaterialItem : public InventoryItem
 {
 public:
-       MaterialItem(u8 content, u16 count):
+       MaterialItem(content_t content, u16 count):
                InventoryItem(count)
        {
                m_content = content;
@@ -117,10 +137,10 @@ class MaterialItem : public InventoryItem
        {
                return "MaterialItem";
        }
-       virtual void serialize(std::ostream &os)
+       virtual void serialize(std::ostream &os) const
        {
                //os.imbue(std::locale("C"));
-               os<<getName();
+               os<<"MaterialItem2";
                os<<" ";
                os<<(unsigned int)m_content;
                os<<" ";
@@ -131,11 +151,7 @@ class MaterialItem : public InventoryItem
                return new MaterialItem(m_content, m_count);
        }
 #ifndef SERVER
-       video::ITexture * getImage()
-       {
-               return content_features(m_content).inventory_texture;
-               return NULL;
-       }
+       video::ITexture * getImage() const;
 #endif
        std::string getText()
        {
@@ -144,7 +160,7 @@ class MaterialItem : public InventoryItem
                return os.str();
        }
 
-       virtual bool addableTo(InventoryItem *other)
+       virtual bool addableTo(const InventoryItem *other) const
        {
                if(std::string(other->getName()) != "MaterialItem")
                        return false;
@@ -153,7 +169,7 @@ class MaterialItem : public InventoryItem
                        return false;
                return true;
        }
-       u16 freeSpace()
+       u16 freeSpace() const
        {
                if(m_count > QUANTITY_ITEM_MAX_COUNT)
                        return 0;
@@ -162,71 +178,17 @@ class MaterialItem : public InventoryItem
        /*
                Other properties
        */
-       bool isCookable();
-       InventoryItem *createCookResult();
+       bool isCookable() const;
+       InventoryItem *createCookResult() const;
        /*
                Special methods
        */
-       u8 getMaterial()
+       content_t getMaterial()
        {
                return m_content;
        }
 private:
-       u8 m_content;
-};
-
-class MapBlockObjectItem : public InventoryItem
-{
-public:
-       MapBlockObjectItem(std::string inventorystring):
-               InventoryItem(1)
-       {
-               m_inventorystring = inventorystring;
-       }
-       
-       /*
-               Implementation interface
-       */
-       virtual const char* getName() const
-       {
-               return "MBOItem";
-       }
-       virtual void serialize(std::ostream &os)
-       {
-               for(;;)
-               {
-                       size_t t = m_inventorystring.find('|');
-                       if(t == std::string::npos)
-                               break;
-                       m_inventorystring[t] = '?';
-               }
-               os<<getName();
-               os<<" ";
-               os<<m_inventorystring;
-               os<<"|";
-       }
-       virtual InventoryItem* clone()
-       {
-               return new MapBlockObjectItem(m_inventorystring);
-       }
-
-#ifndef SERVER
-       video::ITexture * getImage();
-#endif
-       std::string getText();
-
-       /*
-               Special methods
-       */
-       std::string getInventoryString()
-       {
-               return m_inventorystring;
-       }
-
-       MapBlockObject * createObject(v3f pos, f32 player_yaw, f32 player_pitch);
-
-private:
-       std::string m_inventorystring;
+       content_t m_content;
 };
 
 /*
@@ -249,7 +211,7 @@ class CraftItem : public InventoryItem
        {
                return "CraftItem";
        }
-       virtual void serialize(std::ostream &os)
+       virtual void serialize(std::ostream &os) const
        {
                os<<getName();
                os<<" ";
@@ -262,28 +224,7 @@ class CraftItem : public InventoryItem
                return new CraftItem(m_subname, m_count);
        }
 #ifndef SERVER
-       video::ITexture * getImage()
-       {
-               if(g_texturesource == NULL)
-                       return NULL;
-               
-               std::string name;
-
-               if(m_subname == "Stick")
-                       name = "stick.png";
-               else if(m_subname == "lump_of_coal")
-                       name = "lump_of_coal.png";
-               else if(m_subname == "lump_of_iron")
-                       name = "lump_of_iron.png";
-               else if(m_subname == "steel_ingot")
-                       name = "steel_ingot.png";
-               else
-                       name = "cloud.png";
-               
-               // Get such a texture
-               //return g_irrlicht->getTexture(name);
-               return g_texturesource->getTextureRaw(name);
-       }
+       video::ITexture * getImage() const;
 #endif
        std::string getText()
        {
@@ -291,7 +232,11 @@ class CraftItem : public InventoryItem
                os<<m_count;
                return os.str();
        }
-       virtual bool addableTo(InventoryItem *other)
+
+       ServerActiveObject* createSAO(ServerEnvironment *env, u16 id, v3f pos);
+       u16 getDropCount() const;
+
+       virtual bool addableTo(const InventoryItem *other) const
        {
                if(std::string(other->getName()) != "CraftItem")
                        return false;
@@ -300,17 +245,22 @@ class CraftItem : public InventoryItem
                        return false;
                return true;
        }
-       u16 freeSpace()
+       u16 freeSpace() const
        {
                if(m_count > QUANTITY_ITEM_MAX_COUNT)
                        return 0;
                return QUANTITY_ITEM_MAX_COUNT - m_count;
        }
+
        /*
                Other properties
        */
-       bool isCookable();
-       InventoryItem *createCookResult();
+
+       bool isCookable() const;
+       InventoryItem *createCookResult() const;
+
+       bool use(ServerEnvironment *env, ServerActiveObject *user);
+       
        /*
                Special methods
        */
@@ -338,7 +288,7 @@ class ToolItem : public InventoryItem
        {
                return "ToolItem";
        }
-       virtual void serialize(std::ostream &os)
+       virtual void serialize(std::ostream &os) const
        {
                os<<getName();
                os<<" ";
@@ -351,34 +301,43 @@ class ToolItem : public InventoryItem
                return new ToolItem(m_toolname, m_wear);
        }
 #ifndef SERVER
-       video::ITexture * getImage()
-       {
-               if(g_texturesource == NULL)
-                       return NULL;
-               
-               std::string basename;
+       std::string getBasename() const {
                if(m_toolname == "WPick")
-                       basename = "tool_woodpick.png";
+                       return "tool_woodpick.png";
                else if(m_toolname == "STPick")
-                       basename = "tool_stonepick.png";
+                       return "tool_stonepick.png";
                else if(m_toolname == "SteelPick")
-                       basename = "tool_steelpick.png";
+                       return "tool_steelpick.png";
                else if(m_toolname == "MesePick")
-                       basename = "tool_mesepick.png";
+                       return "tool_mesepick.png";
                else if(m_toolname == "WShovel")
-                       basename = "tool_woodshovel.png";
+                       return "tool_woodshovel.png";
                else if(m_toolname == "STShovel")
-                       basename = "tool_stoneshovel.png";
+                       return "tool_stoneshovel.png";
                else if(m_toolname == "SteelShovel")
-                       basename = "tool_steelshovel.png";
+                       return "tool_steelshovel.png";
                else if(m_toolname == "WAxe")
-                       basename = "tool_woodaxe.png";
+                       return "tool_woodaxe.png";
                else if(m_toolname == "STAxe")
-                       basename = "tool_stoneaxe.png";
+                       return "tool_stoneaxe.png";
                else if(m_toolname == "SteelAxe")
-                       basename = "tool_steelaxe.png";
+                       return "tool_steelaxe.png";
+               else if(m_toolname == "WSword")
+                       return "tool_woodsword.png";
+               else if(m_toolname == "STSword")
+                       return "tool_stonesword.png";
+               else if(m_toolname == "SteelSword")
+                       return "tool_steelsword.png";
                else
-                       basename = "cloud.png";
+                       return "cloud.png";
+}
+       
+       video::ITexture * getImage() const
+       {
+               if(g_texturesource == NULL)
+                       return NULL;
+               
+               std::string basename = getBasename();
                
                /*
                        Calculate a progress value with sane amount of
@@ -392,11 +351,14 @@ class ToolItem : public InventoryItem
                os<<basename<<"^[progressbar"<<value_f;
 
                return g_texturesource->getTextureRaw(os.str());
+       }
 
-               /*TextureSpec spec;
-               spec.addTid(g_irrlicht->getTextureId(basename));
-               spec.addTid(g_irrlicht->getTextureId(os.str()));
-               return g_irrlicht->getTexture(spec);*/
+       video::ITexture * getImageRaw() const
+       {
+               if(g_texturesource == NULL)
+                       return NULL;
+               
+               return g_texturesource->getTextureRaw(getBasename());
        }
 #endif
        std::string getText()
@@ -455,19 +417,23 @@ class InventoryList
        InventoryList(std::string name, u32 size);
        ~InventoryList();
        void clearItems();
-       void serialize(std::ostream &os);
+       void serialize(std::ostream &os) const;
        void deSerialize(std::istream &is);
 
        InventoryList(const InventoryList &other);
        InventoryList & operator = (const InventoryList &other);
 
-       std::string getName();
+       const std::string &getName() const;
        u32 getSize();
        // Count used slots
        u32 getUsedSlots();
        u32 getFreeSlots();
+
+       /*bool getDirty(){ return m_dirty; }
+       void setDirty(bool dirty=true){ m_dirty = dirty; }*/
        
        // Get pointer to item
+       const InventoryItem * getItem(u32 i) const;
        InventoryItem * getItem(u32 i);
        // Returns old item (or NULL). Parameter can be NULL.
        InventoryItem * changeItem(u32 i, InventoryItem *newitem);
@@ -485,7 +451,13 @@ class InventoryList
        InventoryItem * addItem(u32 i, InventoryItem *newitem);
 
        // Checks whether the item could be added to the given slot
-       bool itemFits(u32 i, InventoryItem *newitem);
+       bool itemFits(const u32 i, const InventoryItem *newitem);
+
+       // Checks whether there is room for a given item
+       bool roomForItem(const InventoryItem *item);
+
+       // Checks whether there is room for a given item aftr it has been cooked
+       bool roomForCookedItem(const InventoryItem *item);
 
        // Takes some items from a slot.
        // If there are not enough, takes as many as it can.
@@ -501,6 +473,7 @@ class InventoryList
        core::array<InventoryItem*> m_items;
        u32 m_size;
        std::string m_name;
+       //bool m_dirty;
 };
 
 class Inventory
@@ -514,11 +487,12 @@ class Inventory
        Inventory(const Inventory &other);
        Inventory & operator = (const Inventory &other);
        
-       void serialize(std::ostream &os);
+       void serialize(std::ostream &os) const;
        void deSerialize(std::istream &is);
 
        InventoryList * addList(const std::string &name, u32 size);
        InventoryList * getList(const std::string &name);
+       const InventoryList * getList(const std::string &name) const;
        bool deleteList(const std::string &name);
        // A shorthand for adding items.
        // Returns NULL if the item was fully added, leftover otherwise.
@@ -532,7 +506,7 @@ class Inventory
        
 private:
        // -1 if not found
-       s32 getListIndex(const std::string &name);
+       const s32 getListIndex(const std::string &name) const;
 
        core::array<InventoryList*> m_lists;
 };
@@ -548,7 +522,7 @@ struct InventoryContext
        {}
 };
 
-class InventoryAction;
+struct InventoryAction;
 
 class InventoryManager
 {
@@ -579,7 +553,7 @@ struct InventoryAction
        static InventoryAction * deSerialize(std::istream &is);
        
        virtual u16 getType() const = 0;
-       virtual void serialize(std::ostream &os) = 0;
+       virtual void serialize(std::ostream &os) const = 0;
        virtual void apply(InventoryContext *c, InventoryManager *mgr) = 0;
 };
 
@@ -627,7 +601,7 @@ struct IMoveAction : public InventoryAction
                return IACTION_MOVE;
        }
 
-       void serialize(std::ostream &os)
+       void serialize(std::ostream &os) const
        {
                os<<"Move ";
                os<<count<<" ";
@@ -679,14 +653,14 @@ struct ItemSpec
        {
        }
 
-       bool checkItem(InventoryItem *item);
+       bool checkItem(const InventoryItem *item) const;
 };
 
 /*
        items: a pointer to an array of 9 pointers to items
        specs: a pointer to an array of 9 ItemSpecs
 */
-bool checkItemCombination(InventoryItem **items, ItemSpec *specs);
+bool checkItemCombination(const InventoryItem * const*items, const ItemSpec *specs);
 
 #endif