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 "common_irrlicht.h"
  24 #include <string>
  25 #include <iostream>
  26
  27 /*
  28         Used for storing:
  29
  30         Oven:
  31                 - Item that is being burned
  32                 - Burning time
  33                 - Item stack that is being heated
  34                 - Result item stack
  35
  36         Sign:
  37                 - Text
  38 */
  39
  40 class Inventory;
  41
  42 class NodeMetadata
  43 {
  44 public:
  45         typedef NodeMetadata* (*Factory)(std::istream&);
  46
  47         NodeMetadata();
  48         virtual ~NodeMetadata();
  49
  50         static NodeMetadata* deSerialize(std::istream &is);
  51         void serialize(std::ostream &os);
  52
  53         // This usually is the CONTENT_ value
  54         virtual u16 typeId() const = 0;
  55         virtual NodeMetadata* clone() = 0;
  56         virtual void serializeBody(std::ostream &os) = 0;
  57         virtual std::string infoText() {return "<todo: remove this text>";}
  58         virtual Inventory* getInventory() {return NULL;}
  59         // This is called always after the inventory is modified, before
  60         // the changes are copied elsewhere
  61         virtual void inventoryModified(){}
  62         // A step in time. Returns true if metadata changed.
  63         virtual bool step(float dtime) {return false;}
  64
  65 protected:
  66         static void registerType(u16 id, Factory f);
  67 private:
  68         static core::map<u16, Factory> m_types;
  69 };
  70
  71 class SignNodeMetadata : public NodeMetadata
  72 {
  73 public:
  74         SignNodeMetadata(std::string text);
  75         //~SignNodeMetadata();
  76
  77         virtual u16 typeId() const;
  78         static NodeMetadata* create(std::istream &is);
  79         virtual NodeMetadata* clone();
  80         virtual void serializeBody(std::ostream &os);
  81         virtual std::string infoText();
  82
  83         std::string getText(){ return m_text; }
  84         void setText(std::string t){ m_text = t; }
  85
  86 private:
  87         std::string m_text;
  88 };
  89
  90 class ChestNodeMetadata : public NodeMetadata
  91 {
  92 public:
  93         ChestNodeMetadata();
  94         ~ChestNodeMetadata();
  95
  96         virtual u16 typeId() const;
  97         static NodeMetadata* create(std::istream &is);
  98         virtual NodeMetadata* clone();
  99         virtual void serializeBody(std::ostream &os);
 100         virtual std::string infoText();
 101         virtual Inventory* getInventory() {return m_inventory;}
 102
 103 private:
 104         Inventory *m_inventory;
 105 };
 106
 107 class FurnaceNodeMetadata : public NodeMetadata
 108 {
 109 public:
 110         FurnaceNodeMetadata();
 111         ~FurnaceNodeMetadata();
 112
 113         virtual u16 typeId() const;
 114         virtual NodeMetadata* clone();
 115         static NodeMetadata* create(std::istream &is);
 116         virtual void serializeBody(std::ostream &os);
 117         virtual std::string infoText();
 118         virtual Inventory* getInventory() {return m_inventory;}
 119         virtual void inventoryModified();
 120         virtual bool step(float dtime);
 121
 122 private:
 123         Inventory *m_inventory;
 124         float m_step_accumulator;
 125         float m_fuel_totaltime;
 126         float m_fuel_time;
 127         float m_src_totaltime;
 128         float m_src_time;
 129 };
 130
 131 /*
 132         List of metadata of all the nodes of a block
 133 */
 134
 135 class InventoryManager;
 136
 137 class NodeMetadataList
 138 {
 139 public:
 140         ~NodeMetadataList();
 141
 142         void serialize(std::ostream &os);
 143         void deSerialize(std::istream &is);
 144
 145         // Get pointer to data
 146         NodeMetadata* get(v3s16 p);
 147         // Deletes data
 148         void remove(v3s16 p);
 149         // Deletes old data and sets a new one
 150         void set(v3s16 p, NodeMetadata *d);
 151
 152         // A step in time. Returns true if something changed.
 153         bool step(float dtime);
 154
 155 private:
 156         core::map<v3s16, NodeMetadata*> m_data;
 157 };
 158
 159 #endif
 160