Add core.find_nodes_with_meta() script API

[dragonfireclient.git] / src / nodemetadata.h

diff --git a/src/nodemetadata.h b/src/nodemetadata.h
index d81ade96cf434e8dbc5fc406679f44d1f535a199..acd45bdf9bde4f3b7c85a6029a84bb536bfe7c01 100644 (file)
--- a/src/nodemetadata.h
+++ b/src/nodemetadata.h
@@ -1,18 +1,18 @@
 /*
-Minetest-c55
-Copyright (C) 2010-2011 celeron55, Perttu Ahola <celeron55@gmail.com>
+Minetest
+Copyright (C) 2010-2013 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
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation; either version 2.1 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.
+GNU Lesser General Public License for more details.
 
-You should have received a copy of the GNU General Public License along
+You should have received a copy of the GNU Lesser 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.
 */
@@ -20,61 +20,57 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #ifndef NODEMETADATA_HEADER
 #define NODEMETADATA_HEADER
 
-#include "common_irrlicht.h"
+#include "irr_v3d.h"
 #include <string>
 #include <iostream>
+#include <vector>
+#include <map>
 
 /*
-       Used for storing:
-
-       Oven:
-               - Item that is being burned
-               - Burning time
-               - Item stack that is being heated
-               - Result item stack
-       
-       Sign:
-               - Text
+       NodeMetadata stores arbitary amounts of data for special blocks.
+       Used for furnaces, chests and signs.
+
+       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&);
-
-       NodeMetadata();
-       virtual ~NodeMetadata();
-       
-       static NodeMetadata* deSerialize(std::istream &is);
-       void serialize(std::ostream &os);
-       
-       // This usually is the CONTENT_ value
-       virtual u16 typeId() const = 0;
-       virtual NodeMetadata* clone() = 0;
-       virtual void serializeBody(std::ostream &os) = 0;
-       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){  }
-
-protected:
-       static void registerType(u16 id, Factory f);
+       NodeMetadata(IGameDef *gamedef);
+       ~NodeMetadata();
+
+       void serialize(std::ostream &os) const;
+       void deSerialize(std::istream &is);
+
+       void clear();
+
+       // Generic key/value store
+       std::string getString(const std::string &name, unsigned short recursion = 0) const;
+       void setString(const std::string &name, const std::string &var);
+       // Support variable names in values
+       std::string resolveString(const std::string &str, unsigned short recursion = 0) const;
+       std::map<std::string, std::string> getStrings() const
+       {
+               return m_stringvars;
+       }
+
+       // The inventory
+       Inventory* getInventory()
+       {
+               return m_inventory;
+       }
+
 private:
-       static core::map<u16, Factory> m_types;
+       std::map<std::string, std::string> m_stringvars;
+       Inventory *m_inventory;
 };
 
+
 /*
        List of metadata of all the nodes of a block
 */
@@ -84,21 +80,22 @@ class NodeMetadataList
 public:
        ~NodeMetadataList();
 
-       void serialize(std::ostream &os);
-       void deSerialize(std::istream &is);
-       
+       void serialize(std::ostream &os) const;
+       void deSerialize(std::istream &is, IGameDef *gamedef);
+
+       // Add all keys in this list to the vector keys
+       std::vector<v3s16> getAllKeys();
        // Get pointer to data
-       NodeMetadata* get(v3s16 p);
+       NodeMetadata *get(v3s16 p);
        // Deletes data
        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);
+       // Deletes all
+       void clear();
 
 private:
-       core::map<v3s16, NodeMetadata*> m_data;
+       std::map<v3s16, NodeMetadata *> m_data;
 };
 
 #endif