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 "irrlichttypes_extrabloated.h"
  24 #include "util/container.h" // UniqueQueue
  25 #include "gamedef.h"
  26 #include "nodedef.h"
  27 #include "mapnode.h"
  28 #include "noise.h"
  29 #include "settings.h"
  30 #include <map>
  31
  32 /////////////////// Mapgen flags
  33 #define MG_TREES         0x01
  34 #define MG_CAVES         0x02
  35 #define MG_DUNGEONS      0x04
  36 #define MGV6_JUNGLES     0x08
  37 #define MGV6_BIOME_BLEND 0x10
  38 #define MG_FLAT          0x20
  39 #define MG_NOLIGHT       0x40
  40 #define MGV7_MOUNTAINS   0x80
  41 #define MGV7_RIDGES      0x100
  42
  43 /////////////////// Ore generation flags
  44 // Use absolute value of height to determine ore placement
  45 #define OREFLAG_ABSHEIGHT 0x01
  46 // Use 3d noise to get density of ore placement, instead of just the position
  47 #define OREFLAG_DENSITY   0x02 // not yet implemented
  48 // For claylike ore types, place ore if the number of surrounding
  49 // nodes isn't the specified node
  50 #define OREFLAG_NODEISNT  0x04 // not yet implemented
  51
  52 /////////////////// Decoration flags
  53 #define DECO_PLACE_CENTER_X 1
  54 #define DECO_PLACE_CENTER_Y 2
  55 #define DECO_PLACE_CENTER_Z 4
  56
  57 extern FlagDesc flagdesc_mapgen[];
  58 extern FlagDesc flagdesc_ore[];
  59 extern FlagDesc flagdesc_deco_schematic[];
  60
  61 class BiomeDefManager;
  62 class Biome;
  63 class EmergeManager;
  64 class MapBlock;
  65 class ManualMapVoxelManipulator;
  66 class VoxelManipulator;
  67 struct BlockMakeData;
  68 class VoxelArea;
  69 class Map;
  70
  71 struct MapgenParams {
  72         std::string mg_name;
  73         int chunksize;
  74         u64 seed;
  75         int water_level;
  76         u32 flags;
  77
  78         MapgenParams() {
  79                 mg_name     = "v6";
  80                 seed        = 0;
  81                 water_level = 1;
  82                 chunksize   = 5;
  83                 flags       = MG_TREES | MG_CAVES | MGV6_BIOME_BLEND;
  84         }
  85
  86         virtual bool readParams(Settings *settings) { return true; }
  87         virtual void writeParams(Settings *settings) {}
  88         virtual ~MapgenParams() {}
  89 };
  90
  91 class Mapgen {
  92 public:
  93         int seed;
  94         int water_level;
  95         bool generating;
  96         int id;
  97         ManualMapVoxelManipulator *vm;
  98         INodeDefManager *ndef;
  99
 100         s16 *heightmap;
 101         u8 *biomemap;
 102         v3s16 csize;
 103
 104         Mapgen();
 105         virtual ~Mapgen() {}
 106
 107         s16 findGroundLevelFull(v2s16 p2d);
 108         s16 findGroundLevel(v2s16 p2d, s16 ymin, s16 ymax);
 109         void updateHeightmap(v3s16 nmin, v3s16 nmax);
 110         void updateLiquid(UniqueQueue<v3s16> *trans_liquid, v3s16 nmin, v3s16 nmax);
 111         void setLighting(v3s16 nmin, v3s16 nmax, u8 light);
 112         void lightSpread(VoxelArea &a, v3s16 p, u8 light);
 113         void calcLighting(v3s16 nmin, v3s16 nmax);
 114         void calcLightingOld(v3s16 nmin, v3s16 nmax);
 115
 116         virtual void makeChunk(BlockMakeData *data) {}
 117         virtual int getGroundLevelAtPoint(v2s16 p) { return 0; }
 118
 119         //Legacy functions for Farmesh (pending removal)
 120         static bool get_have_beach(u64 seed, v2s16 p2d);
 121         static double tree_amount_2d(u64 seed, v2s16 p);
 122         static s16 find_ground_level_from_noise(u64 seed, v2s16 p2d, s16 precision);
 123 };
 124
 125 struct MapgenFactory {
 126         virtual Mapgen *createMapgen(int mgid, MapgenParams *params,
 127                                                                  EmergeManager *emerge) = 0;
 128         virtual MapgenParams *createMapgenParams() = 0;
 129         virtual ~MapgenFactory() {}
 130 };
 131
 132 enum MapgenObject {
 133         MGOBJ_VMANIP,
 134         MGOBJ_HEIGHTMAP,
 135         MGOBJ_BIOMEMAP,
 136         MGOBJ_HEATMAP,
 137         MGOBJ_HUMIDMAP
 138 };
 139
 140 enum OreType {
 141         ORE_SCATTER,
 142         ORE_SHEET,
 143         ORE_CLAYLIKE
 144 };
 145
 146 #define ORE_RANGE_ACTUAL 1
 147 #define ORE_RANGE_MIRROR 2
 148
 149 class Ore {
 150 public:
 151         std::string ore_name;
 152         std::vector<std::string> wherein_names;
 153         content_t ore;
 154         std::vector<content_t> wherein;  // the node to be replaced
 155         u32 clust_scarcity; // ore cluster has a 1-in-clust_scarcity chance of appearing at a node
 156         s16 clust_num_ores; // how many ore nodes are in a chunk
 157         s16 clust_size;     // how large (in nodes) a chunk of ore is
 158         s16 height_min;
 159         s16 height_max;
 160         u8 ore_param2;          // to set node-specific attributes
 161         u32 flags;          // attributes for this ore
 162         float nthresh;      // threshhold for noise at which an ore is placed
 163         NoiseParams *np;    // noise for distribution of clusters (NULL for uniform scattering)
 164         Noise *noise;
 165
 166         Ore() {
 167                 ore     = CONTENT_IGNORE;
 168                 np      = NULL;
 169                 noise   = NULL;
 170         }
 171
 172         virtual ~Ore();
 173
 174         void resolveNodeNames(INodeDefManager *ndef);
 175         void placeOre(Mapgen *mg, u32 blockseed, v3s16 nmin, v3s16 nmax);
 176         virtual void generate(ManualMapVoxelManipulator *vm, int seed,
 177                                                 u32 blockseed, v3s16 nmin, v3s16 nmax) = 0;
 178 };
 179
 180 class OreScatter : public Ore {
 181         ~OreScatter() {}
 182         virtual void generate(ManualMapVoxelManipulator *vm, int seed,
 183                                                 u32 blockseed, v3s16 nmin, v3s16 nmax);
 184 };
 185
 186 class OreSheet : public Ore {
 187         ~OreSheet() {}
 188         virtual void generate(ManualMapVoxelManipulator *vm, int seed,
 189                                                 u32 blockseed, v3s16 nmin, v3s16 nmax);
 190 };
 191
 192 Ore *createOre(OreType type);
 193
 194
 195 enum DecorationType {
 196         DECO_SIMPLE,
 197         DECO_SCHEMATIC,
 198         DECO_LSYSTEM
 199 };
 200
 201 #if 0
 202 struct CutoffData {
 203         VoxelArea a;
 204         Decoration *deco;
 205         //v3s16 p;
 206         //v3s16 size;
 207         //s16 height;
 208
 209         CutoffData(s16 x, s16 y, s16 z, s16 h) {
 210                 p = v3s16(x, y, z);
 211                 height = h;
 212         }
 213 };
 214 #endif
 215
 216 class Decoration {
 217 public:
 218         INodeDefManager *ndef;
 219
 220         int mapseed;
 221         std::string place_on_name;
 222         content_t c_place_on;
 223         s16 sidelen;
 224         float fill_ratio;
 225         NoiseParams *np;
 226
 227         std::set<u8> biomes;
 228         //std::list<CutoffData> cutoffs;
 229         //JMutex cutoff_mutex;
 230
 231         Decoration();
 232         virtual ~Decoration();
 233
 234         virtual void resolveNodeNames(INodeDefManager *ndef);
 235         void placeDeco(Mapgen *mg, u32 blockseed, v3s16 nmin, v3s16 nmax);
 236         void placeCutoffs(Mapgen *mg, u32 blockseed, v3s16 nmin, v3s16 nmax);
 237
 238         virtual void generate(Mapgen *mg, PseudoRandom *pr, s16 max_y, v3s16 p) = 0;
 239         virtual int getHeight() = 0;
 240         virtual std::string getName() = 0;
 241 };
 242
 243 class DecoSimple : public Decoration {
 244 public:
 245         std::string deco_name;
 246         std::string spawnby_name;
 247         content_t c_deco;
 248         content_t c_spawnby;
 249         s16 deco_height;
 250         s16 deco_height_max;
 251         s16 nspawnby;
 252
 253         std::vector<std::string> decolist_names;
 254         std::vector<content_t> c_decolist;
 255
 256         ~DecoSimple() {}
 257
 258         void resolveNodeNames(INodeDefManager *ndef);
 259         virtual void generate(Mapgen *mg, PseudoRandom *pr, s16 max_y, v3s16 p);
 260         virtual int getHeight();
 261         virtual std::string getName();
 262 };
 263
 264 #define MTSCHEM_FILE_SIGNATURE 0x4d54534d // 'MTSM'
 265
 266 class DecoSchematic : public Decoration {
 267 public:
 268         std::string filename;
 269
 270         std::vector<std::string> *node_names;
 271         std::vector<content_t> c_nodes;
 272         std::map<std::string, std::string> replacements;
 273
 274         u32 flags;
 275         Rotation rotation;
 276         v3s16 size;
 277         MapNode *schematic;
 278
 279         DecoSchematic();
 280         ~DecoSchematic();
 281
 282         void resolveNodeNames(INodeDefManager *ndef);
 283         virtual void generate(Mapgen *mg, PseudoRandom *pr, s16 max_y, v3s16 p);
 284         virtual int getHeight();
 285         virtual std::string getName();
 286
 287         void blitToVManip(v3s16 p, ManualMapVoxelManipulator *vm,
 288                                         Rotation rot, bool force_placement);
 289
 290         bool loadSchematicFile();
 291         void saveSchematicFile(INodeDefManager *ndef);
 292
 293         bool getSchematicFromMap(Map *map, v3s16 p1, v3s16 p2);
 294         void placeStructure(Map *map, v3s16 p);
 295         void applyProbabilities(std::vector<std::pair<v3s16, s16> > *plist, v3s16 p0);
 296 };
 297
 298 void build_nnlist_and_update_ids(MapNode *nodes, u32 nodecount,
 299                                         std::vector<content_t> *usednodes);
 300
 301 /*
 302 class DecoLSystem : public Decoration {
 303 public:
 304         virtual void generate(Mapgen *mg, u32 blockseed, v3s16 nmin, v3s16 nmax);
 305 };
 306 */
 307
 308 Decoration *createDecoration(DecorationType type);
 309
 310 #endif
 311