/*
Minetest
-Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
+Copyright (C) 2010-2015 celeron55, Perttu Ahola <celeron55@gmail.com>
+Copyright (C) 2013-2016 kwolekr, Ryan Kwolek <kwolekr@minetest.net>
+Copyright (C) 2015-2017 paramat
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
#ifndef MAPGEN_HEADER
#define MAPGEN_HEADER
-#include "irrlichttypes_extrabloated.h"
-#include "util/container.h" // UniqueQueue
-#include "gamedef.h"
-#include "mapnode.h"
#include "noise.h"
-#include "settings.h"
-#include <map>
+#include "nodedef.h"
+#include "mapnode.h"
+#include "util/string.h"
+#include "util/container.h"
+
+#define MAPGEN_DEFAULT MAPGEN_V7
+#define MAPGEN_DEFAULT_NAME "v7"
/////////////////// Mapgen flags
-#define MG_TREES 0x01
-#define MG_CAVES 0x02
-#define MG_DUNGEONS 0x04
-#define MGV6_JUNGLES 0x08
-#define MGV6_BIOME_BLEND 0x10
-#define MG_FLAT 0x20
+#define MG_TREES 0x01 // Deprecated. Moved into mgv6 flags
+#define MG_CAVES 0x02
+#define MG_DUNGEONS 0x04
+#define MG_FLAT 0x08 // Deprecated. Moved into mgv6 flags
+#define MG_LIGHT 0x10
+#define MG_DECORATIONS 0x20
+
+typedef u8 biome_t; // copy from mg_biome.h to avoid an unnecessary include
+
+class Settings;
+class MMVManip;
+class INodeDefManager;
extern FlagDesc flagdesc_mapgen[];
+extern FlagDesc flagdesc_gennotify[];
-class BiomeDefManager;
class Biome;
+class BiomeGen;
+struct BiomeParams;
+class BiomeManager;
class EmergeManager;
class MapBlock;
-class ManualMapVoxelManipulator;
class VoxelManipulator;
-class INodeDefManager;
struct BlockMakeData;
class VoxelArea;
+class Map;
+
+enum MapgenObject {
+ MGOBJ_VMANIP,
+ MGOBJ_HEIGHTMAP,
+ MGOBJ_BIOMEMAP,
+ MGOBJ_HEATMAP,
+ MGOBJ_HUMIDMAP,
+ MGOBJ_GENNOTIFY
+};
+
+enum GenNotifyType {
+ GENNOTIFY_DUNGEON,
+ GENNOTIFY_TEMPLE,
+ GENNOTIFY_CAVE_BEGIN,
+ GENNOTIFY_CAVE_END,
+ GENNOTIFY_LARGECAVE_BEGIN,
+ GENNOTIFY_LARGECAVE_END,
+ GENNOTIFY_DECORATION,
+ NUM_GENNOTIFY_TYPES
+};
+
+// TODO(hmmmm/paramat): make stone type selection dynamic
+enum MgStoneType {
+ MGSTONE_STONE,
+ MGSTONE_DESERT_STONE,
+ MGSTONE_SANDSTONE,
+};
+
+struct GenNotifyEvent {
+ GenNotifyType type;
+ v3s16 pos;
+ u32 id;
+};
+
+class GenerateNotifier {
+public:
+ GenerateNotifier();
+ GenerateNotifier(u32 notify_on, std::set<u32> *notify_on_deco_ids);
+
+ void setNotifyOn(u32 notify_on);
+ void setNotifyOnDecoIds(std::set<u32> *notify_on_deco_ids);
+
+ bool addEvent(GenNotifyType type, v3s16 pos, u32 id=0);
+ void getEvents(std::map<std::string, std::vector<v3s16> > &event_map,
+ bool peek_events=false);
+
+private:
+ u32 m_notify_on = 0;
+ std::set<u32> *m_notify_on_deco_ids;
+ std::list<GenNotifyEvent> m_notify_events;
+};
+
+enum MapgenType {
+ MAPGEN_V5,
+ MAPGEN_V6,
+ MAPGEN_V7,
+ MAPGEN_FLAT,
+ MAPGEN_FRACTAL,
+ MAPGEN_VALLEYS,
+ MAPGEN_SINGLENODE,
+ MAPGEN_CARPATHIAN,
+ MAPGEN_INVALID,
+};
struct MapgenParams {
- std::string mg_name;
- int chunksize;
- u64 seed;
- int water_level;
- u32 flags;
-
- MapgenParams() {
- mg_name = "v6";
- seed = 0;
- water_level = 1;
- chunksize = 5;
- flags = MG_TREES | MG_CAVES | MGV6_BIOME_BLEND;
- }
-
- virtual bool readParams(Settings *settings) = 0;
- virtual void writeParams(Settings *settings) {};
+ MapgenParams() {}
+ virtual ~MapgenParams();
+
+ MapgenType mgtype = MAPGEN_DEFAULT;
+ s16 chunksize = 5;
+ u64 seed = 0;
+ s16 water_level = 1;
+ s16 mapgen_limit = MAX_MAP_GENERATION_LIMIT;
+ u32 flags = MG_CAVES | MG_LIGHT | MG_DECORATIONS;
+
+ BiomeParams *bparams = nullptr;
+
+ s16 mapgen_edge_min = -MAX_MAP_GENERATION_LIMIT;
+ s16 mapgen_edge_max = MAX_MAP_GENERATION_LIMIT;
+
+ virtual void readParams(const Settings *settings);
+ virtual void writeParams(Settings *settings) const;
+
+ bool saoPosOverLimit(const v3f &p);
+ s32 getSpawnRangeMax();
+
+private:
+ void calcMapgenEdges();
+
+ float m_sao_limit_min = -MAX_MAP_GENERATION_LIMIT * BS;
+ float m_sao_limit_max = MAX_MAP_GENERATION_LIMIT * BS;
+ bool m_mapgen_edges_calculated = false;
};
+
+/*
+ Generic interface for map generators. All mapgens must inherit this class.
+ If a feature exposed by a public member pointer is not supported by a
+ certain mapgen, it must be set to NULL.
+
+ Apart from makeChunk, getGroundLevelAtPoint, and getSpawnLevelAtPoint, all
+ methods can be used by constructing a Mapgen base class and setting the
+ appropriate public members (e.g. vm, ndef, and so on).
+*/
class Mapgen {
public:
- int seed;
- int water_level;
- bool generating;
- int id;
- ManualMapVoxelManipulator *vm;
- INodeDefManager *ndef;
+ s32 seed = 0;
+ int water_level = 0;
+ int mapgen_limit = 0;
+ u32 flags = 0;
+ bool generating = false;
+ int id = -1;
+
+ MMVManip *vm = nullptr;
+ INodeDefManager *ndef = nullptr;
+
+ u32 blockseed;
+ s16 *heightmap = nullptr;
+ biome_t *biomemap = nullptr;
+ v3s16 csize;
+ BiomeGen *biomegen = nullptr;
+ GenerateNotifier gennotify;
+
+ Mapgen();
+ Mapgen(int mapgenid, MapgenParams *params, EmergeManager *emerge);
+ virtual ~Mapgen();
+ DISABLE_CLASS_COPY(Mapgen);
+
+ virtual MapgenType getType() const { return MAPGEN_INVALID; }
+
+ static u32 getBlockSeed(v3s16 p, s32 seed);
+ static u32 getBlockSeed2(v3s16 p, s32 seed);
+ s16 findGroundLevelFull(v2s16 p2d);
+ s16 findGroundLevel(v2s16 p2d, s16 ymin, s16 ymax);
+ s16 findLiquidSurface(v2s16 p2d, s16 ymin, s16 ymax);
+ void updateHeightmap(v3s16 nmin, v3s16 nmax);
void updateLiquid(UniqueQueue<v3s16> *trans_liquid, v3s16 nmin, v3s16 nmax);
- void setLighting(v3s16 nmin, v3s16 nmax, u8 light);
+
+ void setLighting(u8 light, v3s16 nmin, v3s16 nmax);
void lightSpread(VoxelArea &a, v3s16 p, u8 light);
- void calcLighting(v3s16 nmin, v3s16 nmax);
- void calcLightingOld(v3s16 nmin, v3s16 nmax);
+ void calcLighting(v3s16 nmin, v3s16 nmax, v3s16 full_nmin, v3s16 full_nmax,
+ bool propagate_shadow = true);
+ void propagateSunlight(v3s16 nmin, v3s16 nmax, bool propagate_shadow);
+ void spreadLight(v3s16 nmin, v3s16 nmax);
- virtual void makeChunk(BlockMakeData *data) {};
- virtual int getGroundLevelAtPoint(v2s16 p) = 0;
+ virtual void makeChunk(BlockMakeData *data) {}
+ virtual int getGroundLevelAtPoint(v2s16 p) { return 0; }
- //Legacy functions for Farmesh (pending removal)
- static bool get_have_beach(u64 seed, v2s16 p2d);
- static double tree_amount_2d(u64 seed, v2s16 p);
- static s16 find_ground_level_from_noise(u64 seed, v2s16 p2d, s16 precision);
-};
+ // getSpawnLevelAtPoint() is a function within each mapgen that returns a
+ // suitable y co-ordinate for player spawn ('suitable' usually meaning
+ // within 16 nodes of water_level). If a suitable spawn level cannot be
+ // found at the specified (X, Z) 'MAX_MAP_GENERATION_LIMIT' is returned to
+ // signify this and to cause Server::findSpawnPos() to try another (X, Z).
+ virtual int getSpawnLevelAtPoint(v2s16 p) { return 0; }
-struct MapgenFactory {
- virtual Mapgen *createMapgen(int mgid, MapgenParams *params,
- EmergeManager *emerge) = 0;
- virtual MapgenParams *createMapgenParams() = 0;
-};
+ // Mapgen management functions
+ static MapgenType getMapgenType(const std::string &mgname);
+ static const char *getMapgenName(MapgenType mgtype);
+ static Mapgen *createMapgen(MapgenType mgtype, int mgid,
+ MapgenParams *params, EmergeManager *emerge);
+ static MapgenParams *createMapgenParams(MapgenType mgtype);
+ static void getMapgenNames(std::vector<const char *> *mgnames, bool include_hidden);
-enum OreType {
- ORE_SCATTER,
- ORE_SHEET,
- ORE_CLAYLIKE
+private:
+ // isLiquidHorizontallyFlowable() is a helper function for updateLiquid()
+ // that checks whether there are floodable nodes without liquid beneath
+ // the node at index vi.
+ inline bool isLiquidHorizontallyFlowable(u32 vi, v3s16 em);
};
-class Ore {
+/*
+ MapgenBasic is a Mapgen implementation that handles basic functionality
+ the majority of conventional mapgens will probably want to use, but isn't
+ generic enough to be included as part of the base Mapgen class (such as
+ generating biome terrain over terrain node skeletons, generating caves,
+ dungeons, etc.)
+
+ Inherit MapgenBasic instead of Mapgen to add this basic functionality to
+ your mapgen without having to reimplement it. Feel free to override any of
+ these methods if you desire different or more advanced behavior.
+
+ Note that you must still create your own generateTerrain implementation when
+ inheriting MapgenBasic.
+*/
+class MapgenBasic : public Mapgen {
public:
- std::string ore_name;
- std::string wherein_name;
-
- content_t ore;
- content_t wherein; // the node to be replaced
- u32 clust_scarcity; // ore cluster has a 1-in-clust_scarcity chance of appearing at a node
- s16 clust_num_ores; // how many ore nodes are in a chunk
- s16 clust_size; // how large (in nodes) a chunk of ore is
- s16 height_min;
- s16 height_max;
- float nthresh; // threshhold for noise at which an ore is placed
- NoiseParams *np; // noise for distribution of clusters (NULL for uniform scattering)
- Noise *noise;
-
- Ore() {
- ore = CONTENT_IGNORE;
- wherein = CONTENT_IGNORE;
- np = NULL;
- noise = NULL;
- }
-
- void resolveNodeNames(INodeDefManager *ndef);
- virtual void generate(Mapgen *mg, u32 blockseed, v3s16 nmin, v3s16 nmax) = 0;
-};
+ MapgenBasic(int mapgenid, MapgenParams *params, EmergeManager *emerge);
+ virtual ~MapgenBasic();
-class OreScatter : public Ore {
- void generate(Mapgen *mg, u32 blockseed, v3s16 nmin, v3s16 nmax);
-};
+ virtual void generateCaves(s16 max_stone_y, s16 large_cave_depth);
+ virtual bool generateCaverns(s16 max_stone_y);
+ virtual void generateDungeons(s16 max_stone_y, MgStoneType stone_type);
+ virtual MgStoneType generateBiomes();
+ virtual void dustTopNodes();
-class OreSheet : public Ore {
- void generate(Mapgen *mg, u32 blockseed, v3s16 nmin, v3s16 nmax);
-};
+protected:
+ EmergeManager *m_emerge;
+ BiomeManager *m_bmgr;
-Ore *createOre(OreType type);
+ Noise *noise_filler_depth;
-#endif
+ v3s16 node_min;
+ v3s16 node_max;
+ v3s16 full_node_min;
+ v3s16 full_node_max;
+ // Content required for generateBiomes
+ content_t c_stone;
+ content_t c_desert_stone;
+ content_t c_sandstone;
+ content_t c_water_source;
+ content_t c_river_water_source;
+ content_t c_lava_source;
+
+ // Content required for generateDungeons
+ content_t c_cobble;
+ content_t c_stair_cobble;
+ content_t c_mossycobble;
+ content_t c_stair_desert_stone;
+ content_t c_sandstonebrick;
+ content_t c_stair_sandstone_block;
+
+ int ystride;
+ int zstride;
+ int zstride_1d;
+ int zstride_1u1d;
+
+ u32 spflags;
+
+ NoiseParams np_cave1;
+ NoiseParams np_cave2;
+ NoiseParams np_cavern;
+ float cave_width;
+ float cavern_limit;
+ float cavern_taper;
+ float cavern_threshold;
+ int lava_depth;
+};
+
+#endif