Random Lua tweaks/fixes

[minetest.git] / src / nodemetadata.h

diff --git a/src/nodemetadata.h b/src/nodemetadata.h
index 21916677ee370e01d61bfc6ee50b3ec6ac8e45f7..9eb08678ad381be42d2655b3d6b1160278200607 100644 (file)
--- a/src/nodemetadata.h
+++ b/src/nodemetadata.h
@@ -25,73 +25,59 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #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);
 
-       NodeMetadata();
+       NodeMetadata(IGameDef *gamedef);
        virtual ~NodeMetadata();
        
-       static NodeMetadata* deSerialize(std::istream &is);
+       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 NodeMetadata* clone(IGameDef *gamedef) = 0;
        virtual void serializeBody(std::ostream &os) = 0;
-       virtual std::string infoText() { return "<todo: remove this text>"; }
-
+       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
+       virtual void inventoryModified(){}
+       // A step in time. Returns true if metadata changed.
+       virtual bool step(float dtime) {return false;}
+       virtual bool nodeRemovalDisabled(){return false;}
+       // Used to make custom inventory menus.
+       // See format in guiInventoryMenu.cpp.
+       virtual std::string getInventoryDrawSpecString(){return "";}
+       // primarily used for locking chests, but others can play too
+       virtual std::string getOwner(){ return std::string(""); }
+       virtual void setOwner(std::string t){}
+       virtual bool allowsTextInput(){ return false; }
+       virtual std::string getText(){ return ""; }
+       virtual void setText(const std::string &t){}
 protected:
        static void registerType(u16 id, Factory f);
+       IGameDef *m_gamedef;
 private:
        static core::map<u16, Factory> m_types;
 };
 
-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();
-
-       std::string getText(){ return m_text; }
-       void setText(std::string t){ m_text = t; }
-
-private:
-       std::string m_text;
-};
-
-class ChestNodeMetadata : public NodeMetadata
-{
-public:
-       ChestNodeMetadata();
-       
-       virtual u16 typeId() const;
-       static NodeMetadata* create(std::istream &is);
-       virtual NodeMetadata* clone();
-       virtual void serializeBody(std::ostream &os);
-       virtual std::string infoText();
-
-private:
-};
+/*
+       List of metadata of all the nodes of a block
+*/
 
 class NodeMetadataList
 {
@@ -99,7 +85,7 @@ class NodeMetadataList
        ~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);
@@ -107,6 +93,10 @@ class NodeMetadataList
        void remove(v3s16 p);
        // Deletes old data and sets a new one
        void set(v3s16 p, NodeMetadata *d);
+       
+       // A step in time. Returns true if something changed.
+       bool step(float dtime);
+
 private:
        core::map<v3s16, NodeMetadata*> m_data;
 };