3 Copyright (C) 2010-2015 celeron55, Perttu Ahola <celeron55@gmail.com>
4 Copyright (C) 2013-2016 kwolekr, Ryan Kwolek <kwolekr@minetest.net>
5 Copyright (C) 2015-2017 paramat
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.
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.
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.
26 #include "util/string.h"
27 #include "util/container.h"
29 #define MAPGEN_DEFAULT MAPGEN_V7
30 #define MAPGEN_DEFAULT_NAME "v7"
32 /////////////////// Mapgen flags
33 #define MG_TREES 0x01 // Deprecated. Moved into mgv6 flags
35 #define MG_DUNGEONS 0x04
36 #define MG_FLAT 0x08 // Deprecated. Moved into mgv6 flags
38 #define MG_DECORATIONS 0x20
40 typedef u8 biome_t; // copy from mg_biome.h to avoid an unnecessary include
44 class INodeDefManager;
46 extern FlagDesc flagdesc_mapgen[];
47 extern FlagDesc flagdesc_gennotify[];
55 class VoxelManipulator;
74 GENNOTIFY_LARGECAVE_BEGIN,
75 GENNOTIFY_LARGECAVE_END,
87 struct GenNotifyEvent {
93 class GenerateNotifier {
95 GenerateNotifier() = default;
96 GenerateNotifier(u32 notify_on, std::set<u32> *notify_on_deco_ids);
98 void setNotifyOn(u32 notify_on);
99 void setNotifyOnDecoIds(std::set<u32> *notify_on_deco_ids);
101 bool addEvent(GenNotifyType type, v3s16 pos, u32 id=0);
102 void getEvents(std::map<std::string, std::vector<v3s16> > &event_map,
103 bool peek_events=false);
107 std::set<u32> *m_notify_on_deco_ids;
108 std::list<GenNotifyEvent> m_notify_events;
123 struct MapgenParams {
124 MapgenParams() = default;
125 virtual ~MapgenParams();
127 MapgenType mgtype = MAPGEN_DEFAULT;
131 s16 mapgen_limit = MAX_MAP_GENERATION_LIMIT;
132 u32 flags = MG_CAVES | MG_LIGHT | MG_DECORATIONS;
134 BiomeParams *bparams = nullptr;
136 s16 mapgen_edge_min = -MAX_MAP_GENERATION_LIMIT;
137 s16 mapgen_edge_max = MAX_MAP_GENERATION_LIMIT;
139 virtual void readParams(const Settings *settings);
140 virtual void writeParams(Settings *settings) const;
142 bool saoPosOverLimit(const v3f &p);
143 s32 getSpawnRangeMax();
146 void calcMapgenEdges();
148 float m_sao_limit_min = -MAX_MAP_GENERATION_LIMIT * BS;
149 float m_sao_limit_max = MAX_MAP_GENERATION_LIMIT * BS;
150 bool m_mapgen_edges_calculated = false;
155 Generic interface for map generators. All mapgens must inherit this class.
156 If a feature exposed by a public member pointer is not supported by a
157 certain mapgen, it must be set to NULL.
159 Apart from makeChunk, getGroundLevelAtPoint, and getSpawnLevelAtPoint, all
160 methods can be used by constructing a Mapgen base class and setting the
161 appropriate public members (e.g. vm, ndef, and so on).
167 int mapgen_limit = 0;
169 bool generating = false;
172 MMVManip *vm = nullptr;
173 INodeDefManager *ndef = nullptr;
176 s16 *heightmap = nullptr;
177 biome_t *biomemap = nullptr;
180 BiomeGen *biomegen = nullptr;
181 GenerateNotifier gennotify;
184 Mapgen(int mapgenid, MapgenParams *params, EmergeManager *emerge);
185 virtual ~Mapgen() = default;
186 DISABLE_CLASS_COPY(Mapgen);
188 virtual MapgenType getType() const { return MAPGEN_INVALID; }
190 static u32 getBlockSeed(v3s16 p, s32 seed);
191 static u32 getBlockSeed2(v3s16 p, s32 seed);
192 s16 findGroundLevelFull(v2s16 p2d);
193 s16 findGroundLevel(v2s16 p2d, s16 ymin, s16 ymax);
194 s16 findLiquidSurface(v2s16 p2d, s16 ymin, s16 ymax);
195 void updateHeightmap(v3s16 nmin, v3s16 nmax);
196 void updateLiquid(UniqueQueue<v3s16> *trans_liquid, v3s16 nmin, v3s16 nmax);
198 void setLighting(u8 light, v3s16 nmin, v3s16 nmax);
199 void lightSpread(VoxelArea &a, v3s16 p, u8 light);
200 void calcLighting(v3s16 nmin, v3s16 nmax, v3s16 full_nmin, v3s16 full_nmax,
201 bool propagate_shadow = true);
202 void propagateSunlight(v3s16 nmin, v3s16 nmax, bool propagate_shadow);
203 void spreadLight(v3s16 nmin, v3s16 nmax);
205 virtual void makeChunk(BlockMakeData *data) {}
206 virtual int getGroundLevelAtPoint(v2s16 p) { return 0; }
208 // getSpawnLevelAtPoint() is a function within each mapgen that returns a
209 // suitable y co-ordinate for player spawn ('suitable' usually meaning
210 // within 16 nodes of water_level). If a suitable spawn level cannot be
211 // found at the specified (X, Z) 'MAX_MAP_GENERATION_LIMIT' is returned to
212 // signify this and to cause Server::findSpawnPos() to try another (X, Z).
213 virtual int getSpawnLevelAtPoint(v2s16 p) { return 0; }
215 // Mapgen management functions
216 static MapgenType getMapgenType(const std::string &mgname);
217 static const char *getMapgenName(MapgenType mgtype);
218 static Mapgen *createMapgen(MapgenType mgtype, int mgid,
219 MapgenParams *params, EmergeManager *emerge);
220 static MapgenParams *createMapgenParams(MapgenType mgtype);
221 static void getMapgenNames(std::vector<const char *> *mgnames, bool include_hidden);
224 // isLiquidHorizontallyFlowable() is a helper function for updateLiquid()
225 // that checks whether there are floodable nodes without liquid beneath
226 // the node at index vi.
227 inline bool isLiquidHorizontallyFlowable(u32 vi, v3s16 em);
231 MapgenBasic is a Mapgen implementation that handles basic functionality
232 the majority of conventional mapgens will probably want to use, but isn't
233 generic enough to be included as part of the base Mapgen class (such as
234 generating biome terrain over terrain node skeletons, generating caves,
237 Inherit MapgenBasic instead of Mapgen to add this basic functionality to
238 your mapgen without having to reimplement it. Feel free to override any of
239 these methods if you desire different or more advanced behavior.
241 Note that you must still create your own generateTerrain implementation when
242 inheriting MapgenBasic.
244 class MapgenBasic : public Mapgen {
246 MapgenBasic(int mapgenid, MapgenParams *params, EmergeManager *emerge);
247 virtual ~MapgenBasic();
249 virtual void generateCaves(s16 max_stone_y, s16 large_cave_depth);
250 virtual bool generateCaverns(s16 max_stone_y);
251 virtual void generateDungeons(s16 max_stone_y,
252 MgStoneType stone_type, content_t biome_stone);
253 virtual void generateBiomes(MgStoneType *mgstone_type,
254 content_t *biome_stone);
255 virtual void dustTopNodes();
258 EmergeManager *m_emerge;
259 BiomeManager *m_bmgr;
261 Noise *noise_filler_depth;
268 // Content required for generateBiomes
270 content_t c_desert_stone;
271 content_t c_sandstone;
272 content_t c_water_source;
273 content_t c_river_water_source;
274 content_t c_lava_source;
276 // Content required for generateDungeons
278 content_t c_stair_cobble;
279 content_t c_mossycobble;
280 content_t c_stair_desert_stone;
281 content_t c_sandstonebrick;
282 content_t c_stair_sandstone_block;
291 NoiseParams np_cave1;
292 NoiseParams np_cave2;
293 NoiseParams np_cavern;
297 float cavern_threshold;