src/nodemetadata.h

   1 /*
   2 Minetest-c55
   3 Copyright (C) 2010-2011 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU General Public License as published by
   7 the Free Software Foundation; either version 2 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #ifndef NODEMETADATA_HEADER
  21 #define NODEMETADATA_HEADER
  22
  23 #include "irrlichttypes.h"
  24 #include <string>
  25 #include <iostream>
  26
  27 /*
  28         NodeMetadata stores arbitary amounts of data for special blocks.
  29         Used for furnaces, chests and signs.
  30
  31         There are two interaction methods: inventory menu and text input.
  32         Only one can be used for a single metadata, thus only inventory OR
  33         text input should exist in a metadata.
  34 */
  35
  36 class Inventory;
  37 class IGameDef;
  38
  39 class NodeMetadata
  40 {
  41 public:
  42         typedef NodeMetadata* (*Factory)(std::istream&, IGameDef *gamedef);
  43         typedef NodeMetadata* (*Factory2)(IGameDef *gamedef);
  44
  45         NodeMetadata(IGameDef *gamedef);
  46         virtual ~NodeMetadata();
  47
  48         static NodeMetadata* create(const std::string &name, IGameDef *gamedef);
  49         static NodeMetadata* deSerialize(std::istream &is, IGameDef *gamedef);
  50         void serialize(std::ostream &os);
  51
  52         virtual u16 typeId() const = 0;
  53         virtual const char* typeName() const = 0;
  54         virtual NodeMetadata* clone(IGameDef *gamedef) = 0;
  55         virtual void serializeBody(std::ostream &os) = 0;
  56         virtual std::string infoText() {return "";}
  57         virtual Inventory* getInventory() {return NULL;}
  58         // This is called always after the inventory is modified, before
  59         // the changes are copied elsewhere
  60         virtual void inventoryModified(){}
  61         // A step in time. Returns true if metadata changed.
  62         virtual bool step(float dtime) {return false;}
  63         virtual bool nodeRemovalDisabled(){return false;}
  64         // Used to make custom inventory menus.
  65         // See format in guiInventoryMenu.cpp.
  66         virtual std::string getInventoryDrawSpecString(){return "";}
  67         // primarily used for locking chests, but others can play too
  68         virtual std::string getOwner(){ return std::string(""); }
  69         virtual void setOwner(std::string t){}
  70         virtual bool allowsTextInput(){ return false; }
  71         virtual std::string getText(){ return ""; }
  72         virtual void setText(const std::string &t){}
  73 protected:
  74         static void registerType(u16 id, const std::string &name, Factory f,
  75                         Factory2 f2);
  76         IGameDef *m_gamedef;
  77 private:
  78         static core::map<u16, Factory> m_types;
  79         static core::map<std::string, Factory2> m_names;
  80 };
  81
  82 /*
  83         List of metadata of all the nodes of a block
  84 */
  85
  86 class NodeMetadataList
  87 {
  88 public:
  89         ~NodeMetadataList();
  90
  91         void serialize(std::ostream &os);
  92         void deSerialize(std::istream &is, IGameDef *gamedef);
  93
  94         // Get pointer to data
  95         NodeMetadata* get(v3s16 p);
  96         // Deletes data
  97         void remove(v3s16 p);
  98         // Deletes old data and sets a new one
  99         void set(v3s16 p, NodeMetadata *d);
 100
 101         // A step in time. Returns true if something changed.
 102         bool step(float dtime);
 103
 104 private:
 105         core::map<v3s16, NodeMetadata*> m_data;
 106 };
 107
 108 #endif
 109