src/mapgen/mapgen.cpp

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2018 celeron55, Perttu Ahola <celeron55@gmail.com>
   4 Copyright (C) 2013-2018 kwolekr, Ryan Kwolek <kwolekr@minetest.net>
   5 Copyright (C) 2015-2018 paramat
   6
   7 This program is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU Lesser General Public License as published by
   9 the Free Software Foundation; either version 2.1 of the License, or
  10 (at your option) any later version.
  11
  12 This program is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU Lesser General Public License for more details.
  16
  17 You should have received a copy of the GNU Lesser General Public License along
  18 with this program; if not, write to the Free Software Foundation, Inc.,
  19 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20 */
  21
  22 #include <cmath>
  23 #include "mapgen.h"
  24 #include "voxel.h"
  25 #include "noise.h"
  26 #include "gamedef.h"
  27 #include "mg_biome.h"
  28 #include "mapblock.h"
  29 #include "mapnode.h"
  30 #include "map.h"
  31 #include "nodedef.h"
  32 #include "emerge.h"
  33 #include "voxelalgorithms.h"
  34 #include "porting.h"
  35 #include "profiler.h"
  36 #include "settings.h"
  37 #include "treegen.h"
  38 #include "serialization.h"
  39 #include "util/serialize.h"
  40 #include "util/numeric.h"
  41 #include "util/directiontables.h"
  42 #include "filesys.h"
  43 #include "log.h"
  44 #include "mapgen_carpathian.h"
  45 #include "mapgen_flat.h"
  46 #include "mapgen_fractal.h"
  47 #include "mapgen_v5.h"
  48 #include "mapgen_v6.h"
  49 #include "mapgen_v7.h"
  50 #include "mapgen_valleys.h"
  51 #include "mapgen_singlenode.h"
  52 #include "cavegen.h"
  53 #include "dungeongen.h"
  54
  55 FlagDesc flagdesc_mapgen[] = {
  56         {"caves",       MG_CAVES},
  57         {"dungeons",    MG_DUNGEONS},
  58         {"light",       MG_LIGHT},
  59         {"decorations", MG_DECORATIONS},
  60         {"biomes",      MG_BIOMES},
  61         {"ores",        MG_ORES},
  62         {NULL,          0}
  63 };
  64
  65 FlagDesc flagdesc_gennotify[] = {
  66         {"dungeon",          1 << GENNOTIFY_DUNGEON},
  67         {"temple",           1 << GENNOTIFY_TEMPLE},
  68         {"cave_begin",       1 << GENNOTIFY_CAVE_BEGIN},
  69         {"cave_end",         1 << GENNOTIFY_CAVE_END},
  70         {"large_cave_begin", 1 << GENNOTIFY_LARGECAVE_BEGIN},
  71         {"large_cave_end",   1 << GENNOTIFY_LARGECAVE_END},
  72         {"decoration",       1 << GENNOTIFY_DECORATION},
  73         {NULL,               0}
  74 };
  75
  76 struct MapgenDesc {
  77         const char *name;
  78         bool is_user_visible;
  79 };
  80
  81 ////
  82 //// Built-in mapgens
  83 ////
  84
  85 // Order used here defines the order of appearence in mainmenu.
  86 // v6 always last to discourage selection.
  87 // Special mapgens flat, fractal, singlenode, next to last. Of these, singlenode
  88 // last to discourage selection.
  89 // Of the remaining, v5 last due to age, v7 first due to being the default.
  90 // The order of 'enum MapgenType' in mapgen.h must match this order.
  91 static MapgenDesc g_reg_mapgens[] = {
  92         {"v7",         true},
  93         {"valleys",    true},
  94         {"carpathian", true},
  95         {"v5",         true},
  96         {"flat",       true},
  97         {"fractal",    true},
  98         {"singlenode", true},
  99         {"v6",         true},
 100 };
 101
 102 STATIC_ASSERT(
 103         ARRLEN(g_reg_mapgens) == MAPGEN_INVALID,
 104         registered_mapgens_is_wrong_size);
 105
 106 ////
 107 //// Mapgen
 108 ////
 109
 110 Mapgen::Mapgen(int mapgenid, MapgenParams *params, EmergeParams *emerge) :
 111         gennotify(emerge->gen_notify_on, emerge->gen_notify_on_deco_ids)
 112 {
 113         id           = mapgenid;
 114         water_level  = params->water_level;
 115         mapgen_limit = params->mapgen_limit;
 116         flags        = params->flags;
 117         csize        = v3s16(1, 1, 1) * (params->chunksize * MAP_BLOCKSIZE);
 118
 119         /*
 120                 We are losing half our entropy by doing this, but it is necessary to
 121                 preserve reverse compatibility.  If the top half of our current 64 bit
 122                 seeds ever starts getting used, existing worlds will break due to a
 123                 different hash outcome and no way to differentiate between versions.
 124
 125                 A solution could be to add a new bit to designate that the top half of
 126                 the seed value should be used, essentially a 1-bit version code, but
 127                 this would require increasing the total size of a seed to 9 bytes (yuck)
 128
 129                 It's probably okay if this never gets fixed.  4.2 billion possibilities
 130                 ought to be enough for anyone.
 131         */
 132         seed = (s32)params->seed;
 133
 134         ndef      = emerge->ndef;
 135 }
 136
 137
 138 MapgenType Mapgen::getMapgenType(const std::string &mgname)
 139 {
 140         for (size_t i = 0; i != ARRLEN(g_reg_mapgens); i++) {
 141                 if (mgname == g_reg_mapgens[i].name)
 142                         return (MapgenType)i;
 143         }
 144
 145         return MAPGEN_INVALID;
 146 }
 147
 148
 149 const char *Mapgen::getMapgenName(MapgenType mgtype)
 150 {
 151         size_t index = (size_t)mgtype;
 152         if (index == MAPGEN_INVALID || index >= ARRLEN(g_reg_mapgens))
 153                 return "invalid";
 154
 155         return g_reg_mapgens[index].name;
 156 }
 157
 158
 159 Mapgen *Mapgen::createMapgen(MapgenType mgtype, MapgenParams *params,
 160         EmergeParams *emerge)
 161 {
 162         switch (mgtype) {
 163         case MAPGEN_CARPATHIAN:
 164                 return new MapgenCarpathian((MapgenCarpathianParams *)params, emerge);
 165         case MAPGEN_FLAT:
 166                 return new MapgenFlat((MapgenFlatParams *)params, emerge);
 167         case MAPGEN_FRACTAL:
 168                 return new MapgenFractal((MapgenFractalParams *)params, emerge);
 169         case MAPGEN_SINGLENODE:
 170                 return new MapgenSinglenode((MapgenSinglenodeParams *)params, emerge);
 171         case MAPGEN_V5:
 172                 return new MapgenV5((MapgenV5Params *)params, emerge);
 173         case MAPGEN_V6:
 174                 return new MapgenV6((MapgenV6Params *)params, emerge);
 175         case MAPGEN_V7:
 176                 return new MapgenV7((MapgenV7Params *)params, emerge);
 177         case MAPGEN_VALLEYS:
 178                 return new MapgenValleys((MapgenValleysParams *)params, emerge);
 179         default:
 180                 return nullptr;
 181         }
 182 }
 183
 184
 185 MapgenParams *Mapgen::createMapgenParams(MapgenType mgtype)
 186 {
 187         switch (mgtype) {
 188         case MAPGEN_CARPATHIAN:
 189                 return new MapgenCarpathianParams;
 190         case MAPGEN_FLAT:
 191                 return new MapgenFlatParams;
 192         case MAPGEN_FRACTAL:
 193                 return new MapgenFractalParams;
 194         case MAPGEN_SINGLENODE:
 195                 return new MapgenSinglenodeParams;
 196         case MAPGEN_V5:
 197                 return new MapgenV5Params;
 198         case MAPGEN_V6:
 199                 return new MapgenV6Params;
 200         case MAPGEN_V7:
 201                 return new MapgenV7Params;
 202         case MAPGEN_VALLEYS:
 203                 return new MapgenValleysParams;
 204         default:
 205                 return nullptr;
 206         }
 207 }
 208
 209
 210 void Mapgen::getMapgenNames(std::vector<const char *> *mgnames, bool include_hidden)
 211 {
 212         for (u32 i = 0; i != ARRLEN(g_reg_mapgens); i++) {
 213                 if (include_hidden || g_reg_mapgens[i].is_user_visible)
 214                         mgnames->push_back(g_reg_mapgens[i].name);
 215         }
 216 }
 217
 218 void Mapgen::setDefaultSettings(Settings *settings)
 219 {
 220         settings->setDefault("mg_flags", flagdesc_mapgen,
 221                  MG_CAVES | MG_DUNGEONS | MG_LIGHT | MG_DECORATIONS | MG_BIOMES | MG_ORES);
 222
 223         for (int i = 0; i < (int)MAPGEN_INVALID; ++i) {
 224                 MapgenParams *params = createMapgenParams((MapgenType)i);
 225                 params->setDefaultSettings(settings);
 226                 delete params;
 227         }
 228 }
 229
 230 u32 Mapgen::getBlockSeed(v3s16 p, s32 seed)
 231 {
 232         return (u32)seed   +
 233                 p.Z * 38134234 +
 234                 p.Y * 42123    +
 235                 p.X * 23;
 236 }
 237
 238
 239 u32 Mapgen::getBlockSeed2(v3s16 p, s32 seed)
 240 {
 241         u32 n = 1619 * p.X + 31337 * p.Y + 52591 * p.Z + 1013 * seed;
 242         n = (n >> 13) ^ n;
 243         return (n * (n * n * 60493 + 19990303) + 1376312589);
 244 }
 245
 246
 247 // Returns -MAX_MAP_GENERATION_LIMIT if not found
 248 s16 Mapgen::findGroundLevel(v2s16 p2d, s16 ymin, s16 ymax)
 249 {
 250         const v3s16 &em = vm->m_area.getExtent();
 251         u32 i = vm->m_area.index(p2d.X, ymax, p2d.Y);
 252         s16 y;
 253
 254         for (y = ymax; y >= ymin; y--) {
 255                 MapNode &n = vm->m_data[i];
 256                 if (ndef->get(n).walkable)
 257                         break;
 258
 259                 VoxelArea::add_y(em, i, -1);
 260         }
 261         return (y >= ymin) ? y : -MAX_MAP_GENERATION_LIMIT;
 262 }
 263
 264
 265 // Returns -MAX_MAP_GENERATION_LIMIT if not found or if ground is found first
 266 s16 Mapgen::findLiquidSurface(v2s16 p2d, s16 ymin, s16 ymax)
 267 {
 268         const v3s16 &em = vm->m_area.getExtent();
 269         u32 i = vm->m_area.index(p2d.X, ymax, p2d.Y);
 270         s16 y;
 271
 272         for (y = ymax; y >= ymin; y--) {
 273                 MapNode &n = vm->m_data[i];
 274                 if (ndef->get(n).walkable)
 275                         return -MAX_MAP_GENERATION_LIMIT;
 276
 277                 if (ndef->get(n).isLiquid())
 278                         break;
 279
 280                 VoxelArea::add_y(em, i, -1);
 281         }
 282         return (y >= ymin) ? y : -MAX_MAP_GENERATION_LIMIT;
 283 }
 284
 285
 286 void Mapgen::updateHeightmap(v3s16 nmin, v3s16 nmax)
 287 {
 288         if (!heightmap)
 289                 return;
 290
 291         //TimeTaker t("Mapgen::updateHeightmap", NULL, PRECISION_MICRO);
 292         int index = 0;
 293         for (s16 z = nmin.Z; z <= nmax.Z; z++) {
 294                 for (s16 x = nmin.X; x <= nmax.X; x++, index++) {
 295                         s16 y = findGroundLevel(v2s16(x, z), nmin.Y, nmax.Y);
 296
 297                         heightmap[index] = y;
 298                 }
 299         }
 300 }
 301
 302
 303 void Mapgen::getSurfaces(v2s16 p2d, s16 ymin, s16 ymax,
 304         std::vector<s16> &floors, std::vector<s16> &ceilings)
 305 {
 306         const v3s16 &em = vm->m_area.getExtent();
 307
 308         bool is_walkable = false;
 309         u32 vi = vm->m_area.index(p2d.X, ymax, p2d.Y);
 310         MapNode mn_max = vm->m_data[vi];
 311         bool walkable_above = ndef->get(mn_max).walkable;
 312         VoxelArea::add_y(em, vi, -1);
 313
 314         for (s16 y = ymax - 1; y >= ymin; y--) {
 315                 MapNode mn = vm->m_data[vi];
 316                 is_walkable = ndef->get(mn).walkable;
 317
 318                 if (is_walkable && !walkable_above) {
 319                         floors.push_back(y);
 320                 } else if (!is_walkable && walkable_above) {
 321                         ceilings.push_back(y + 1);
 322                 }
 323
 324                 VoxelArea::add_y(em, vi, -1);
 325                 walkable_above = is_walkable;
 326         }
 327 }
 328
 329
 330 inline bool Mapgen::isLiquidHorizontallyFlowable(u32 vi, v3s16 em)
 331 {
 332         u32 vi_neg_x = vi;
 333         VoxelArea::add_x(em, vi_neg_x, -1);
 334         if (vm->m_data[vi_neg_x].getContent() != CONTENT_IGNORE) {
 335                 const ContentFeatures &c_nx = ndef->get(vm->m_data[vi_neg_x]);
 336                 if (c_nx.floodable && !c_nx.isLiquid())
 337                         return true;
 338         }
 339         u32 vi_pos_x = vi;
 340         VoxelArea::add_x(em, vi_pos_x, +1);
 341         if (vm->m_data[vi_pos_x].getContent() != CONTENT_IGNORE) {
 342                 const ContentFeatures &c_px = ndef->get(vm->m_data[vi_pos_x]);
 343                 if (c_px.floodable && !c_px.isLiquid())
 344                         return true;
 345         }
 346         u32 vi_neg_z = vi;
 347         VoxelArea::add_z(em, vi_neg_z, -1);
 348         if (vm->m_data[vi_neg_z].getContent() != CONTENT_IGNORE) {
 349                 const ContentFeatures &c_nz = ndef->get(vm->m_data[vi_neg_z]);
 350                 if (c_nz.floodable && !c_nz.isLiquid())
 351                         return true;
 352         }
 353         u32 vi_pos_z = vi;
 354         VoxelArea::add_z(em, vi_pos_z, +1);
 355         if (vm->m_data[vi_pos_z].getContent() != CONTENT_IGNORE) {
 356                 const ContentFeatures &c_pz = ndef->get(vm->m_data[vi_pos_z]);
 357                 if (c_pz.floodable && !c_pz.isLiquid())
 358                         return true;
 359         }
 360         return false;
 361 }
 362
 363 void Mapgen::updateLiquid(UniqueQueue<v3s16> *trans_liquid, v3s16 nmin, v3s16 nmax)
 364 {
 365         bool isignored, isliquid, wasignored, wasliquid, waschecked, waspushed;
 366         const v3s16 &em  = vm->m_area.getExtent();
 367
 368         for (s16 z = nmin.Z + 1; z <= nmax.Z - 1; z++)
 369         for (s16 x = nmin.X + 1; x <= nmax.X - 1; x++) {
 370                 wasignored = true;
 371                 wasliquid = false;
 372                 waschecked = false;
 373                 waspushed = false;
 374
 375                 u32 vi = vm->m_area.index(x, nmax.Y, z);
 376                 for (s16 y = nmax.Y; y >= nmin.Y; y--) {
 377                         isignored = vm->m_data[vi].getContent() == CONTENT_IGNORE;
 378                         isliquid = ndef->get(vm->m_data[vi]).isLiquid();
 379
 380                         if (isignored || wasignored || isliquid == wasliquid) {
 381                                 // Neither topmost node of liquid column nor topmost node below column
 382                                 waschecked = false;
 383                                 waspushed = false;
 384                         } else if (isliquid) {
 385                                 // This is the topmost node in the column
 386                                 bool ispushed = false;
 387                                 if (isLiquidHorizontallyFlowable(vi, em)) {
 388                                         trans_liquid->push_back(v3s16(x, y, z));
 389                                         ispushed = true;
 390                                 }
 391                                 // Remember waschecked and waspushed to avoid repeated
 392                                 // checks/pushes in case the column consists of only this node
 393                                 waschecked = true;
 394                                 waspushed = ispushed;
 395                         } else {
 396                                 // This is the topmost node below a liquid column
 397                                 u32 vi_above = vi;
 398                                 VoxelArea::add_y(em, vi_above, 1);
 399                                 if (!waspushed && (ndef->get(vm->m_data[vi]).floodable ||
 400                                                 (!waschecked && isLiquidHorizontallyFlowable(vi_above, em)))) {
 401                                         // Push back the lowest node in the column which is one
 402                                         // node above this one
 403                                         trans_liquid->push_back(v3s16(x, y + 1, z));
 404                                 }
 405                         }
 406
 407                         wasliquid = isliquid;
 408                         wasignored = isignored;
 409                         VoxelArea::add_y(em, vi, -1);
 410                 }
 411         }
 412 }
 413
 414
 415 void Mapgen::setLighting(u8 light, v3s16 nmin, v3s16 nmax)
 416 {
 417         ScopeProfiler sp(g_profiler, "EmergeThread: update lighting", SPT_AVG);
 418         VoxelArea a(nmin, nmax);
 419
 420         for (int z = a.MinEdge.Z; z <= a.MaxEdge.Z; z++) {
 421                 for (int y = a.MinEdge.Y; y <= a.MaxEdge.Y; y++) {
 422                         u32 i = vm->m_area.index(a.MinEdge.X, y, z);
 423                         for (int x = a.MinEdge.X; x <= a.MaxEdge.X; x++, i++)
 424                                 vm->m_data[i].param1 = light;
 425                 }
 426         }
 427 }
 428
 429
 430 void Mapgen::lightSpread(VoxelArea &a, std::queue<std::pair<v3s16, u8>> &queue,
 431         const v3s16 &p, u8 light)
 432 {
 433         if (light <= 1 || !a.contains(p))
 434                 return;
 435
 436         u32 vi = vm->m_area.index(p);
 437         MapNode &n = vm->m_data[vi];
 438
 439         // Decay light in each of the banks separately
 440         u8 light_day = light & 0x0F;
 441         if (light_day > 0)
 442                 light_day -= 0x01;
 443
 444         u8 light_night = light & 0xF0;
 445         if (light_night > 0)
 446                 light_night -= 0x10;
 447
 448         // Bail out only if we have no more light from either bank to propogate, or
 449         // we hit a solid block that light cannot pass through.
 450         if ((light_day  <= (n.param1 & 0x0F) &&
 451                         light_night <= (n.param1 & 0xF0)) ||
 452                         !ndef->get(n).light_propagates)
 453                 return;
 454
 455         // Since this recursive function only terminates when there is no light from
 456         // either bank left, we need to take the max of both banks into account for
 457         // the case where spreading has stopped for one light bank but not the other.
 458         light = MYMAX(light_day, n.param1 & 0x0F) |
 459                         MYMAX(light_night, n.param1 & 0xF0);
 460
 461         n.param1 = light;
 462
 463         // add to queue
 464         queue.emplace(p, light);
 465 }
 466
 467
 468 void Mapgen::calcLighting(v3s16 nmin, v3s16 nmax, v3s16 full_nmin, v3s16 full_nmax,
 469         bool propagate_shadow)
 470 {
 471         ScopeProfiler sp(g_profiler, "EmergeThread: update lighting", SPT_AVG);
 472         //TimeTaker t("updateLighting");
 473
 474         propagateSunlight(nmin, nmax, propagate_shadow);
 475         spreadLight(full_nmin, full_nmax);
 476
 477         //printf("updateLighting: %dms\n", t.stop());
 478 }
 479
 480
 481 void Mapgen::propagateSunlight(v3s16 nmin, v3s16 nmax, bool propagate_shadow)
 482 {
 483         //TimeTaker t("propagateSunlight");
 484         VoxelArea a(nmin, nmax);
 485         bool block_is_underground = (water_level >= nmax.Y);
 486         const v3s16 &em = vm->m_area.getExtent();
 487
 488         // NOTE: Direct access to the low 4 bits of param1 is okay here because,
 489         // by definition, sunlight will never be in the night lightbank.
 490
 491         for (int z = a.MinEdge.Z; z <= a.MaxEdge.Z; z++) {
 492                 for (int x = a.MinEdge.X; x <= a.MaxEdge.X; x++) {
 493                         // see if we can get a light value from the overtop
 494                         u32 i = vm->m_area.index(x, a.MaxEdge.Y + 1, z);
 495                         if (vm->m_data[i].getContent() == CONTENT_IGNORE) {
 496                                 if (block_is_underground)
 497                                         continue;
 498                         } else if ((vm->m_data[i].param1 & 0x0F) != LIGHT_SUN &&
 499                                         propagate_shadow) {
 500                                 continue;
 501                         }
 502                         VoxelArea::add_y(em, i, -1);
 503
 504                         for (int y = a.MaxEdge.Y; y >= a.MinEdge.Y; y--) {
 505                                 MapNode &n = vm->m_data[i];
 506                                 if (!ndef->get(n).sunlight_propagates)
 507                                         break;
 508                                 n.param1 = LIGHT_SUN;
 509                                 VoxelArea::add_y(em, i, -1);
 510                         }
 511                 }
 512         }
 513         //printf("propagateSunlight: %dms\n", t.stop());
 514 }
 515
 516
 517 void Mapgen::spreadLight(const v3s16 &nmin, const v3s16 &nmax)
 518 {
 519         //TimeTaker t("spreadLight");
 520         std::queue<std::pair<v3s16, u8>> queue;
 521         VoxelArea a(nmin, nmax);
 522
 523         for (int z = a.MinEdge.Z; z <= a.MaxEdge.Z; z++) {
 524                 for (int y = a.MinEdge.Y; y <= a.MaxEdge.Y; y++) {
 525                         u32 i = vm->m_area.index(a.MinEdge.X, y, z);
 526                         for (int x = a.MinEdge.X; x <= a.MaxEdge.X; x++, i++) {
 527                                 MapNode &n = vm->m_data[i];
 528                                 if (n.getContent() == CONTENT_IGNORE)
 529                                         continue;
 530
 531                                 const ContentFeatures &cf = ndef->get(n);
 532                                 if (!cf.light_propagates)
 533                                         continue;
 534
 535                                 // TODO(hmmmmm): Abstract away direct param1 accesses with a
 536                                 // wrapper, but something lighter than MapNode::get/setLight
 537
 538                                 u8 light_produced = cf.light_source;
 539                                 if (light_produced)
 540                                         n.param1 = light_produced | (light_produced << 4);
 541
 542                                 u8 light = n.param1;
 543                                 if (light) {
 544                                         const v3s16 p(x, y, z);
 545                                         // spread to all 6 neighbor nodes
 546                                         for (const auto &dir : g_6dirs)
 547                                                 lightSpread(a, queue, p + dir, light);
 548                                 }
 549                         }
 550                 }
 551         }
 552
 553         while (!queue.empty()) {
 554                 const auto &i = queue.front();
 555                 // spread to all 6 neighbor nodes
 556                 for (const auto &dir : g_6dirs)
 557                         lightSpread(a, queue, i.first + dir, i.second);
 558                 queue.pop();
 559         }
 560
 561         //printf("spreadLight: %lums\n", t.stop());
 562 }
 563
 564
 565 ////
 566 //// MapgenBasic
 567 ////
 568
 569 MapgenBasic::MapgenBasic(int mapgenid, MapgenParams *params, EmergeParams *emerge)
 570         : Mapgen(mapgenid, params, emerge)
 571 {
 572         this->m_emerge = emerge;
 573         this->m_bmgr   = emerge->biomemgr;
 574
 575         //// Here, 'stride' refers to the number of elements needed to skip to index
 576         //// an adjacent element for that coordinate in noise/height/biome maps
 577         //// (*not* vmanip content map!)
 578
 579         // Note there is no X stride explicitly defined.  Items adjacent in the X
 580         // coordinate are assumed to be adjacent in memory as well (i.e. stride of 1).
 581
 582         // Number of elements to skip to get to the next Y coordinate
 583         this->ystride = csize.X;
 584
 585         // Number of elements to skip to get to the next Z coordinate
 586         this->zstride = csize.X * csize.Y;
 587
 588         // Z-stride value for maps oversized for 1-down overgeneration
 589         this->zstride_1d = csize.X * (csize.Y + 1);
 590
 591         // Z-stride value for maps oversized for 1-up 1-down overgeneration
 592         this->zstride_1u1d = csize.X * (csize.Y + 2);
 593
 594         //// Allocate heightmap
 595         this->heightmap = new s16[csize.X * csize.Z];
 596
 597         //// Initialize biome generator
 598         biomegen = emerge->biomegen;
 599         biomegen->assertChunkSize(csize);
 600         biomemap = biomegen->biomemap;
 601
 602         //// Look up some commonly used content
 603         c_stone              = ndef->getId("mapgen_stone");
 604         c_water_source       = ndef->getId("mapgen_water_source");
 605         c_river_water_source = ndef->getId("mapgen_river_water_source");
 606         c_lava_source        = ndef->getId("mapgen_lava_source");
 607         c_cobble             = ndef->getId("mapgen_cobble");
 608
 609         // Fall back to more basic content if not defined.
 610         // Lava falls back to water as both are suitable as cave liquids.
 611         if (c_lava_source == CONTENT_IGNORE)
 612                 c_lava_source = c_water_source;
 613
 614         if (c_stone == CONTENT_IGNORE)
 615                 errorstream << "Mapgen: Mapgen alias 'mapgen_stone' is invalid!" << std::endl;
 616         if (c_water_source == CONTENT_IGNORE)
 617                 errorstream << "Mapgen: Mapgen alias 'mapgen_water_source' is invalid!" << std::endl;
 618         if (c_river_water_source == CONTENT_IGNORE)
 619                 warningstream << "Mapgen: Mapgen alias 'mapgen_river_water_source' is invalid!" << std::endl;
 620 }
 621
 622
 623 MapgenBasic::~MapgenBasic()
 624 {
 625         delete []heightmap;
 626
 627         delete m_emerge; // destroying EmergeParams is our responsibility
 628 }
 629
 630
 631 void MapgenBasic::generateBiomes()
 632 {
 633         // can't generate biomes without a biome generator!
 634         assert(biomegen);
 635         assert(biomemap);
 636
 637         const v3s16 &em = vm->m_area.getExtent();
 638         u32 index = 0;
 639
 640         noise_filler_depth->perlinMap2D(node_min.X, node_min.Z);
 641
 642         for (s16 z = node_min.Z; z <= node_max.Z; z++)
 643         for (s16 x = node_min.X; x <= node_max.X; x++, index++) {
 644                 Biome *biome = NULL;
 645                 biome_t water_biome_index = 0;
 646                 u16 depth_top = 0;
 647                 u16 base_filler = 0;
 648                 u16 depth_water_top = 0;
 649                 u16 depth_riverbed = 0;
 650                 s16 biome_y_min = -MAX_MAP_GENERATION_LIMIT;
 651                 u32 vi = vm->m_area.index(x, node_max.Y, z);
 652
 653                 // Check node at base of mapchunk above, either a node of a previously
 654                 // generated mapchunk or if not, a node of overgenerated base terrain.
 655                 content_t c_above = vm->m_data[vi + em.X].getContent();
 656                 bool air_above = c_above == CONTENT_AIR;
 657                 bool river_water_above = c_above == c_river_water_source;
 658                 bool water_above = c_above == c_water_source || river_water_above;
 659
 660                 biomemap[index] = BIOME_NONE;
 661
 662                 // If there is air or water above enable top/filler placement, otherwise force
 663                 // nplaced to stone level by setting a number exceeding any possible filler depth.
 664                 u16 nplaced = (air_above || water_above) ? 0 : U16_MAX;
 665
 666                 for (s16 y = node_max.Y; y >= node_min.Y; y--) {
 667                         content_t c = vm->m_data[vi].getContent();
 668                         // Biome is (re)calculated:
 669                         // 1. At the surface of stone below air or water.
 670                         // 2. At the surface of water below air.
 671                         // 3. When stone or water is detected but biome has not yet been calculated.
 672                         // 4. When stone or water is detected just below a biome's lower limit.
 673                         bool is_stone_surface = (c == c_stone) &&
 674                                 (air_above || water_above || !biome || y < biome_y_min); // 1, 3, 4
 675
 676                         bool is_water_surface =
 677                                 (c == c_water_source || c == c_river_water_source) &&
 678                                 (air_above || !biome || y < biome_y_min); // 2, 3, 4
 679
 680                         if (is_stone_surface || is_water_surface) {
 681                                 // (Re)calculate biome
 682                                 biome = biomegen->getBiomeAtIndex(index, v3s16(x, y, z));
 683
 684                                 // Add biome to biomemap at first stone surface detected
 685                                 if (biomemap[index] == BIOME_NONE && is_stone_surface)
 686                                         biomemap[index] = biome->index;
 687
 688                                 // Store biome of first water surface detected, as a fallback
 689                                 // entry for the biomemap.
 690                                 if (water_biome_index == 0 && is_water_surface)
 691                                         water_biome_index = biome->index;
 692
 693                                 depth_top = biome->depth_top;
 694                                 base_filler = MYMAX(depth_top +
 695                                         biome->depth_filler +
 696                                         noise_filler_depth->result[index], 0.0f);
 697                                 depth_water_top = biome->depth_water_top;
 698                                 depth_riverbed = biome->depth_riverbed;
 699                                 biome_y_min = biome->min_pos.Y;
 700                         }
 701
 702                         if (c == c_stone) {
 703                                 content_t c_below = vm->m_data[vi - em.X].getContent();
 704
 705                                 // If the node below isn't solid, make this node stone, so that
 706                                 // any top/filler nodes above are structurally supported.
 707                                 // This is done by aborting the cycle of top/filler placement
 708                                 // immediately by forcing nplaced to stone level.
 709                                 if (c_below == CONTENT_AIR
 710                                                 || c_below == c_water_source
 711                                                 || c_below == c_river_water_source)
 712                                         nplaced = U16_MAX;
 713
 714                                 if (river_water_above) {
 715                                         if (nplaced < depth_riverbed) {
 716                                                 vm->m_data[vi] = MapNode(biome->c_riverbed);
 717                                                 nplaced++;
 718                                         } else {
 719                                                 nplaced = U16_MAX;  // Disable top/filler placement
 720                                                 river_water_above = false;
 721                                         }
 722                                 } else if (nplaced < depth_top) {
 723                                         vm->m_data[vi] = MapNode(biome->c_top);
 724                                         nplaced++;
 725                                 } else if (nplaced < base_filler) {
 726                                         vm->m_data[vi] = MapNode(biome->c_filler);
 727                                         nplaced++;
 728                                 } else {
 729                                         vm->m_data[vi] = MapNode(biome->c_stone);
 730                                         nplaced = U16_MAX;  // Disable top/filler placement
 731                                 }
 732
 733                                 air_above = false;
 734                                 water_above = false;
 735                         } else if (c == c_water_source) {
 736                                 vm->m_data[vi] = MapNode((y > (s32)(water_level - depth_water_top))
 737                                                 ? biome->c_water_top : biome->c_water);
 738                                 nplaced = 0;  // Enable top/filler placement for next surface
 739                                 air_above = false;
 740                                 water_above = true;
 741                         } else if (c == c_river_water_source) {
 742                                 vm->m_data[vi] = MapNode(biome->c_river_water);
 743                                 nplaced = 0;  // Enable riverbed placement for next surface
 744                                 air_above = false;
 745                                 water_above = true;
 746                                 river_water_above = true;
 747                         } else if (c == CONTENT_AIR) {
 748                                 nplaced = 0;  // Enable top/filler placement for next surface
 749                                 air_above = true;
 750                                 water_above = false;
 751                         } else {  // Possible various nodes overgenerated from neighbouring mapchunks
 752                                 nplaced = U16_MAX;  // Disable top/filler placement
 753                                 air_above = false;
 754                                 water_above = false;
 755                         }
 756
 757                         VoxelArea::add_y(em, vi, -1);
 758                 }
 759                 // If no stone surface detected in mapchunk column and a water surface
 760                 // biome fallback exists, add it to the biomemap. This avoids water
 761                 // surface decorations failing in deep water.
 762                 if (biomemap[index] == BIOME_NONE && water_biome_index != 0)
 763                         biomemap[index] = water_biome_index;
 764         }
 765 }
 766
 767
 768 void MapgenBasic::dustTopNodes()
 769 {
 770         if (node_max.Y < water_level)
 771                 return;
 772
 773         const v3s16 &em = vm->m_area.getExtent();
 774         u32 index = 0;
 775
 776         for (s16 z = node_min.Z; z <= node_max.Z; z++)
 777         for (s16 x = node_min.X; x <= node_max.X; x++, index++) {
 778                 Biome *biome = (Biome *)m_bmgr->getRaw(biomemap[index]);
 779
 780                 if (biome->c_dust == CONTENT_IGNORE)
 781                         continue;
 782
 783                 // Check if mapchunk above has generated, if so, drop dust from 16 nodes
 784                 // above current mapchunk top, above decorations that will extend above
 785                 // the current mapchunk. If the mapchunk above has not generated, it
 786                 // will provide this required dust when it does.
 787                 u32 vi = vm->m_area.index(x, full_node_max.Y, z);
 788                 content_t c_full_max = vm->m_data[vi].getContent();
 789                 s16 y_start;
 790
 791                 if (c_full_max == CONTENT_AIR) {
 792                         y_start = full_node_max.Y - 1;
 793                 } else if (c_full_max == CONTENT_IGNORE) {
 794                         vi = vm->m_area.index(x, node_max.Y + 1, z);
 795                         content_t c_max = vm->m_data[vi].getContent();
 796
 797                         if (c_max == CONTENT_AIR)
 798                                 y_start = node_max.Y;
 799                         else
 800                                 continue;
 801                 } else {
 802                         continue;
 803                 }
 804
 805                 vi = vm->m_area.index(x, y_start, z);
 806                 for (s16 y = y_start; y >= node_min.Y - 1; y--) {
 807                         if (vm->m_data[vi].getContent() != CONTENT_AIR)
 808                                 break;
 809
 810                         VoxelArea::add_y(em, vi, -1);
 811                 }
 812
 813                 content_t c = vm->m_data[vi].getContent();
 814                 NodeDrawType dtype = ndef->get(c).drawtype;
 815                 // Only place on cubic, walkable, non-dust nodes.
 816                 // Dust check needed due to avoid double layer of dust caused by
 817                 // dropping dust from 16 nodes above mapchunk top.
 818                 if ((dtype == NDT_NORMAL ||
 819                                 dtype == NDT_ALLFACES ||
 820                                 dtype == NDT_ALLFACES_OPTIONAL ||
 821                                 dtype == NDT_GLASSLIKE ||
 822                                 dtype == NDT_GLASSLIKE_FRAMED ||
 823                                 dtype == NDT_GLASSLIKE_FRAMED_OPTIONAL) &&
 824                                 ndef->get(c).walkable && c != biome->c_dust) {
 825                         VoxelArea::add_y(em, vi, 1);
 826                         vm->m_data[vi] = MapNode(biome->c_dust);
 827                 }
 828         }
 829 }
 830
 831
 832 void MapgenBasic::generateCavesNoiseIntersection(s16 max_stone_y)
 833 {
 834         // cave_width >= 10 is used to disable generation and avoid the intensive
 835         // 3D noise calculations. Tunnels already have zero width when cave_width > 1.
 836         if (node_min.Y > max_stone_y || cave_width >= 10.0f)
 837                 return;
 838
 839         CavesNoiseIntersection caves_noise(ndef, m_bmgr, csize,
 840                 &np_cave1, &np_cave2, seed, cave_width);
 841
 842         caves_noise.generateCaves(vm, node_min, node_max, biomemap);
 843 }
 844
 845
 846 void MapgenBasic::generateCavesRandomWalk(s16 max_stone_y, s16 large_cave_ymax)
 847 {
 848         if (node_min.Y > max_stone_y)
 849                 return;
 850
 851         PseudoRandom ps(blockseed + 21343);
 852         // Small randomwalk caves
 853         u32 num_small_caves = ps.range(small_cave_num_min, small_cave_num_max);
 854
 855         for (u32 i = 0; i < num_small_caves; i++) {
 856                 CavesRandomWalk cave(ndef, &gennotify, seed, water_level,
 857                         c_water_source, c_lava_source, large_cave_flooded, biomegen);
 858                 cave.makeCave(vm, node_min, node_max, &ps, false, max_stone_y, heightmap);
 859         }
 860
 861         if (node_max.Y > large_cave_ymax)
 862                 return;
 863
 864         // Large randomwalk caves below 'large_cave_ymax'.
 865         // 'large_cave_ymax' can differ from the 'large_cave_depth' mapgen parameter,
 866         // it is set to world base to disable large caves in or near caverns.
 867         u32 num_large_caves = ps.range(large_cave_num_min, large_cave_num_max);
 868
 869         for (u32 i = 0; i < num_large_caves; i++) {
 870                 CavesRandomWalk cave(ndef, &gennotify, seed, water_level,
 871                         c_water_source, c_lava_source, large_cave_flooded, biomegen);
 872                 cave.makeCave(vm, node_min, node_max, &ps, true, max_stone_y, heightmap);
 873         }
 874 }
 875
 876
 877 bool MapgenBasic::generateCavernsNoise(s16 max_stone_y)
 878 {
 879         if (node_min.Y > max_stone_y || node_min.Y > cavern_limit)
 880                 return false;
 881
 882         CavernsNoise caverns_noise(ndef, csize, &np_cavern,
 883                 seed, cavern_limit, cavern_taper, cavern_threshold);
 884
 885         return caverns_noise.generateCaverns(vm, node_min, node_max);
 886 }
 887
 888
 889 void MapgenBasic::generateDungeons(s16 max_stone_y)
 890 {
 891         if (node_min.Y > max_stone_y || node_min.Y > dungeon_ymax ||
 892                         node_max.Y < dungeon_ymin)
 893                 return;
 894
 895         u16 num_dungeons = std::fmax(std::floor(
 896                 NoisePerlin3D(&np_dungeons, node_min.X, node_min.Y, node_min.Z, seed)), 0.0f);
 897         if (num_dungeons == 0)
 898                 return;
 899
 900         PseudoRandom ps(blockseed + 70033);
 901
 902         DungeonParams dp;
 903
 904         dp.np_alt_wall =
 905                 NoiseParams(-0.4, 1.0, v3f(40.0, 40.0, 40.0), 32474, 6, 1.1, 2.0);
 906
 907         dp.seed                = seed;
 908         dp.only_in_ground      = true;
 909         dp.num_dungeons        = num_dungeons;
 910         dp.notifytype          = GENNOTIFY_DUNGEON;
 911         dp.num_rooms           = ps.range(2, 16);
 912         dp.room_size_min       = v3s16(5, 5, 5);
 913         dp.room_size_max       = v3s16(12, 6, 12);
 914         dp.room_size_large_min = v3s16(12, 6, 12);
 915         dp.room_size_large_max = v3s16(16, 16, 16);
 916         dp.large_room_chance   = (ps.range(1, 4) == 1) ? 8 : 0;
 917         dp.diagonal_dirs       = ps.range(1, 8) == 1;
 918         // Diagonal corridors must have 'hole' width >=2 to be passable
 919         u8 holewidth           = (dp.diagonal_dirs) ? 2 : ps.range(1, 2);
 920         dp.holesize            = v3s16(holewidth, 3, holewidth);
 921         dp.corridor_len_min    = 1;
 922         dp.corridor_len_max    = 13;
 923
 924         // Get biome at mapchunk midpoint
 925         v3s16 chunk_mid = node_min + (node_max - node_min) / v3s16(2, 2, 2);
 926         Biome *biome = (Biome *)biomegen->getBiomeAtPoint(chunk_mid);
 927
 928         // Use biome-defined dungeon nodes if defined
 929         if (biome->c_dungeon != CONTENT_IGNORE) {
 930                 dp.c_wall = biome->c_dungeon;
 931                 // If 'node_dungeon_alt' is not defined by biome, it and dp.c_alt_wall
 932                 // become CONTENT_IGNORE which skips the alt wall node placement loop in
 933                 // dungeongen.cpp.
 934                 dp.c_alt_wall = biome->c_dungeon_alt;
 935                 // Stairs fall back to 'c_dungeon' if not defined by biome
 936                 dp.c_stair = (biome->c_dungeon_stair != CONTENT_IGNORE) ?
 937                         biome->c_dungeon_stair : biome->c_dungeon;
 938         // Fallback to using cobble mapgen alias if defined
 939         } else if (c_cobble != CONTENT_IGNORE) {
 940                 dp.c_wall     = c_cobble;
 941                 dp.c_alt_wall = CONTENT_IGNORE;
 942                 dp.c_stair    = c_cobble;
 943         // Fallback to using biome-defined stone
 944         } else {
 945                 dp.c_wall     = biome->c_stone;
 946                 dp.c_alt_wall = CONTENT_IGNORE;
 947                 dp.c_stair    = biome->c_stone;
 948         }
 949
 950         DungeonGen dgen(ndef, &gennotify, &dp);
 951         dgen.generate(vm, blockseed, full_node_min, full_node_max);
 952 }
 953
 954
 955 ////
 956 //// GenerateNotifier
 957 ////
 958
 959 GenerateNotifier::GenerateNotifier(u32 notify_on,
 960         const std::set<u32> *notify_on_deco_ids)
 961 {
 962         m_notify_on = notify_on;
 963         m_notify_on_deco_ids = notify_on_deco_ids;
 964 }
 965
 966
 967 bool GenerateNotifier::addEvent(GenNotifyType type, v3s16 pos, u32 id)
 968 {
 969         if (!(m_notify_on & (1 << type)))
 970                 return false;
 971
 972         if (type == GENNOTIFY_DECORATION &&
 973                 m_notify_on_deco_ids->find(id) == m_notify_on_deco_ids->cend())
 974                 return false;
 975
 976         GenNotifyEvent gne;
 977         gne.type = type;
 978         gne.pos  = pos;
 979         gne.id   = id;
 980         m_notify_events.push_back(gne);
 981
 982         return true;
 983 }
 984
 985
 986 void GenerateNotifier::getEvents(
 987         std::map<std::string, std::vector<v3s16> > &event_map)
 988 {
 989         std::list<GenNotifyEvent>::iterator it;
 990
 991         for (it = m_notify_events.begin(); it != m_notify_events.end(); ++it) {
 992                 GenNotifyEvent &gn = *it;
 993                 std::string name = (gn.type == GENNOTIFY_DECORATION) ?
 994                         "decoration#"+ itos(gn.id) :
 995                         flagdesc_gennotify[gn.type].name;
 996
 997                 event_map[name].push_back(gn.pos);
 998         }
 999 }
1000
1001
1002 void GenerateNotifier::clearEvents()
1003 {
1004         m_notify_events.clear();
1005 }
1006
1007
1008 ////
1009 //// MapgenParams
1010 ////
1011
1012
1013 MapgenParams::~MapgenParams()
1014 {
1015         delete bparams;
1016 }
1017
1018
1019 void MapgenParams::readParams(const Settings *settings)
1020 {
1021         // should always be used via MapSettingsManager
1022         assert(settings != g_settings);
1023
1024         std::string seed_str;
1025         if (settings->getNoEx("seed", seed_str)) {
1026                 if (!seed_str.empty())
1027                         seed = read_seed(seed_str.c_str());
1028                 else
1029                         myrand_bytes(&seed, sizeof(seed));
1030         }
1031
1032         std::string mg_name;
1033         if (settings->getNoEx("mg_name", mg_name)) {
1034                 mgtype = Mapgen::getMapgenType(mg_name);
1035                 if (mgtype == MAPGEN_INVALID)
1036                         mgtype = MAPGEN_DEFAULT;
1037         }
1038
1039         settings->getS16NoEx("water_level", water_level);
1040         settings->getS16NoEx("mapgen_limit", mapgen_limit);
1041         settings->getS16NoEx("chunksize", chunksize);
1042         settings->getFlagStrNoEx("mg_flags", flags, flagdesc_mapgen);
1043
1044         delete bparams;
1045         bparams = BiomeManager::createBiomeParams(BIOMEGEN_ORIGINAL);
1046         if (bparams) {
1047                 bparams->readParams(settings);
1048                 bparams->seed = seed;
1049         }
1050 }
1051
1052
1053 void MapgenParams::writeParams(Settings *settings) const
1054 {
1055         settings->set("mg_name", Mapgen::getMapgenName(mgtype));
1056         settings->setU64("seed", seed);
1057         settings->setS16("water_level", water_level);
1058         settings->setS16("mapgen_limit", mapgen_limit);
1059         settings->setS16("chunksize", chunksize);
1060         settings->setFlagStr("mg_flags", flags, flagdesc_mapgen);
1061
1062         if (bparams)
1063                 bparams->writeParams(settings);
1064 }
1065
1066
1067 // Calculate exact edges of the outermost mapchunks that are within the
1068 // set 'mapgen_limit'.
1069 void MapgenParams::calcMapgenEdges()
1070 {
1071         // Central chunk offset, in blocks
1072         s16 ccoff_b = -chunksize / 2;
1073         // Chunksize, in nodes
1074         s32 csize_n = chunksize * MAP_BLOCKSIZE;
1075         // Minp/maxp of central chunk, in nodes
1076         s16 ccmin = ccoff_b * MAP_BLOCKSIZE;
1077         s16 ccmax = ccmin + csize_n - 1;
1078         // Fullminp/fullmaxp of central chunk, in nodes
1079         s16 ccfmin = ccmin - MAP_BLOCKSIZE;
1080         s16 ccfmax = ccmax + MAP_BLOCKSIZE;
1081         // Effective mapgen limit, in blocks
1082         // Uses same calculation as ServerMap::blockpos_over_mapgen_limit(v3s16 p)
1083         s16 mapgen_limit_b = rangelim(mapgen_limit,
1084                 0, MAX_MAP_GENERATION_LIMIT) / MAP_BLOCKSIZE;
1085         // Effective mapgen limits, in nodes
1086         s16 mapgen_limit_min = -mapgen_limit_b * MAP_BLOCKSIZE;
1087         s16 mapgen_limit_max = (mapgen_limit_b + 1) * MAP_BLOCKSIZE - 1;
1088         // Number of complete chunks from central chunk fullminp/fullmaxp
1089         // to effective mapgen limits.
1090         s16 numcmin = MYMAX((ccfmin - mapgen_limit_min) / csize_n, 0);
1091         s16 numcmax = MYMAX((mapgen_limit_max - ccfmax) / csize_n, 0);
1092         // Mapgen edges, in nodes
1093         mapgen_edge_min = ccmin - numcmin * csize_n;
1094         mapgen_edge_max = ccmax + numcmax * csize_n;
1095
1096         m_mapgen_edges_calculated = true;
1097 }
1098
1099
1100 s32 MapgenParams::getSpawnRangeMax()
1101 {
1102         if (!m_mapgen_edges_calculated)
1103                 calcMapgenEdges();
1104
1105         return MYMIN(-mapgen_edge_min, mapgen_edge_max);
1106 }