#ifndef NODEMETADATA_HEADER
#define NODEMETADATA_HEADER
-#include "common_irrlicht.h"
+#include "irrlichttypes.h"
#include <string>
#include <iostream>
/*
- Used for storing:
+ NodeMetadata stores arbitary amounts of data for special blocks.
+ Used for furnaces, chests and signs.
- Oven:
- - Item that is being burned
- - Burning time
- - Item stack that is being heated
- - Result item stack
-
- Sign:
- - Text
+ There are two interaction methods: inventory menu and text input.
+ Only one can be used for a single metadata, thus only inventory OR
+ text input should exist in a metadata.
*/
class Inventory;
+class IGameDef;
class NodeMetadata
{
public:
- typedef NodeMetadata* (*Factory)(std::istream&);
+ typedef NodeMetadata* (*Factory)(std::istream&, IGameDef *gamedef);
+ typedef NodeMetadata* (*Factory2)(IGameDef *gamedef);
- NodeMetadata();
+ NodeMetadata(IGameDef *gamedef);
virtual ~NodeMetadata();
- static NodeMetadata* deSerialize(std::istream &is);
+ static NodeMetadata* create(const std::string &name, IGameDef *gamedef);
+ static NodeMetadata* deSerialize(std::istream &is, IGameDef *gamedef);
void serialize(std::ostream &os);
- // This usually is the CONTENT_ value
virtual u16 typeId() const = 0;
- virtual NodeMetadata* clone() = 0;
+ virtual const char* typeName() const = 0;
+ virtual NodeMetadata* clone(IGameDef *gamedef) = 0;
virtual void serializeBody(std::ostream &os) = 0;
+
+ // Called on client-side; shown on screen when pointed at
virtual std::string infoText() {return "";}
+
+ //
virtual Inventory* getInventory() {return NULL;}
- // This is called always after the inventory is modified, before
- // the changes are copied elsewhere
+ // Called always after the inventory is modified, before the changes
+ // are copied elsewhere
virtual void inventoryModified(){}
- // A step in time. Returns true if metadata changed.
+
+ // A step in time. Shall return true if metadata changed.
virtual bool step(float dtime) {return false;}
+
+ // Whether the related node and this metadata cannot be removed
virtual bool nodeRemovalDisabled(){return false;}
+ // If non-empty, player can interact by using an inventory view
+ // See format in guiInventoryMenu.cpp.
+ virtual std::string getInventoryDrawSpecString(){return "";}
-protected:
- static void registerType(u16 id, Factory f);
-private:
- static core::map<u16, Factory> m_types;
-};
+ // If true, player can interact by writing text
+ virtual bool allowsTextInput(){ return false; }
+ // Get old text for player interaction
+ virtual std::string getText(){ return ""; }
+ // Set player-written text
+ virtual void setText(const std::string &t){}
-class SignNodeMetadata : public NodeMetadata
-{
-public:
- SignNodeMetadata(std::string text);
- //~SignNodeMetadata();
-
- virtual u16 typeId() const;
- static NodeMetadata* create(std::istream &is);
- virtual NodeMetadata* clone();
- virtual void serializeBody(std::ostream &os);
- virtual std::string infoText();
+ // If returns non-empty, only given player can modify text/inventory
+ virtual std::string getOwner(){ return std::string(""); }
+ // The name of the player who placed the node
+ virtual void setOwner(std::string t){}
- std::string getText(){ return m_text; }
- void setText(std::string t){ m_text = t; }
+ /* Interface for GenericNodeMetadata */
-private:
- std::string m_text;
-};
+ virtual void setInfoText(const std::string &text){};
+ virtual void setInventoryDrawSpec(const std::string &text){};
+ virtual void setAllowTextInput(bool b){};
-class ChestNodeMetadata : public NodeMetadata
-{
-public:
- ChestNodeMetadata();
- ~ChestNodeMetadata();
-
- virtual u16 typeId() const;
- static NodeMetadata* create(std::istream &is);
- virtual NodeMetadata* clone();
- virtual void serializeBody(std::ostream &os);
- virtual std::string infoText();
- virtual Inventory* getInventory() {return m_inventory;}
-
- virtual bool nodeRemovalDisabled();
-
-private:
- Inventory *m_inventory;
-};
+ virtual void setRemovalDisabled(bool b){};
+ virtual void setEnforceOwner(bool b){};
-class FurnaceNodeMetadata : public NodeMetadata
-{
-public:
- FurnaceNodeMetadata();
- ~FurnaceNodeMetadata();
-
- virtual u16 typeId() const;
- virtual NodeMetadata* clone();
- static NodeMetadata* create(std::istream &is);
- virtual void serializeBody(std::ostream &os);
- virtual std::string infoText();
- virtual Inventory* getInventory() {return m_inventory;}
- virtual void inventoryModified();
- virtual bool step(float dtime);
+ virtual bool isInventoryModified(){return false;};
+ virtual void resetInventoryModified(){};
+ virtual bool isTextModified(){return false;};
+ virtual void resetTextModified(){};
+
+ virtual void setString(const std::string &name, const std::string &var){}
+ virtual std::string getString(const std::string &name){return "";}
+protected:
+ static void registerType(u16 id, const std::string &name, Factory f,
+ Factory2 f2);
+ IGameDef *m_gamedef;
private:
- Inventory *m_inventory;
- float m_step_accumulator;
- float m_fuel_totaltime;
- float m_fuel_time;
- float m_src_totaltime;
- float m_src_time;
+ static core::map<u16, Factory> m_types;
+ static core::map<std::string, Factory2> m_names;
};
/*
List of metadata of all the nodes of a block
*/
-class InventoryManager;
-
class NodeMetadataList
{
public:
~NodeMetadataList();
void serialize(std::ostream &os);
- void deSerialize(std::istream &is);
+ void deSerialize(std::istream &is, IGameDef *gamedef);
// Get pointer to data
NodeMetadata* get(v3s16 p);
projects / oweals / minetest.git / blobdiff