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 #include <map>
  27
  28 /*
  29         NodeMetadata stores arbitary amounts of data for special blocks.
  30         Used for furnaces, chests and signs.
  31
  32         There are two interaction methods: inventory menu and text input.
  33         Only one can be used for a single metadata, thus only inventory OR
  34         text input should exist in a metadata.
  35 */
  36
  37 class Inventory;
  38 class IGameDef;
  39
  40 class NodeMetadata
  41 {
  42 public:
  43         NodeMetadata(IGameDef *gamedef);
  44         ~NodeMetadata();
  45
  46         void serialize(std::ostream &os) const;
  47         void deSerialize(std::istream &is);
  48
  49         void clear();
  50
  51         // Generic key/value store
  52         std::string getString(const std::string &name) const
  53         {
  54                 std::map<std::string, std::string>::const_iterator i;
  55                 i = m_stringvars.find(name);
  56                 if(i == m_stringvars.end())
  57                         return "";
  58                 return i->second;
  59         }
  60         void setString(const std::string &name, const std::string &var)
  61         {
  62                 if(var.empty())
  63                         m_stringvars.erase(name);
  64                 else
  65                         m_stringvars[name] = var;
  66         }
  67
  68         // The inventory
  69         Inventory* getInventory()
  70         {
  71                 return m_inventory;
  72         }
  73
  74         // If non-empty, player can interact by using an inventory view
  75         // See format in guiInventoryMenu.cpp.
  76         std::string getInventoryDrawSpec() const
  77         {
  78                 return m_inventorydrawspec;
  79         }
  80         void setInventoryDrawSpec(const std::string &text)
  81         {
  82                 m_inventorydrawspec = text;
  83         }
  84
  85         // If non-empty, player can interact by using an form view
  86         // See format in guiFormMenu.cpp.
  87         std::string getFormSpec() const
  88         {
  89                 return m_formspec;
  90         }
  91         void setFormSpec(const std::string &text)
  92         {
  93                 m_formspec = text;
  94         }
  95
  96         // Called on client-side; shown on screen when pointed at
  97         std::string getInfoText() const
  98         {
  99                 return m_infotext;
 100         }
 101         void setInfoText(const std::string &text)
 102         {
 103                 m_infotext = text;
 104         }
 105
 106         // Whether the related node and this metadata can be removed
 107         bool getAllowRemoval() const
 108         {
 109                 return m_allow_removal;
 110         }
 111         void setAllowRemoval(bool b)
 112         {
 113                 m_allow_removal = b;
 114         }
 115
 116 private:
 117         std::map<std::string, std::string> m_stringvars;
 118         Inventory *m_inventory;
 119         std::string m_inventorydrawspec;
 120         std::string m_formspec;
 121         std::string m_infotext;
 122         bool m_allow_removal;
 123 };
 124
 125
 126 /*
 127         List of metadata of all the nodes of a block
 128 */
 129
 130 class NodeMetadataList
 131 {
 132 public:
 133         ~NodeMetadataList();
 134
 135         void serialize(std::ostream &os) const;
 136         void deSerialize(std::istream &is, IGameDef *gamedef);
 137
 138         // Get pointer to data
 139         NodeMetadata* get(v3s16 p);
 140         // Deletes data
 141         void remove(v3s16 p);
 142         // Deletes old data and sets a new one
 143         void set(v3s16 p, NodeMetadata *d);
 144         // Deletes all
 145         void clear();
 146
 147 private:
 148         std::map<v3s16, NodeMetadata*> m_data;
 149 };
 150
 151 #endif
 152