minetest/src/inventory.h

690 lines
13 KiB
C
Raw Normal View History

/*
Minetest-c55
Copyright (C) 2010 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
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
2010-11-27 00:02:21 +01:00
/*
(c) 2010 Perttu Ahola <celeron55@gmail.com>
*/
#ifndef INVENTORY_HEADER
#define INVENTORY_HEADER
#include <iostream>
#include <sstream>
#include <string>
#include "common_irrlicht.h"
#include "debug.h"
#include "mapblockobject.h"
// For g_materials
#include "main.h"
#define QUANTITY_ITEM_MAX_COUNT 99
class ServerActiveObject;
class ServerEnvironment;
2010-11-27 00:02:21 +01:00
class InventoryItem
{
public:
InventoryItem(u16 count);
2010-11-27 00:02:21 +01:00
virtual ~InventoryItem();
static InventoryItem* deSerialize(std::istream &is);
virtual const char* getName() const = 0;
// Shall write the name and the parameters
virtual void serialize(std::ostream &os) = 0;
// Shall make an exact clone of the item
virtual InventoryItem* clone() = 0;
2010-12-21 17:08:24 +01:00
#ifndef SERVER
2010-11-27 00:02:21 +01:00
// Shall return an image to show in the GUI (or NULL)
virtual video::ITexture * getImage() { return NULL; }
2010-12-21 17:08:24 +01:00
#endif
2010-11-27 00:02:21 +01:00
// 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);
2011-04-19 16:09:45 +02:00
// Gets amount of items that dropping one SAO will decrement
virtual u16 getDropCount(){ return getCount(); }
/*
Quantity methods
*/
2010-11-27 00:02:21 +01:00
// 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;
}
2011-04-05 09:59:48 +02:00
// 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;
}
2010-11-27 00:02:21 +01:00
2011-04-05 09:59:48 +02:00
/*
Other properties
*/
// Whether it can be cooked
virtual bool isCookable(){return false;}
2011-04-05 09:59:48 +02:00
// Time of cooking
virtual float getCookTime(){return 3.0;}
// Result of cooking
virtual InventoryItem *createCookResult(){return NULL;}
protected:
u16 m_count;
};
2010-11-27 00:02:21 +01:00
class MaterialItem : public InventoryItem
{
public:
MaterialItem(u8 content, u16 count):
InventoryItem(count)
2010-11-27 00:02:21 +01:00
{
2010-12-14 00:56:24 +01:00
m_content = content;
2010-11-27 00:02:21 +01:00
}
/*
Implementation interface
*/
virtual const char* getName() const
{
return "MaterialItem";
}
virtual void serialize(std::ostream &os)
{
//os.imbue(std::locale("C"));
os<<getName();
os<<" ";
2010-12-14 00:56:24 +01:00
os<<(unsigned int)m_content;
2010-11-27 00:02:21 +01:00
os<<" ";
os<<m_count;
}
virtual InventoryItem* clone()
{
2010-12-14 00:56:24 +01:00
return new MaterialItem(m_content, m_count);
2010-11-27 00:02:21 +01:00
}
#ifndef SERVER
2010-11-27 00:02:21 +01:00
video::ITexture * getImage()
{
2011-02-11 15:43:26 +01:00
return content_features(m_content).inventory_texture;
return NULL;
2010-11-27 00:02:21 +01:00
}
#endif
2010-11-27 00:02:21 +01:00
std::string getText()
{
std::ostringstream os;
os<<m_count;
return os.str();
}
virtual bool addableTo(InventoryItem *other)
2010-11-27 00:02:21 +01:00
{
if(std::string(other->getName()) != "MaterialItem")
return false;
MaterialItem *m = (MaterialItem*)other;
if(m->getMaterial() != m_content)
return false;
return true;
2010-11-27 00:02:21 +01:00
}
u16 freeSpace()
{
if(m_count > QUANTITY_ITEM_MAX_COUNT)
2010-11-27 00:02:21 +01:00
return 0;
return QUANTITY_ITEM_MAX_COUNT - m_count;
2010-11-27 00:02:21 +01:00
}
2011-04-05 09:59:48 +02:00
/*
Other properties
*/
bool isCookable();
2011-04-05 09:59:48 +02:00
InventoryItem *createCookResult();
/*
Special methods
*/
u8 getMaterial()
2010-11-27 00:02:21 +01:00
{
return m_content;
2010-11-27 00:02:21 +01:00
}
private:
2010-12-14 00:56:24 +01:00
u8 m_content;
2010-11-27 00:02:21 +01:00
};
//TODO: Remove
2010-11-27 00:02:21 +01:00
class MapBlockObjectItem : public InventoryItem
{
public:
MapBlockObjectItem(std::string inventorystring):
InventoryItem(1)
2010-11-27 00:02:21 +01:00
{
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);
}
2010-12-21 17:08:24 +01:00
#ifndef SERVER
2010-11-27 00:02:21 +01:00
video::ITexture * getImage();
2010-12-21 17:08:24 +01:00
#endif
2010-11-27 00:02:21 +01:00
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;
};
/*
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);
2011-04-19 16:09:45 +02:00
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;
};
2010-12-24 02:08:05 +01:00
class ToolItem : public InventoryItem
{
public:
ToolItem(std::string toolname, u16 wear):
InventoryItem(1)
2010-12-24 02:08:05 +01:00
{
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()
{
2011-02-11 15:43:26 +01:00
if(g_texturesource == NULL)
return NULL;
2010-12-24 10:44:26 +01:00
std::string basename;
2010-12-24 02:08:05 +01:00
if(m_toolname == "WPick")
basename = "tool_woodpick.png";
2010-12-24 10:44:26 +01:00
else if(m_toolname == "STPick")
basename = "tool_stonepick.png";
else if(m_toolname == "SteelPick")
basename = "tool_steelpick.png";
2010-12-25 01:33:41 +01:00
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";
2010-12-24 10:44:26 +01:00
else
basename = "cloud.png";
2010-12-24 10:44:26 +01:00
/*
Calculate a progress value with sane amount of
2010-12-24 10:44:26 +01:00
maximum states
*/
u32 maxprogress = 30;
u32 toolprogress = (65535-m_wear)/(65535/maxprogress);
float value_f = (float)toolprogress / (float)maxprogress;
std::ostringstream os;
2011-02-11 15:43:26 +01:00
os<<basename<<"^[progressbar"<<value_f;
return g_texturesource->getTextureRaw(os.str());
2010-12-24 02:08:05 +01:00
}
#endif
std::string getText()
{
2010-12-24 10:44:26 +01:00
return "";
/*std::ostringstream os;
2010-12-24 02:08:05 +01:00
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<<'-';
2010-12-24 10:44:26 +01:00
return os.str();*/
2010-12-24 02:08:05 +01:00
/*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;
}
2010-12-25 00:54:39 +01:00
// 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;
}
}
2010-12-24 02:08:05 +01:00
private:
std::string m_toolname;
u16 m_wear;
};
2010-12-22 10:29:06 +01:00
class InventoryList
2010-11-27 00:02:21 +01:00
{
public:
2010-12-22 10:29:06 +01:00
InventoryList(std::string name, u32 size);
~InventoryList();
2010-11-27 00:02:21 +01:00
void clearItems();
void serialize(std::ostream &os);
void deSerialize(std::istream &is);
2010-12-22 10:29:06 +01:00
InventoryList(const InventoryList &other);
InventoryList & operator = (const InventoryList &other);
2010-11-27 00:02:21 +01:00
2010-12-22 10:29:06 +01:00
std::string getName();
2010-11-27 00:02:21 +01:00
u32 getSize();
2010-12-22 10:29:06 +01:00
// Count used slots
2010-11-27 00:02:21 +01:00
u32 getUsedSlots();
2011-04-05 09:59:48 +02:00
u32 getFreeSlots();
/*bool getDirty(){ return m_dirty; }
void setDirty(bool dirty=true){ m_dirty = dirty; }*/
2010-11-27 00:02:21 +01:00
2010-12-22 15:30:23 +01:00
// Get pointer to item
2010-11-27 00:02:21 +01:00
InventoryItem * getItem(u32 i);
// Returns old item (or NULL). Parameter can be NULL.
InventoryItem * changeItem(u32 i, InventoryItem *newitem);
2010-12-22 15:30:23 +01:00
// Delete item
2010-11-27 00:02:21 +01:00
void deleteItem(u32 i);
2011-04-05 01:56:29 +02:00
// 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);
2011-04-05 01:56:29 +02:00
// 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);
2010-12-22 15:30:23 +01:00
// Decrements amount of every material item
void decrementMaterials(u16 count);
2010-11-27 00:02:21 +01:00
void print(std::ostream &o);
private:
core::array<InventoryItem*> m_items;
u32 m_size;
2010-12-22 10:29:06 +01:00
std::string m_name;
//bool m_dirty;
2010-12-22 10:29:06 +01:00
};
class Inventory
{
public:
~Inventory();
void clear();
Inventory();
Inventory(const Inventory &other);
Inventory & operator = (const Inventory &other);
void serialize(std::ostream &os);
void deSerialize(std::istream &is);
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.
// Returns NULL if the item was fully added, leftover otherwise.
InventoryItem * addItem(const std::string &listname, InventoryItem *newitem)
2010-12-22 10:29:06 +01:00
{
InventoryList *list = getList(listname);
if(list == NULL)
return newitem;
2010-12-22 10:29:06 +01:00
return list->addItem(newitem);
}
private:
// -1 if not found
s32 getListIndex(const std::string &name);
core::array<InventoryList*> m_lists;
2010-11-27 00:02:21 +01:00
};
2011-04-04 14:13:19 +02:00
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;}
2011-04-05 01:56:29 +02:00
// Used on the server by InventoryAction::apply and other stuff
2011-04-04 14:13:19 +02:00
virtual void inventoryModified(InventoryContext *c, std::string id)
{}
// Used on the client
virtual void inventoryAction(InventoryAction *a)
{}
};
2010-12-22 15:30:23 +01:00
#define IACTION_MOVE 0
struct InventoryAction
{
static InventoryAction * deSerialize(std::istream &is);
virtual u16 getType() const = 0;
virtual void serialize(std::ostream &os) = 0;
2011-04-04 14:13:19 +02:00
virtual void apply(InventoryContext *c, InventoryManager *mgr) = 0;
2010-12-22 15:30:23 +01:00
};
struct IMoveAction : public InventoryAction
{
// count=0 means "everything"
2010-12-22 15:30:23 +01:00
u16 count;
2011-04-04 14:13:19 +02:00
std::string from_inv;
std::string from_list;
2010-12-22 15:30:23 +01:00
s16 from_i;
2011-04-04 14:13:19 +02:00
std::string to_inv;
std::string to_list;
2010-12-22 15:30:23 +01:00
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);
2011-04-04 14:13:19 +02:00
std::getline(is, from_inv, ' ');
std::getline(is, from_list, ' ');
2010-12-22 15:30:23 +01:00
std::getline(is, ts, ' ');
from_i = stoi(ts);
2011-04-04 14:13:19 +02:00
std::getline(is, to_inv, ' ');
std::getline(is, to_list, ' ');
2010-12-22 15:30:23 +01:00
std::getline(is, ts, ' ');
to_i = stoi(ts);
}
u16 getType() const
{
return IACTION_MOVE;
}
void serialize(std::ostream &os)
{
os<<"Move ";
os<<count<<" ";
2011-04-04 14:13:19 +02:00
os<<from_inv<<" ";
os<<from_list<<" ";
2010-12-22 15:30:23 +01:00
os<<from_i<<" ";
2011-04-04 14:13:19 +02:00
os<<to_inv<<" ";
os<<to_list<<" ";
2010-12-22 15:30:23 +01:00
os<<to_i;
}
2011-04-04 14:13:19 +02:00
void apply(InventoryContext *c, InventoryManager *mgr);
2010-12-22 15:30:23 +01:00
};
2011-04-05 01:56:29 +02:00
/*
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);
2010-11-27 00:02:21 +01:00
#endif