Fix remaining issues with mapgen scriptapi
[oweals/minetest.git] / src / mapgen / mg_biome.cpp
1 /*
2 Minetest
3 Copyright (C) 2014-2018 kwolekr, Ryan Kwolek <kwolekr@minetest.net>
4 Copyright (C) 2014-2018 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 #include "mg_biome.h"
22 #include "mg_decoration.h"
23 #include "emerge.h"
24 #include "server.h"
25 #include "nodedef.h"
26 #include "map.h" //for MMVManip
27 #include "util/numeric.h"
28 #include "porting.h"
29 #include "settings.h"
30
31
32 ///////////////////////////////////////////////////////////////////////////////
33
34
35 BiomeManager::BiomeManager(Server *server) :
36         ObjDefManager(server, OBJDEF_BIOME)
37 {
38         m_server = server;
39
40         // Create default biome to be used in case none exist
41         Biome *b = new Biome;
42
43         b->name            = "default";
44         b->flags           = 0;
45         b->depth_top       = 0;
46         b->depth_filler    = -MAX_MAP_GENERATION_LIMIT;
47         b->depth_water_top = 0;
48         b->depth_riverbed  = 0;
49         b->min_pos         = v3s16(-MAX_MAP_GENERATION_LIMIT,
50                         -MAX_MAP_GENERATION_LIMIT, -MAX_MAP_GENERATION_LIMIT);
51         b->max_pos         = v3s16(MAX_MAP_GENERATION_LIMIT,
52                         MAX_MAP_GENERATION_LIMIT, MAX_MAP_GENERATION_LIMIT);
53         b->heat_point      = 0.0;
54         b->humidity_point  = 0.0;
55         b->vertical_blend  = 0;
56
57         b->m_nodenames.emplace_back("mapgen_stone");
58         b->m_nodenames.emplace_back("mapgen_stone");
59         b->m_nodenames.emplace_back("mapgen_stone");
60         b->m_nodenames.emplace_back("mapgen_water_source");
61         b->m_nodenames.emplace_back("mapgen_water_source");
62         b->m_nodenames.emplace_back("mapgen_river_water_source");
63         b->m_nodenames.emplace_back("mapgen_stone");
64         b->m_nodenames.emplace_back("ignore");
65         b->m_nodenames.emplace_back("ignore");
66         b->m_nnlistsizes.push_back(1);
67         b->m_nodenames.emplace_back("ignore");
68         b->m_nodenames.emplace_back("ignore");
69         b->m_nodenames.emplace_back("ignore");
70         m_ndef->pendNodeResolve(b);
71
72         add(b);
73 }
74
75
76 void BiomeManager::clear()
77 {
78         EmergeManager *emerge = m_server->getEmergeManager();
79
80         // Remove all dangling references in Decorations
81         DecorationManager *decomgr = emerge->getWritableDecorationManager();
82         for (size_t i = 0; i != decomgr->getNumObjects(); i++) {
83                 Decoration *deco = (Decoration *)decomgr->getRaw(i);
84                 deco->biomes.clear();
85         }
86
87         // Don't delete the first biome
88         for (size_t i = 1; i < m_objects.size(); i++)
89                 delete (Biome *)m_objects[i];
90
91         m_objects.resize(1);
92 }
93
94
95 BiomeManager *BiomeManager::clone() const
96 {
97         auto mgr = new BiomeManager();
98         assert(mgr);
99         ObjDefManager::cloneTo(mgr);
100         mgr->m_server = m_server;
101         return mgr;
102 }
103
104
105 // For BiomeGen type 'BiomeGenOriginal'
106 float BiomeManager::getHeatAtPosOriginal(v3s16 pos, NoiseParams &np_heat,
107         NoiseParams &np_heat_blend, u64 seed) const
108 {
109         return
110                 NoisePerlin2D(&np_heat,       pos.X, pos.Z, seed) +
111                 NoisePerlin2D(&np_heat_blend, pos.X, pos.Z, seed);
112 }
113
114
115 // For BiomeGen type 'BiomeGenOriginal'
116 float BiomeManager::getHumidityAtPosOriginal(v3s16 pos, NoiseParams &np_humidity,
117         NoiseParams &np_humidity_blend, u64 seed) const
118 {
119         return
120                 NoisePerlin2D(&np_humidity,       pos.X, pos.Z, seed) +
121                 NoisePerlin2D(&np_humidity_blend, pos.X, pos.Z, seed);
122 }
123
124
125 // For BiomeGen type 'BiomeGenOriginal'
126 const Biome *BiomeManager::getBiomeFromNoiseOriginal(float heat,
127         float humidity, v3s16 pos) const
128 {
129         Biome *biome_closest = nullptr;
130         Biome *biome_closest_blend = nullptr;
131         float dist_min = FLT_MAX;
132         float dist_min_blend = FLT_MAX;
133
134         for (size_t i = 1; i < getNumObjects(); i++) {
135                 Biome *b = (Biome *)getRaw(i);
136                 if (!b ||
137                                 pos.Y < b->min_pos.Y || pos.Y > b->max_pos.Y + b->vertical_blend ||
138                                 pos.X < b->min_pos.X || pos.X > b->max_pos.X ||
139                                 pos.Z < b->min_pos.Z || pos.Z > b->max_pos.Z)
140                         continue;
141
142                 float d_heat = heat - b->heat_point;
143                 float d_humidity = humidity - b->humidity_point;
144                 float dist = (d_heat * d_heat) + (d_humidity * d_humidity);
145
146                 if (pos.Y <= b->max_pos.Y) { // Within y limits of biome b
147                         if (dist < dist_min) {
148                                 dist_min = dist;
149                                 biome_closest = b;
150                         }
151                 } else if (dist < dist_min_blend) { // Blend area above biome b
152                         dist_min_blend = dist;
153                         biome_closest_blend = b;
154                 }
155         }
156
157         mysrand(pos.Y + (heat + humidity) * 0.9f);
158         if (biome_closest_blend && dist_min_blend <= dist_min &&
159                         myrand_range(0, biome_closest_blend->vertical_blend) >=
160                         pos.Y - biome_closest_blend->max_pos.Y)
161                 return biome_closest_blend;
162
163         return (biome_closest) ? biome_closest : (Biome *)getRaw(BIOME_NONE);
164 }
165
166
167 ////////////////////////////////////////////////////////////////////////////////
168
169 void BiomeParamsOriginal::readParams(const Settings *settings)
170 {
171         settings->getNoiseParams("mg_biome_np_heat",           np_heat);
172         settings->getNoiseParams("mg_biome_np_heat_blend",     np_heat_blend);
173         settings->getNoiseParams("mg_biome_np_humidity",       np_humidity);
174         settings->getNoiseParams("mg_biome_np_humidity_blend", np_humidity_blend);
175 }
176
177
178 void BiomeParamsOriginal::writeParams(Settings *settings) const
179 {
180         settings->setNoiseParams("mg_biome_np_heat",           np_heat);
181         settings->setNoiseParams("mg_biome_np_heat_blend",     np_heat_blend);
182         settings->setNoiseParams("mg_biome_np_humidity",       np_humidity);
183         settings->setNoiseParams("mg_biome_np_humidity_blend", np_humidity_blend);
184 }
185
186
187 ////////////////////////////////////////////////////////////////////////////////
188
189 BiomeGenOriginal::BiomeGenOriginal(BiomeManager *biomemgr,
190         BiomeParamsOriginal *params, v3s16 chunksize)
191 {
192         m_bmgr   = biomemgr;
193         m_params = params;
194         m_csize  = chunksize;
195
196         noise_heat           = new Noise(&params->np_heat,
197                                                                         params->seed, m_csize.X, m_csize.Z);
198         noise_humidity       = new Noise(&params->np_humidity,
199                                                                         params->seed, m_csize.X, m_csize.Z);
200         noise_heat_blend     = new Noise(&params->np_heat_blend,
201                                                                         params->seed, m_csize.X, m_csize.Z);
202         noise_humidity_blend = new Noise(&params->np_humidity_blend,
203                                                                         params->seed, m_csize.X, m_csize.Z);
204
205         heatmap  = noise_heat->result;
206         humidmap = noise_humidity->result;
207
208         biomemap = new biome_t[m_csize.X * m_csize.Z];
209         // Initialise with the ID of 'BIOME_NONE' so that cavegen can get the
210         // fallback biome when biome generation (which calculates the biomemap IDs)
211         // is disabled.
212         memset(biomemap, 0, sizeof(biome_t) * m_csize.X * m_csize.Z);
213 }
214
215 BiomeGenOriginal::~BiomeGenOriginal()
216 {
217         delete []biomemap;
218
219         delete noise_heat;
220         delete noise_humidity;
221         delete noise_heat_blend;
222         delete noise_humidity_blend;
223 }
224
225 // Only usable in a mapgen thread
226 Biome *BiomeGenOriginal::calcBiomeAtPoint(v3s16 pos) const
227 {
228         float heat =
229                 NoisePerlin2D(&m_params->np_heat,       pos.X, pos.Z, m_params->seed) +
230                 NoisePerlin2D(&m_params->np_heat_blend, pos.X, pos.Z, m_params->seed);
231         float humidity =
232                 NoisePerlin2D(&m_params->np_humidity,       pos.X, pos.Z, m_params->seed) +
233                 NoisePerlin2D(&m_params->np_humidity_blend, pos.X, pos.Z, m_params->seed);
234
235         return calcBiomeFromNoise(heat, humidity, pos);
236 }
237
238
239 void BiomeGenOriginal::calcBiomeNoise(v3s16 pmin)
240 {
241         m_pmin = pmin;
242
243         noise_heat->perlinMap2D(pmin.X, pmin.Z);
244         noise_humidity->perlinMap2D(pmin.X, pmin.Z);
245         noise_heat_blend->perlinMap2D(pmin.X, pmin.Z);
246         noise_humidity_blend->perlinMap2D(pmin.X, pmin.Z);
247
248         for (s32 i = 0; i < m_csize.X * m_csize.Z; i++) {
249                 noise_heat->result[i]     += noise_heat_blend->result[i];
250                 noise_humidity->result[i] += noise_humidity_blend->result[i];
251         }
252 }
253
254
255 biome_t *BiomeGenOriginal::getBiomes(s16 *heightmap, v3s16 pmin)
256 {
257         for (s16 zr = 0; zr < m_csize.Z; zr++)
258         for (s16 xr = 0; xr < m_csize.X; xr++) {
259                 s32 i = zr * m_csize.X + xr;
260                 Biome *biome = calcBiomeFromNoise(
261                         noise_heat->result[i],
262                         noise_humidity->result[i],
263                         v3s16(pmin.X + xr, heightmap[i], pmin.Z + zr));
264
265                 biomemap[i] = biome->index;
266         }
267
268         return biomemap;
269 }
270
271
272 Biome *BiomeGenOriginal::getBiomeAtPoint(v3s16 pos) const
273 {
274         return getBiomeAtIndex(
275                 (pos.Z - m_pmin.Z) * m_csize.X + (pos.X - m_pmin.X),
276                 pos);
277 }
278
279
280 Biome *BiomeGenOriginal::getBiomeAtIndex(size_t index, v3s16 pos) const
281 {
282         return calcBiomeFromNoise(
283                 noise_heat->result[index],
284                 noise_humidity->result[index],
285                 pos);
286 }
287
288
289 Biome *BiomeGenOriginal::calcBiomeFromNoise(float heat, float humidity, v3s16 pos) const
290 {
291         Biome *biome_closest = nullptr;
292         Biome *biome_closest_blend = nullptr;
293         float dist_min = FLT_MAX;
294         float dist_min_blend = FLT_MAX;
295
296         for (size_t i = 1; i < m_bmgr->getNumObjects(); i++) {
297                 Biome *b = (Biome *)m_bmgr->getRaw(i);
298                 if (!b ||
299                                 pos.Y < b->min_pos.Y || pos.Y > b->max_pos.Y + b->vertical_blend ||
300                                 pos.X < b->min_pos.X || pos.X > b->max_pos.X ||
301                                 pos.Z < b->min_pos.Z || pos.Z > b->max_pos.Z)
302                         continue;
303
304                 float d_heat = heat - b->heat_point;
305                 float d_humidity = humidity - b->humidity_point;
306                 float dist = (d_heat * d_heat) + (d_humidity * d_humidity);
307
308                 if (pos.Y <= b->max_pos.Y) { // Within y limits of biome b
309                         if (dist < dist_min) {
310                                 dist_min = dist;
311                                 biome_closest = b;
312                         }
313                 } else if (dist < dist_min_blend) { // Blend area above biome b
314                         dist_min_blend = dist;
315                         biome_closest_blend = b;
316                 }
317         }
318
319         // Carefully tune pseudorandom seed variation to avoid single node dither
320         // and create larger scale blending patterns similar to horizontal biome
321         // blend.
322         mysrand(pos.Y + (heat + humidity) * 0.9f);
323
324         if (biome_closest_blend && dist_min_blend <= dist_min &&
325                         myrand_range(0, biome_closest_blend->vertical_blend) >=
326                         pos.Y - biome_closest_blend->max_pos.Y)
327                 return biome_closest_blend;
328
329         return (biome_closest) ? biome_closest : (Biome *)m_bmgr->getRaw(BIOME_NONE);   
330 }
331
332
333 ////////////////////////////////////////////////////////////////////////////////
334
335 ObjDef *Biome::clone() const
336 {
337         auto obj = new Biome();
338         ObjDef::cloneTo(obj);
339         NodeResolver::cloneTo(obj);
340
341         obj->flags = flags;
342
343         obj->c_top = c_top;
344         obj->c_filler = c_filler;
345         obj->c_stone = c_stone;
346         obj->c_water_top = c_water_top;
347         obj->c_water = c_water;
348         obj->c_river_water = c_river_water;
349         obj->c_riverbed = c_riverbed;
350         obj->c_dust = c_dust;
351         obj->c_cave_liquid = c_cave_liquid;
352         obj->c_dungeon = c_dungeon;
353         obj->c_dungeon_alt = c_dungeon_alt;
354         obj->c_dungeon_stair = c_dungeon_stair;
355
356         obj->depth_top = depth_top;
357         obj->depth_filler = depth_filler;
358         obj->depth_water_top = depth_water_top;
359         obj->depth_riverbed = depth_riverbed;
360
361         obj->min_pos = min_pos;
362         obj->max_pos = max_pos;
363         obj->heat_point = heat_point;
364         obj->humidity_point = humidity_point;
365         obj->vertical_blend = vertical_blend;
366
367         return obj;
368 }
369
370 void Biome::resolveNodeNames()
371 {
372         getIdFromNrBacklog(&c_top,           "mapgen_stone",              CONTENT_AIR,    false);
373         getIdFromNrBacklog(&c_filler,        "mapgen_stone",              CONTENT_AIR,    false);
374         getIdFromNrBacklog(&c_stone,         "mapgen_stone",              CONTENT_AIR,    false);
375         getIdFromNrBacklog(&c_water_top,     "mapgen_water_source",       CONTENT_AIR,    false);
376         getIdFromNrBacklog(&c_water,         "mapgen_water_source",       CONTENT_AIR,    false);
377         getIdFromNrBacklog(&c_river_water,   "mapgen_river_water_source", CONTENT_AIR,    false);
378         getIdFromNrBacklog(&c_riverbed,      "mapgen_stone",              CONTENT_AIR,    false);
379         getIdFromNrBacklog(&c_dust,          "ignore",                    CONTENT_IGNORE, false);
380         getIdsFromNrBacklog(&c_cave_liquid);
381         getIdFromNrBacklog(&c_dungeon,       "ignore",                    CONTENT_IGNORE, false);
382         getIdFromNrBacklog(&c_dungeon_alt,   "ignore",                    CONTENT_IGNORE, false);
383         getIdFromNrBacklog(&c_dungeon_stair, "ignore",                    CONTENT_IGNORE, false);
384 }