ToolDefManager serialization
[oweals/minetest.git] / src / inventory.h
index 97eacef5b4e9ea719557103c8c0ff442a5292b94..29b97ccad95b6e2be7dc5ddf343b03846e728069 100644 (file)
@@ -1,6 +1,6 @@
 /*
 Minetest-c55
-Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
+Copyright (C) 2010-2011 celeron55, Perttu Ahola <celeron55@gmail.com>
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -17,10 +17,6 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
-/*
-(c) 2010 Perttu Ahola <celeron55@gmail.com>
-*/
-
 #ifndef INVENTORY_HEADER
 #define INVENTORY_HEADER
 
@@ -29,42 +25,58 @@ 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 "mapnode.h" // For content_t
 
 #define QUANTITY_ITEM_MAX_COUNT 99
 
+class ServerActiveObject;
+class ServerEnvironment;
+class ITextureSource;
+class IGameDef;
+
 class InventoryItem
 {
 public:
-       InventoryItem(u16 count);
+       InventoryItem(IGameDef *gamedef, u16 count);
        virtual ~InventoryItem();
        
-       static InventoryItem* deSerialize(std::istream &is);
+       static InventoryItem* deSerialize(std::istream &is, IGameDef *gamedef);
        
        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;
+       // Return the name of the image for this item
+       virtual std::string getImageBasename() const { return ""; }
 #ifndef SERVER
-       // Shall return an image to show in the GUI (or NULL)
-       virtual video::ITexture * getImage() { return NULL; }
+       // Shall return an image of the item (or NULL)
+       virtual video::ITexture * getImage(ITextureSource *tsrc) const
+               { return NULL; }
+       // Shall return an image of the item without embellishments (or NULL)
+       virtual video::ITexture * getImageRaw(ITextureSource *tsrc) const
+               { return getImage(tsrc); }
 #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;
        }
@@ -72,7 +84,8 @@ public:
        {
                m_count = count;
        }
-       virtual u16 freeSpace()
+       // This should return something else for stackable items
+       virtual u16 freeSpace() const
        {
                return 0;
        }
@@ -87,15 +100,33 @@ public:
                m_count -= count;
        }
 
+       /*
+               Other properties
+       */
+
+       // Whether it can be cooked
+       virtual bool isCookable() const {return false;}
+       // Time of cooking
+       virtual float getCookTime(){return 3.0;}
+       // 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:
+       IGameDef *m_gamedef;
        u16 m_count;
 };
 
 class MaterialItem : public InventoryItem
 {
 public:
-       MaterialItem(u8 content, u16 count):
-               InventoryItem(count)
+       MaterialItem(IGameDef *gamedef, content_t content, u16 count):
+               InventoryItem(gamedef, count)
        {
                m_content = content;
        }
@@ -106,10 +137,10 @@ public:
        {
                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<<" ";
@@ -117,22 +148,10 @@ public:
        }
        virtual InventoryItem* clone()
        {
-               return new MaterialItem(m_content, m_count);
+               return new MaterialItem(m_gamedef, m_content, m_count);
        }
 #ifndef SERVER
-       video::ITexture * getImage()
-       {
-               /*if(m_content == CONTENT_TORCH)
-                       return g_texturecache.get("torch_on_floor");
-
-               u16 tile = content_tile(m_content, v3s16(1,0,0));
-               return g_tile_contents[tile].getTexture(0);*/
-               
-               if(m_content >= USEFUL_CONTENT_COUNT)
-                       return NULL;
-                       
-               return g_irrlicht->getTexture(g_content_inventory_textures[m_content]);
-       }
+       video::ITexture * getImage(ITextureSource *tsrc) const;
 #endif
        std::string getText()
        {
@@ -141,7 +160,7 @@ public:
                return os.str();
        }
 
-       virtual bool addableTo(InventoryItem *other)
+       virtual bool addableTo(const InventoryItem *other) const
        {
                if(std::string(other->getName()) != "MaterialItem")
                        return false;
@@ -150,75 +169,26 @@ public:
                        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;
        }
        /*
-               Special methods
-       */
-       u8 getMaterial()
-       {
-               return m_content;
-       }
-private:
-       u8 m_content;
-};
-
-class MapBlockObjectItem : public InventoryItem
-{
-public:
-       MapBlockObjectItem(std::string inventorystring):
-               InventoryItem(1)
-       {
-               m_inventorystring = inventorystring;
-       }
-       
-       /*
-               Implementation interface
+               Other properties
        */
-       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();
-
+       bool isCookable() const;
+       InventoryItem *createCookResult() const;
        /*
                Special methods
        */
-       std::string getInventoryString()
+       content_t getMaterial()
        {
-               return m_inventorystring;
+               return m_content;
        }
-
-       MapBlockObject * createObject(v3f pos, f32 player_yaw, f32 player_pitch);
-
 private:
-       std::string m_inventorystring;
+       content_t m_content;
 };
 
 /*
@@ -229,8 +199,8 @@ private:
 class CraftItem : public InventoryItem
 {
 public:
-       CraftItem(std::string subname, u16 count):
-               InventoryItem(count)
+       CraftItem(IGameDef *gamedef, std::string subname, u16 count):
+               InventoryItem(gamedef, count)
        {
                m_subname = subname;
        }
@@ -241,7 +211,7 @@ public:
        {
                return "CraftItem";
        }
-       virtual void serialize(std::ostream &os)
+       virtual void serialize(std::ostream &os) const
        {
                os<<getName();
                os<<" ";
@@ -251,22 +221,10 @@ public:
        }
        virtual InventoryItem* clone()
        {
-               return new CraftItem(m_subname, m_count);
+               return new CraftItem(m_gamedef, m_subname, m_count);
        }
 #ifndef SERVER
-       video::ITexture * getImage()
-       {
-               std::string basename;
-               if(m_subname == "Stick")
-                       basename = "../data/stick.png";
-               // Default to cloud texture
-               else
-                       basename = tile_texture_path_get(TILE_CLOUD);
-               
-               // Get such a texture
-               return g_irrlicht->getTexture(basename);
-               //return g_irrlicht->getTexture(TextureSpec(finalname, basename, mod));
-       }
+       video::ITexture * getImage(ITextureSource *tsrc) const;
 #endif
        std::string getText()
        {
@@ -274,7 +232,11 @@ public:
                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;
@@ -283,12 +245,22 @@ public:
                        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() const;
+       InventoryItem *createCookResult() const;
+
+       bool use(ServerEnvironment *env, ServerActiveObject *user);
+       
        /*
                Special methods
        */
@@ -303,8 +275,8 @@ private:
 class ToolItem : public InventoryItem
 {
 public:
-       ToolItem(std::string toolname, u16 wear):
-               InventoryItem(1)
+       ToolItem(IGameDef *gamedef, std::string toolname, u16 wear):
+               InventoryItem(gamedef, 1)
        {
                m_toolname = toolname;
                m_wear = wear;
@@ -316,7 +288,7 @@ public:
        {
                return "ToolItem";
        }
-       virtual void serialize(std::ostream &os)
+       virtual void serialize(std::ostream &os) const
        {
                os<<getName();
                os<<" ";
@@ -326,41 +298,15 @@ public:
        }
        virtual InventoryItem* clone()
        {
-               return new ToolItem(m_toolname, m_wear);
+               return new ToolItem(m_gamedef, m_toolname, m_wear);
        }
-#ifndef SERVER
-       video::ITexture * getImage()
-       {
-               std::string basename;
-               if(m_toolname == "WPick")
-                       basename = "../data/tool_wpick.png";
-               else if(m_toolname == "STPick")
-                       basename = "../data/tool_stpick.png";
-               else if(m_toolname == "MesePick")
-                       basename = "../data/tool_mesepick.png";
-               // Default to cloud texture
-               else
-                       basename = tile_texture_path_get(TILE_CLOUD);
-               
-               /*
-                       Calculate some progress value with sane amount of
-                       maximum states
-               */
-               u32 maxprogress = 30;
-               u32 toolprogress = (65535-m_wear)/(65535/maxprogress);
-               
-               // Make texture name for the new texture with a progress bar
-               std::ostringstream os;
-               os<<basename<<"-toolprogress-"<<toolprogress;
-               std::string finalname = os.str();
 
-               float value_f = (float)toolprogress / (float)maxprogress;
-               
-               // Get such a texture
-               TextureMod *mod = new ProgressBarTextureMod(value_f);
-               return g_irrlicht->getTexture(TextureSpec(finalname, basename, mod));
-       }
+       std::string getImageBasename() const;
+#ifndef SERVER
+       video::ITexture * getImage(ITextureSource *tsrc) const;
+       video::ITexture * getImageRaw(ITextureSource *tsrc) const;
 #endif
+
        std::string getText()
        {
                return "";
@@ -417,23 +363,29 @@ public:
        InventoryList(std::string name, u32 size);
        ~InventoryList();
        void clearItems();
-       void serialize(std::ostream &os);
-       void deSerialize(std::istream &is);
+       void serialize(std::ostream &os) const;
+       void deSerialize(std::istream &is, IGameDef *gamedef);
 
        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);
        // Delete item
        void deleteItem(u32 i);
+
        // Adds an item to a suitable place. Returns leftover item.
        // If all went into the list, returns NULL.
        InventoryItem * addItem(InventoryItem *newitem);
@@ -444,6 +396,15 @@ public:
        // If can be added fully, NULL is returned.
        InventoryItem * addItem(u32 i, InventoryItem *newitem);
 
+       // Checks whether the item could be added to the given slot
+       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.
        // Returns NULL if couldn't take any.
@@ -458,6 +419,7 @@ private:
        core::array<InventoryItem*> m_items;
        u32 m_size;
        std::string m_name;
+       //bool m_dirty;
 };
 
 class Inventory
@@ -471,11 +433,12 @@ public:
        Inventory(const Inventory &other);
        Inventory & operator = (const Inventory &other);
        
-       void serialize(std::ostream &os);
-       void deSerialize(std::istream &is);
+       void serialize(std::ostream &os) const;
+       void deSerialize(std::istream &is, IGameDef *gamedef);
 
        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.
@@ -489,11 +452,46 @@ public:
        
 private:
        // -1 if not found
-       s32 getListIndex(const std::string &name);
+       const s32 getListIndex(const std::string &name) const;
 
        core::array<InventoryList*> m_lists;
 };
 
+class Player;
+
+struct InventoryContext
+{
+       Player *current_player;
+       
+       InventoryContext():
+               current_player(NULL)
+       {}
+};
+
+struct InventoryAction;
+
+class InventoryManager
+{
+public:
+       InventoryManager(){}
+       virtual ~InventoryManager(){}
+       
+       /*
+               Get a pointer to an inventory specified by id.
+               id can be:
+               - "current_player"
+               - "nodemeta:X,Y,Z"
+       */
+       virtual Inventory* getInventory(InventoryContext *c, std::string id)
+               {return NULL;}
+       // Used on the server by InventoryAction::apply and other stuff
+       virtual void inventoryModified(InventoryContext *c, std::string id)
+               {}
+       // Used on the client
+       virtual void inventoryAction(InventoryAction *a)
+               {}
+};
+
 #define IACTION_MOVE 0
 
 struct InventoryAction
@@ -501,17 +499,19 @@ struct InventoryAction
        static InventoryAction * deSerialize(std::istream &is);
        
        virtual u16 getType() const = 0;
-       virtual void serialize(std::ostream &os) = 0;
-       virtual void apply(Inventory *inventory) = 0;
+       virtual void serialize(std::ostream &os) const = 0;
+       virtual void apply(InventoryContext *c, InventoryManager *mgr) = 0;
 };
 
 struct IMoveAction : public InventoryAction
 {
        // count=0 means "everything"
        u16 count;
-       std::string from_name;
+       std::string from_inv;
+       std::string from_list;
        s16 from_i;
-       std::string to_name;
+       std::string to_inv;
+       std::string to_list;
        s16 to_i;
        
        IMoveAction()
@@ -527,12 +527,16 @@ struct IMoveAction : public InventoryAction
                std::getline(is, ts, ' ');
                count = stoi(ts);
 
-               std::getline(is, from_name, ' ');
+               std::getline(is, from_inv, ' ');
+
+               std::getline(is, from_list, ' ');
 
                std::getline(is, ts, ' ');
                from_i = stoi(ts);
 
-               std::getline(is, to_name, ' ');
+               std::getline(is, to_inv, ' ');
+
+               std::getline(is, to_list, ' ');
 
                std::getline(is, ts, ' ');
                to_i = stoi(ts);
@@ -543,18 +547,66 @@ struct IMoveAction : public InventoryAction
                return IACTION_MOVE;
        }
 
-       void serialize(std::ostream &os)
+       void serialize(std::ostream &os) const
        {
                os<<"Move ";
                os<<count<<" ";
-               os<<from_name<<" ";
+               os<<from_inv<<" ";
+               os<<from_list<<" ";
                os<<from_i<<" ";
-               os<<to_name<<" ";
+               os<<to_inv<<" ";
+               os<<to_list<<" ";
                os<<to_i;
        }
 
-       void apply(Inventory *inventory);
+       void apply(InventoryContext *c, InventoryManager *mgr);
+};
+
+/*
+       Craft checking system
+*/
+
+enum ItemSpecType
+{
+       ITEM_NONE,
+       ITEM_MATERIAL,
+       ITEM_CRAFT,
+       ITEM_TOOL,
+       ITEM_MBO
 };
 
+struct ItemSpec
+{
+       enum ItemSpecType type;
+       // Only other one of these is used
+       std::string name;
+       u16 num;
+
+       ItemSpec():
+               type(ITEM_NONE)
+       {
+       }
+       ItemSpec(enum ItemSpecType a_type, std::string a_name):
+               type(a_type),
+               name(a_name),
+               num(65535)
+       {
+       }
+       ItemSpec(enum ItemSpecType a_type, u16 a_num):
+               type(a_type),
+               name(""),
+               num(a_num)
+       {
+       }
+
+       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(const InventoryItem * const*items, const ItemSpec *specs);
+
 #endif