comment update
[oweals/minetest.git] / src / inventory.h
index d37761cfedfc3906eaf4fcef49a693b3acc10f15..07d81a3f7eecb77c8575616bd87a763d447357f4 100644 (file)
@@ -33,10 +33,15 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 // For g_materials
 #include "main.h"
 
+#define QUANTITY_ITEM_MAX_COUNT 99
+
+class ServerActiveObject;
+class ServerEnvironment;
+
 class InventoryItem
 {
 public:
-       InventoryItem();
+       InventoryItem(u16 count);
        virtual ~InventoryItem();
        
        static InventoryItem* deSerialize(std::istream &is);
@@ -52,19 +57,66 @@ public:
 #endif
        // Shall return a text to show in the GUI
        virtual std::string getText() { return ""; }
+       // 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(){ return getCount(); }
 
-private:
-};
+       /*
+               Quantity methods
+       */
+
+       // Shall return true if the item can be add()ed to the other
+       virtual bool addableTo(InventoryItem *other)
+       {
+               return false;
+       }
+       
+       u16 getCount()
+       {
+               return m_count;
+       }
+       void setCount(u16 count)
+       {
+               m_count = count;
+       }
+       // This should return something else for stackable items
+       virtual u16 freeSpace()
+       {
+               return 0;
+       }
+       void add(u16 count)
+       {
+               assert(m_count + count <= QUANTITY_ITEM_MAX_COUNT);
+               m_count += count;
+       }
+       void remove(u16 count)
+       {
+               assert(m_count >= count);
+               m_count -= count;
+       }
+
+       /*
+               Other properties
+       */
+       // Whether it can be cooked
+       virtual bool isCookable(){return false;}
+       // Time of cooking
+       virtual float getCookTime(){return 3.0;}
+       // Result of cooking
+       virtual InventoryItem *createCookResult(){return NULL;}
 
-#define MATERIAL_ITEM_MAX_COUNT 99
+protected:
+       u16 m_count;
+};
 
 class MaterialItem : public InventoryItem
 {
 public:
-       MaterialItem(u8 content, u16 count)
+       MaterialItem(u8 content, u16 count):
+               InventoryItem(count)
        {
                m_content = content;
-               m_count = count;
        }
        /*
                Implementation interface
@@ -89,16 +141,8 @@ public:
 #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]);
+               return content_features(m_content).inventory_texture;
+               return NULL;
        }
 #endif
        std::string getText()
@@ -107,46 +151,44 @@ public:
                os<<m_count;
                return os.str();
        }
-       /*
-               Special methods
-       */
-       u8 getMaterial()
-       {
-               return m_content;
-       }
-       u16 getCount()
+
+       virtual bool addableTo(InventoryItem *other)
        {
-               return m_count;
+               if(std::string(other->getName()) != "MaterialItem")
+                       return false;
+               MaterialItem *m = (MaterialItem*)other;
+               if(m->getMaterial() != m_content)
+                       return false;
+               return true;
        }
        u16 freeSpace()
        {
-               if(m_count > MATERIAL_ITEM_MAX_COUNT)
+               if(m_count > QUANTITY_ITEM_MAX_COUNT)
                        return 0;
-               return MATERIAL_ITEM_MAX_COUNT - m_count;
-       }
-       void add(u16 count)
-       {
-               assert(m_count + count <= MATERIAL_ITEM_MAX_COUNT);
-               m_count += count;
+               return QUANTITY_ITEM_MAX_COUNT - m_count;
        }
-       void remove(u16 count)
+       /*
+               Other properties
+       */
+       bool isCookable();
+       InventoryItem *createCookResult();
+       /*
+               Special methods
+       */
+       u8 getMaterial()
        {
-               assert(m_count >= count);
-               m_count -= count;
+               return m_content;
        }
 private:
        u8 m_content;
-       u16 m_count;
 };
 
+//TODO: Remove
 class MapBlockObjectItem : public InventoryItem
 {
 public:
-       /*MapBlockObjectItem(MapBlockObject *obj)
-       {
-               m_inventorystring = obj->getInventoryString();
-       }*/
-       MapBlockObjectItem(std::string inventorystring)
+       MapBlockObjectItem(std::string inventorystring):
+               InventoryItem(1)
        {
                m_inventorystring = inventorystring;
        }
@@ -196,6 +238,210 @@ private:
        std::string m_inventorystring;
 };
 
+/*
+       An item that is used as a mid-product when crafting.
+       Subnames:
+       - Stick
+*/
+class CraftItem : public InventoryItem
+{
+public:
+       CraftItem(std::string subname, u16 count):
+               InventoryItem(count)
+       {
+               m_subname = subname;
+       }
+       /*
+               Implementation interface
+       */
+       virtual const char* getName() const
+       {
+               return "CraftItem";
+       }
+       virtual void serialize(std::ostream &os)
+       {
+               os<<getName();
+               os<<" ";
+               os<<m_subname;
+               os<<" ";
+               os<<m_count;
+       }
+       virtual InventoryItem* clone()
+       {
+               return new CraftItem(m_subname, m_count);
+       }
+#ifndef SERVER
+       video::ITexture * getImage();
+#endif
+       std::string getText()
+       {
+               std::ostringstream os;
+               os<<m_count;
+               return os.str();
+       }
+
+       ServerActiveObject* createSAO(ServerEnvironment *env, u16 id, v3f pos);
+       u16 getDropCount();
+
+       virtual bool addableTo(InventoryItem *other)
+       {
+               if(std::string(other->getName()) != "CraftItem")
+                       return false;
+               CraftItem *m = (CraftItem*)other;
+               if(m->m_subname != m_subname)
+                       return false;
+               return true;
+       }
+       u16 freeSpace()
+       {
+               if(m_count > QUANTITY_ITEM_MAX_COUNT)
+                       return 0;
+               return QUANTITY_ITEM_MAX_COUNT - m_count;
+       }
+       /*
+               Other properties
+       */
+       bool isCookable();
+       InventoryItem *createCookResult();
+       /*
+               Special methods
+       */
+       std::string getSubName()
+       {
+               return m_subname;
+       }
+private:
+       std::string m_subname;
+};
+
+class ToolItem : public InventoryItem
+{
+public:
+       ToolItem(std::string toolname, u16 wear):
+               InventoryItem(1)
+       {
+               m_toolname = toolname;
+               m_wear = wear;
+       }
+       /*
+               Implementation interface
+       */
+       virtual const char* getName() const
+       {
+               return "ToolItem";
+       }
+       virtual void serialize(std::ostream &os)
+       {
+               os<<getName();
+               os<<" ";
+               os<<m_toolname;
+               os<<" ";
+               os<<m_wear;
+       }
+       virtual InventoryItem* clone()
+       {
+               return new ToolItem(m_toolname, m_wear);
+       }
+#ifndef SERVER
+       video::ITexture * getImage()
+       {
+               if(g_texturesource == NULL)
+                       return NULL;
+               
+               std::string basename;
+               if(m_toolname == "WPick")
+                       basename = "tool_woodpick.png";
+               else if(m_toolname == "STPick")
+                       basename = "tool_stonepick.png";
+               else if(m_toolname == "SteelPick")
+                       basename = "tool_steelpick.png";
+               else if(m_toolname == "MesePick")
+                       basename = "tool_mesepick.png";
+               else if(m_toolname == "WShovel")
+                       basename = "tool_woodshovel.png";
+               else if(m_toolname == "STShovel")
+                       basename = "tool_stoneshovel.png";
+               else if(m_toolname == "SteelShovel")
+                       basename = "tool_steelshovel.png";
+               else if(m_toolname == "WAxe")
+                       basename = "tool_woodaxe.png";
+               else if(m_toolname == "STAxe")
+                       basename = "tool_stoneaxe.png";
+               else if(m_toolname == "SteelAxe")
+                       basename = "tool_steelaxe.png";
+               else if(m_toolname == "WSword")
+                       basename = "tool_woodsword.png";
+               else if(m_toolname == "STSword")
+                       basename = "tool_stonesword.png";
+               else if(m_toolname == "SteelSword")
+                       basename = "tool_steelsword.png";
+               else
+                       basename = "cloud.png";
+               
+               /*
+                       Calculate a progress value with sane amount of
+                       maximum states
+               */
+               u32 maxprogress = 30;
+               u32 toolprogress = (65535-m_wear)/(65535/maxprogress);
+               
+               float value_f = (float)toolprogress / (float)maxprogress;
+               std::ostringstream os;
+               os<<basename<<"^[progressbar"<<value_f;
+
+               return g_texturesource->getTextureRaw(os.str());
+       }
+#endif
+       std::string getText()
+       {
+               return "";
+               
+               /*std::ostringstream os;
+               u16 f = 4;
+               u16 d = 65535/f;
+               u16 i;
+               for(i=0; i<(65535-m_wear)/d; i++)
+                       os<<'X';
+               for(; i<f; i++)
+                       os<<'-';
+               return os.str();*/
+               
+               /*std::ostringstream os;
+               os<<m_toolname;
+               os<<" ";
+               os<<(m_wear/655);
+               return os.str();*/
+       }
+       /*
+               Special methods
+       */
+       std::string getToolName()
+       {
+               return m_toolname;
+       }
+       u16 getWear()
+       {
+               return m_wear;
+       }
+       // Returns true if weared out
+       bool addWear(u16 add)
+       {
+               if(m_wear >= 65535 - add)
+               {
+                       m_wear = 65535;
+                       return true;
+               }
+               else
+               {
+                       m_wear += add;
+                       return false;
+               }
+       }
+private:
+       std::string m_toolname;
+       u16 m_wear;
+};
+
 class InventoryList
 {
 public:
@@ -212,13 +458,38 @@ public:
        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
        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 false if failed.
-       bool addItem(InventoryItem *newitem);
+
+       // Adds an item to a suitable place. Returns leftover item.
+       // If all went into the list, returns NULL.
+       InventoryItem * addItem(InventoryItem *newitem);
+
+       // If possible, adds item to given slot.
+       // If cannot be added at all, returns the item back.
+       // If can be added partly, decremented item is returned back.
+       // 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(u32 i, InventoryItem *newitem);
+
+       // Takes some items from a slot.
+       // If there are not enough, takes as many as it can.
+       // Returns NULL if couldn't take any.
+       InventoryItem * takeItem(u32 i, u32 count);
+
+       // Decrements amount of every material item
+       void decrementMaterials(u16 count);
 
        void print(std::ostream &o);
        
@@ -226,6 +497,7 @@ private:
        core::array<InventoryItem*> m_items;
        u32 m_size;
        std::string m_name;
+       //bool m_dirty;
 };
 
 class Inventory
@@ -245,12 +517,13 @@ public:
        InventoryList * addList(const std::string &name, u32 size);
        InventoryList * getList(const std::string &name);
        bool deleteList(const std::string &name);
-       // A shorthand for adding items
-       bool addItem(const std::string &listname, InventoryItem *newitem)
+       // A shorthand for adding items.
+       // Returns NULL if the item was fully added, leftover otherwise.
+       InventoryItem * addItem(const std::string &listname, InventoryItem *newitem)
        {
                InventoryList *list = getList(listname);
                if(list == NULL)
-                       return false;
+                       return newitem;
                return list->addItem(newitem);
        }
        
@@ -261,5 +534,156 @@ private:
        core::array<InventoryList*> m_lists;
 };
 
+class Player;
+
+struct InventoryContext
+{
+       Player *current_player;
+       
+       InventoryContext():
+               current_player(NULL)
+       {}
+};
+
+class 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
+{
+       static InventoryAction * deSerialize(std::istream &is);
+       
+       virtual u16 getType() const = 0;
+       virtual void serialize(std::ostream &os) = 0;
+       virtual void apply(InventoryContext *c, InventoryManager *mgr) = 0;
+};
+
+struct IMoveAction : public InventoryAction
+{
+       // count=0 means "everything"
+       u16 count;
+       std::string from_inv;
+       std::string from_list;
+       s16 from_i;
+       std::string to_inv;
+       std::string to_list;
+       s16 to_i;
+       
+       IMoveAction()
+       {
+               count = 0;
+               from_i = -1;
+               to_i = -1;
+       }
+       IMoveAction(std::istream &is)
+       {
+               std::string ts;
+
+               std::getline(is, ts, ' ');
+               count = stoi(ts);
+
+               std::getline(is, from_inv, ' ');
+
+               std::getline(is, from_list, ' ');
+
+               std::getline(is, ts, ' ');
+               from_i = stoi(ts);
+
+               std::getline(is, to_inv, ' ');
+
+               std::getline(is, to_list, ' ');
+
+               std::getline(is, ts, ' ');
+               to_i = stoi(ts);
+       }
+
+       u16 getType() const
+       {
+               return IACTION_MOVE;
+       }
+
+       void serialize(std::ostream &os)
+       {
+               os<<"Move ";
+               os<<count<<" ";
+               os<<from_inv<<" ";
+               os<<from_list<<" ";
+               os<<from_i<<" ";
+               os<<to_inv<<" ";
+               os<<to_list<<" ";
+               os<<to_i;
+       }
+
+       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(InventoryItem *item);
+};
+
+/*
+       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);
+
 #endif