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 "noise.h"
  24 #include "nodedef.h"
  25 #include "mapnode.h"
  26 #include "util/string.h"
  27 #include "util/container.h"
  28
  29 #define DEFAULT_MAPGEN "v6"
  30
  31 /////////////////// Mapgen flags
  32 #define MG_TREES         0x01
  33 #define MG_CAVES         0x02
  34 #define MG_DUNGEONS      0x04
  35 #define MG_FLAT          0x08
  36 #define MG_LIGHT         0x10
  37
  38 class Settings;
  39 class MMVManip;
  40 class INodeDefManager;
  41
  42 extern FlagDesc flagdesc_mapgen[];
  43 extern FlagDesc flagdesc_gennotify[];
  44
  45 class Biome;
  46 class EmergeManager;
  47 class MapBlock;
  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(const Settings *settings) = 0;
  99         virtual void writeParams(Settings *settings) const = 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         NoiseParams np_biome_heat;
 111         NoiseParams np_biome_humidity;
 112
 113         MapgenSpecificParams *sparams;
 114
 115         MapgenParams() :
 116                 mg_name(DEFAULT_MAPGEN),
 117                 chunksize(5),
 118                 seed(0),
 119                 water_level(1),
 120                 flags(MG_TREES | MG_CAVES | MG_LIGHT),
 121                 np_biome_heat(NoiseParams(50, 50, v3f(500.0, 500.0, 500.0), 5349, 3, 0.5, 2.0)),
 122                 np_biome_humidity(NoiseParams(50, 50, v3f(500.0, 500.0, 500.0), 842, 3, 0.5, 2.0)),
 123                 sparams(NULL)
 124         {}
 125
 126         void load(const Settings &settings);
 127         void save(Settings &settings) const;
 128 };
 129
 130 class Mapgen {
 131 public:
 132         int seed;
 133         int water_level;
 134         u32 flags;
 135         bool generating;
 136         int id;
 137
 138         MMVManip *vm;
 139         INodeDefManager *ndef;
 140
 141         u32 blockseed;
 142         s16 *heightmap;
 143         u8 *biomemap;
 144         v3s16 csize;
 145
 146         GenerateNotifier gennotify;
 147
 148         Mapgen();
 149         Mapgen(int mapgenid, MapgenParams *params, EmergeManager *emerge);
 150         virtual ~Mapgen();
 151
 152         static u32 getBlockSeed(v3s16 p, int seed);
 153         static u32 getBlockSeed2(v3s16 p, int seed);
 154         s16 findGroundLevelFull(v2s16 p2d);
 155         s16 findGroundLevel(v2s16 p2d, s16 ymin, s16 ymax);
 156         void updateHeightmap(v3s16 nmin, v3s16 nmax);
 157         void updateLiquid(UniqueQueue<v3s16> *trans_liquid, v3s16 nmin, v3s16 nmax);
 158
 159         void setLighting(u8 light, v3s16 nmin, v3s16 nmax);
 160         void lightSpread(VoxelArea &a, v3s16 p, u8 light);
 161
 162         void calcLighting(v3s16 nmin, v3s16 nmax);
 163         void calcLighting(v3s16 nmin, v3s16 nmax,
 164                 v3s16 full_nmin, v3s16 full_nmax);
 165
 166         void propagateSunlight(v3s16 nmin, v3s16 nmax);
 167         void spreadLight(v3s16 nmin, v3s16 nmax);
 168
 169         void calcLightingOld(v3s16 nmin, v3s16 nmax);
 170
 171         virtual void makeChunk(BlockMakeData *data) {}
 172         virtual int getGroundLevelAtPoint(v2s16 p) { return 0; }
 173 };
 174
 175 struct MapgenFactory {
 176         virtual Mapgen *createMapgen(int mgid, MapgenParams *params,
 177                 EmergeManager *emerge) = 0;
 178         virtual MapgenSpecificParams *createMapgenParams() = 0;
 179         virtual ~MapgenFactory() {}
 180 };
 181
 182 typedef std::map<std::string, std::string> StringMap;
 183 typedef u32 ObjDefHandle;
 184
 185 #define OBJDEF_INVALID_INDEX ((u32)(-1))
 186 #define OBJDEF_INVALID_HANDLE 0
 187 #define OBJDEF_HANDLE_SALT 0x00585e6fu
 188 #define OBJDEF_MAX_ITEMS (1 << 18)
 189 #define OBJDEF_UID_MASK ((1 << 7) - 1)
 190
 191 enum ObjDefType {
 192         OBJDEF_GENERIC,
 193         OBJDEF_BIOME,
 194         OBJDEF_ORE,
 195         OBJDEF_DECORATION,
 196         OBJDEF_SCHEMATIC,
 197 };
 198
 199 class ObjDef {
 200 public:
 201         virtual ~ObjDef() {}
 202
 203         u32 index;
 204         u32 uid;
 205         ObjDefHandle handle;
 206         std::string name;
 207 };
 208
 209 // WARNING: Ownership of ObjDefs is transferred to the ObjDefManager it is
 210 // added/set to.  Note that ObjDefs managed by ObjDefManager are NOT refcounted,
 211 // so the same ObjDef instance must not be referenced multiple
 212 class ObjDefManager {
 213 public:
 214         ObjDefManager(IGameDef *gamedef, ObjDefType type);
 215         virtual ~ObjDefManager();
 216
 217         virtual const char *getObjectTitle() const { return "ObjDef"; }
 218
 219         virtual void clear();
 220         virtual ObjDef *getByName(const std::string &name) const;
 221
 222         //// Add new/get/set object definitions by handle
 223         virtual ObjDefHandle add(ObjDef *obj);
 224         virtual ObjDef *get(ObjDefHandle handle) const;
 225         virtual ObjDef *set(ObjDefHandle handle, ObjDef *obj);
 226
 227         //// Raw variants that work on indexes
 228         virtual u32 addRaw(ObjDef *obj);
 229
 230         // It is generally assumed that getRaw() will always return a valid object
 231         // This won't be true if people do odd things such as call setRaw() with NULL
 232         virtual ObjDef *getRaw(u32 index) const;
 233         virtual ObjDef *setRaw(u32 index, ObjDef *obj);
 234
 235         size_t getNumObjects() const { return m_objects.size(); }
 236         ObjDefType getType() const { return m_objtype; }
 237         INodeDefManager *getNodeDef() const { return m_ndef; }
 238
 239         u32 validateHandle(ObjDefHandle handle) const;
 240         static ObjDefHandle createHandle(u32 index, ObjDefType type, u32 uid);
 241         static bool decodeHandle(ObjDefHandle handle, u32 *index,
 242                 ObjDefType *type, u32 *uid);
 243
 244 protected:
 245         INodeDefManager *m_ndef;
 246         std::vector<ObjDef *> m_objects;
 247         ObjDefType m_objtype;
 248 };
 249
 250 #endif