src/mapgen.h

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2013 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 Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser 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 MAPGEN_HEADER
  21 #define MAPGEN_HEADER
  22
  23 #include "nodedef.h"
  24 #include "mapnode.h"
  25 #include "util/string.h"
  26 #include "util/container.h"
  27
  28 #define DEFAULT_MAPGEN "v6"
  29
  30 /////////////////// Mapgen flags
  31 #define MG_TREES         0x01
  32 #define MG_CAVES         0x02
  33 #define MG_DUNGEONS      0x04
  34 #define MG_FLAT          0x08
  35 #define MG_LIGHT         0x10
  36
  37 class Settings;
  38 class ManualMapVoxelManipulator;
  39 class INodeDefManager;
  40
  41 extern FlagDesc flagdesc_mapgen[];
  42 extern FlagDesc flagdesc_gennotify[];
  43
  44 class Biome;
  45 class EmergeManager;
  46 class MapBlock;
  47 class ManualMapVoxelManipulator;
  48 class VoxelManipulator;
  49 struct BlockMakeData;
  50 class VoxelArea;
  51 class Map;
  52
  53 enum MapgenObject {
  54         MGOBJ_VMANIP,
  55         MGOBJ_HEIGHTMAP,
  56         MGOBJ_BIOMEMAP,
  57         MGOBJ_HEATMAP,
  58         MGOBJ_HUMIDMAP,
  59         MGOBJ_GENNOTIFY
  60 };
  61
  62 enum GenNotifyType {
  63         GENNOTIFY_DUNGEON,
  64         GENNOTIFY_TEMPLE,
  65         GENNOTIFY_CAVE_BEGIN,
  66         GENNOTIFY_CAVE_END,
  67         GENNOTIFY_LARGECAVE_BEGIN,
  68         GENNOTIFY_LARGECAVE_END,
  69         GENNOTIFY_DECORATION,
  70         NUM_GENNOTIFY_TYPES
  71 };
  72
  73 struct GenNotifyEvent {
  74         GenNotifyType type;
  75         v3s16 pos;
  76         u32 id;
  77 };
  78
  79 class GenerateNotifier {
  80 public:
  81         GenerateNotifier();
  82         GenerateNotifier(u32 notify_on, std::set<u32> *notify_on_deco_ids);
  83
  84         void setNotifyOn(u32 notify_on);
  85         void setNotifyOnDecoIds(std::set<u32> *notify_on_deco_ids);
  86
  87         bool addEvent(GenNotifyType type, v3s16 pos, u32 id=0);
  88         void getEvents(std::map<std::string, std::vector<v3s16> > &event_map,
  89                 bool peek_events=false);
  90
  91 private:
  92         u32 m_notify_on;
  93         std::set<u32> *m_notify_on_deco_ids;
  94         std::list<GenNotifyEvent> m_notify_events;
  95 };
  96
  97 struct MapgenSpecificParams {
  98         virtual void readParams(Settings *settings) = 0;
  99         virtual void writeParams(Settings *settings) = 0;
 100         virtual ~MapgenSpecificParams() {}
 101 };
 102
 103 struct MapgenParams {
 104         std::string mg_name;
 105         s16 chunksize;
 106         u64 seed;
 107         s16 water_level;
 108         u32 flags;
 109
 110         MapgenSpecificParams *sparams;
 111
 112         MapgenParams()
 113         {
 114                 mg_name     = DEFAULT_MAPGEN;
 115                 seed        = 0;
 116                 water_level = 1;
 117                 chunksize   = 5;
 118                 flags       = MG_TREES | MG_CAVES | MG_LIGHT;
 119                 sparams     = NULL;
 120         }
 121 };
 122
 123 class Mapgen {
 124 public:
 125         int seed;
 126         int water_level;
 127         u32 flags;
 128         bool generating;
 129         int id;
 130         ManualMapVoxelManipulator *vm;
 131         INodeDefManager *ndef;
 132
 133         s16 *heightmap;
 134         u8 *biomemap;
 135         v3s16 csize;
 136
 137         GenerateNotifier gennotify;
 138
 139         Mapgen();
 140         Mapgen(int mapgenid, MapgenParams *params, EmergeManager *emerge);
 141         virtual ~Mapgen();
 142
 143         s16 findGroundLevelFull(v2s16 p2d);
 144         s16 findGroundLevel(v2s16 p2d, s16 ymin, s16 ymax);
 145         void updateHeightmap(v3s16 nmin, v3s16 nmax);
 146         void updateLiquid(UniqueQueue<v3s16> *trans_liquid, v3s16 nmin, v3s16 nmax);
 147         void setLighting(v3s16 nmin, v3s16 nmax, u8 light);
 148         void lightSpread(VoxelArea &a, v3s16 p, u8 light);
 149         void calcLighting(v3s16 nmin, v3s16 nmax);
 150         void calcLightingOld(v3s16 nmin, v3s16 nmax);
 151
 152         virtual void makeChunk(BlockMakeData *data) {}
 153         virtual int getGroundLevelAtPoint(v2s16 p) { return 0; }
 154 };
 155
 156 struct MapgenFactory {
 157         virtual Mapgen *createMapgen(int mgid, MapgenParams *params,
 158                 EmergeManager *emerge) = 0;
 159         virtual MapgenSpecificParams *createMapgenParams() = 0;
 160         virtual ~MapgenFactory() {}
 161 };
 162
 163 class GenElement {
 164 public:
 165         virtual ~GenElement() {}
 166         u32 id;
 167         std::string name;
 168 };
 169
 170 class GenElementManager {
 171 public:
 172         static const char *ELEMENT_TITLE;
 173         static const size_t ELEMENT_LIMIT = -1;
 174
 175         GenElementManager() {}
 176         virtual ~GenElementManager();
 177
 178         virtual GenElement *create(int type) = 0;
 179
 180         virtual u32 add(GenElement *elem);
 181         virtual GenElement *get(u32 id);
 182         virtual GenElement *update(u32 id, GenElement *elem);
 183         virtual GenElement *remove(u32 id);
 184         virtual void clear();
 185
 186         virtual GenElement *getByName(const std::string &name);
 187
 188 protected:
 189         std::vector<GenElement *> m_elements;
 190 };
 191
 192 #endif