src/mg_ore.h

   1 /*
   2 Minetest
   3 Copyright (C) 2014-2016 kwolekr, Ryan Kwolek <kwolekr@minetest.net>
   4 Copyright (C) 2015-2017 paramat
   5
   6 This program is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU Lesser General Public License as published by
   8 the Free Software Foundation; either version 2.1 of the License, or
   9 (at your option) any later version.
  10
  11 This program is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU Lesser General Public License for more details.
  15
  16 You should have received a copy of the GNU Lesser General Public License along
  17 with this program; if not, write to the Free Software Foundation, Inc.,
  18 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19 */
  20
  21 #ifndef MG_ORE_HEADER
  22 #define MG_ORE_HEADER
  23
  24 #include <unordered_set>
  25 #include "objdef.h"
  26 #include "noise.h"
  27 #include "nodedef.h"
  28
  29 class Noise;
  30 class Mapgen;
  31 class MMVManip;
  32
  33 /////////////////// Ore generation flags
  34
  35 #define OREFLAG_ABSHEIGHT     0x01 // Non-functional but kept to not break flags
  36 #define OREFLAG_PUFF_CLIFFS   0x02
  37 #define OREFLAG_PUFF_ADDITIVE 0x04
  38 #define OREFLAG_USE_NOISE     0x08
  39
  40 enum OreType {
  41         ORE_SCATTER,
  42         ORE_SHEET,
  43         ORE_PUFF,
  44         ORE_BLOB,
  45         ORE_VEIN,
  46 };
  47
  48 extern FlagDesc flagdesc_ore[];
  49
  50 class Ore : public ObjDef, public NodeResolver {
  51 public:
  52         static const bool NEEDS_NOISE = false;
  53
  54         content_t c_ore;                  // the node to place
  55         std::vector<content_t> c_wherein; // the nodes to be placed in
  56         u32 clust_scarcity; // ore cluster has a 1-in-clust_scarcity chance of appearing at a node
  57         s16 clust_num_ores; // how many ore nodes are in a chunk
  58         s16 clust_size;     // how large (in nodes) a chunk of ore is
  59         s16 y_min;
  60         s16 y_max;
  61         u8 ore_param2;          // to set node-specific attributes
  62         u32 flags = 0;          // attributes for this ore
  63         float nthresh;      // threshold for noise at which an ore is placed
  64         NoiseParams np;     // noise for distribution of clusters (NULL for uniform scattering)
  65         Noise *noise = nullptr;
  66         std::unordered_set<u8> biomes;
  67
  68         Ore() {};
  69         virtual ~Ore();
  70
  71         virtual void resolveNodeNames();
  72
  73         size_t placeOre(Mapgen *mg, u32 blockseed,
  74                 v3s16 nmin, v3s16 nmax, s16 ore_zero_level);
  75         virtual void generate(MMVManip *vm, int mapseed, u32 blockseed,
  76                 v3s16 nmin, v3s16 nmax, u8 *biomemap) = 0;
  77 };
  78
  79 class OreScatter : public Ore {
  80 public:
  81         static const bool NEEDS_NOISE = false;
  82
  83         virtual void generate(MMVManip *vm, int mapseed, u32 blockseed,
  84                 v3s16 nmin, v3s16 nmax, u8 *biomemap);
  85 };
  86
  87 class OreSheet : public Ore {
  88 public:
  89         static const bool NEEDS_NOISE = true;
  90
  91         u16 column_height_min;
  92         u16 column_height_max;
  93         float column_midpoint_factor;
  94
  95         virtual void generate(MMVManip *vm, int mapseed, u32 blockseed,
  96                 v3s16 nmin, v3s16 nmax, u8 *biomemap);
  97 };
  98
  99 class OrePuff : public Ore {
 100 public:
 101         static const bool NEEDS_NOISE = true;
 102
 103         NoiseParams np_puff_top;
 104         NoiseParams np_puff_bottom;
 105         Noise *noise_puff_top = nullptr;
 106         Noise *noise_puff_bottom = nullptr;
 107
 108         OrePuff();
 109         virtual ~OrePuff();
 110
 111         virtual void generate(MMVManip *vm, int mapseed, u32 blockseed,
 112                 v3s16 nmin, v3s16 nmax, u8 *biomemap);
 113 };
 114
 115 class OreBlob : public Ore {
 116 public:
 117         static const bool NEEDS_NOISE = true;
 118
 119         virtual void generate(MMVManip *vm, int mapseed, u32 blockseed,
 120                 v3s16 nmin, v3s16 nmax, u8 *biomemap);
 121 };
 122
 123 class OreVein : public Ore {
 124 public:
 125         static const bool NEEDS_NOISE = true;
 126
 127         float random_factor;
 128         Noise *noise2 = nullptr;
 129
 130         OreVein();
 131         virtual ~OreVein();
 132
 133         virtual void generate(MMVManip *vm, int mapseed, u32 blockseed,
 134                 v3s16 nmin, v3s16 nmax, u8 *biomemap);
 135 };
 136
 137 class OreManager : public ObjDefManager {
 138 public:
 139         OreManager(IGameDef *gamedef);
 140         virtual ~OreManager() {}
 141
 142         const char *getObjectTitle() const
 143         {
 144                 return "ore";
 145         }
 146
 147         static Ore *create(OreType type)
 148         {
 149                 switch (type) {
 150                 case ORE_SCATTER:
 151                         return new OreScatter;
 152                 case ORE_SHEET:
 153                         return new OreSheet;
 154                 case ORE_PUFF:
 155                         return new OrePuff;
 156                 case ORE_BLOB:
 157                         return new OreBlob;
 158                 case ORE_VEIN:
 159                         return new OreVein;
 160                 default:
 161                         return nullptr;
 162                 }
 163         }
 164
 165         void clear();
 166
 167         size_t placeAllOres(Mapgen *mg, u32 blockseed,
 168                 v3s16 nmin, v3s16 nmax, s16 ore_zero_level = 0);
 169 };
 170
 171 #endif