3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 #include "lua_api/l_mapgen.h"
21 #include "lua_api/l_internal.h"
22 #include "lua_api/l_vmanip.h"
23 #include "common/c_converter.h"
24 #include "common/c_content.h"
25 #include "util/serialize.h"
27 #include "environment.h"
31 #include "mg_decoration.h"
32 #include "mg_schematic.h"
33 #include "mapgen_v5.h"
34 #include "mapgen_v7.h"
40 struct EnumString ModApiMapgen::es_BiomeTerrainType[] =
42 {BIOME_TYPE_NORMAL, "normal"},
43 {BIOME_TYPE_LIQUID, "liquid"},
44 {BIOME_TYPE_NETHER, "nether"},
45 {BIOME_TYPE_AETHER, "aether"},
46 {BIOME_TYPE_FLAT, "flat"},
50 struct EnumString ModApiMapgen::es_DecorationType[] =
52 {DECO_SIMPLE, "simple"},
53 {DECO_SCHEMATIC, "schematic"},
54 {DECO_LSYSTEM, "lsystem"},
58 struct EnumString ModApiMapgen::es_MapgenObject[] =
60 {MGOBJ_VMANIP, "voxelmanip"},
61 {MGOBJ_HEIGHTMAP, "heightmap"},
62 {MGOBJ_BIOMEMAP, "biomemap"},
63 {MGOBJ_HEATMAP, "heatmap"},
64 {MGOBJ_HUMIDMAP, "humiditymap"},
65 {MGOBJ_GENNOTIFY, "gennotify"},
69 struct EnumString ModApiMapgen::es_OreType[] =
71 {ORE_SCATTER, "scatter"},
73 {ORE_CLAYLIKE, "claylike"},
77 struct EnumString ModApiMapgen::es_Rotation[] =
83 {ROTATE_RAND, "random"},
88 ///////////////////////////////////////////////////////////////////////////////
91 bool read_schematic(lua_State *L, int index, Schematic *schem,
92 INodeDefManager *ndef, std::map<std::string, std::string> &replace_names)
94 //// Get schematic size
95 lua_getfield(L, index, "size");
96 v3s16 size = read_v3s16(L, -1);
99 //// Get schematic data
100 lua_getfield(L, index, "data");
101 luaL_checktype(L, -1, LUA_TTABLE);
103 int numnodes = size.X * size.Y * size.Z;
104 MapNode *schemdata = new MapNode[numnodes];
108 while (lua_next(L, -2)) {
115 // same as readnode, except param1 default is MTSCHEM_PROB_CONST
116 lua_getfield(L, -1, "name");
117 std::string name = luaL_checkstring(L, -1);
121 lua_getfield(L, -1, "param1");
122 param1 = !lua_isnil(L, -1) ? lua_tonumber(L, -1) : MTSCHEM_PROB_ALWAYS;
126 lua_getfield(L, -1, "param2");
127 param2 = !lua_isnil(L, -1) ? lua_tonumber(L, -1) : 0;
130 std::map<std::string, std::string>::iterator it;
131 it = replace_names.find(name);
132 if (it != replace_names.end())
135 schemdata[i] = MapNode(ndef, name, param1, param2);
142 errorstream << "read_schematic: incorrect number of "
143 "nodes provided in raw schematic data (got " << i <<
144 ", expected " << numnodes << ")." << std::endl;
149 //// Get Y-slice probability values (if present)
150 u8 *slice_probs = new u8[size.Y];
151 for (i = 0; i != size.Y; i++)
152 slice_probs[i] = MTSCHEM_PROB_ALWAYS;
154 lua_getfield(L, index, "yslice_prob");
155 if (lua_istable(L, -1)) {
157 while (lua_next(L, -2)) {
158 if (getintfield(L, -1, "ypos", i) && i >= 0 && i < size.Y) {
159 slice_probs[i] = getintfield_default(L, -1,
160 "prob", MTSCHEM_PROB_ALWAYS);
166 // Here, we read the nodes directly from the INodeDefManager - there is no
167 // need for pending node resolutions so we'll mark this schematic as updated
168 schem->flags = SCHEM_CIDS_UPDATED;
171 schem->schemdata = schemdata;
172 schem->slice_probs = slice_probs;
177 bool get_schematic(lua_State *L, int index, Schematic *schem,
178 INodeDefManager *ndef, std::map<std::string, std::string> &replace_names)
181 index = lua_gettop(L) + 1 + index;
183 if (lua_istable(L, index)) {
184 return read_schematic(L, index, schem, ndef, replace_names);
185 } else if (lua_isstring(L, index)) {
186 const char *filename = lua_tostring(L, index);
187 return schem->loadSchematicFromFile(filename, ndef, replace_names);
194 void read_schematic_replacements(lua_State *L,
195 std::map<std::string, std::string> &replace_names, int index)
198 while (lua_next(L, index)) {
199 std::string replace_from;
200 std::string replace_to;
202 if (lua_istable(L, -1)) { // Old {{"x", "y"}, ...} format
203 lua_rawgeti(L, -1, 1);
204 replace_from = lua_tostring(L, -1);
207 lua_rawgeti(L, -1, 2);
208 replace_to = lua_tostring(L, -1);
210 } else { // New {x = "y", ...} format
211 replace_from = lua_tostring(L, -2);
212 replace_to = lua_tostring(L, -1);
215 replace_names[replace_from] = replace_to;
221 // get_mapgen_object(objectname)
222 // returns the requested object used during map generation
223 int ModApiMapgen::l_get_mapgen_object(lua_State *L)
225 const char *mgobjstr = lua_tostring(L, 1);
228 if (!string_to_enum(es_MapgenObject, mgobjint, mgobjstr ? mgobjstr : ""))
231 enum MapgenObject mgobj = (MapgenObject)mgobjint;
233 EmergeManager *emerge = getServer(L)->getEmergeManager();
234 Mapgen *mg = emerge->getCurrentMapgen();
238 size_t maplen = mg->csize.X * mg->csize.Z;
242 ManualMapVoxelManipulator *vm = mg->vm;
245 LuaVoxelManip *o = new LuaVoxelManip(vm, true);
246 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
247 luaL_getmetatable(L, "VoxelManip");
248 lua_setmetatable(L, -2);
251 push_v3s16(L, vm->m_area.MinEdge);
254 push_v3s16(L, vm->m_area.MaxEdge);
258 case MGOBJ_HEIGHTMAP: {
263 for (size_t i = 0; i != maplen; i++) {
264 lua_pushinteger(L, mg->heightmap[i]);
265 lua_rawseti(L, -2, i + 1);
270 case MGOBJ_BIOMEMAP: {
275 for (size_t i = 0; i != maplen; i++) {
276 lua_pushinteger(L, mg->biomemap[i]);
277 lua_rawseti(L, -2, i + 1);
282 case MGOBJ_HEATMAP: { // Mapgen V7 specific objects
284 if (strcmp(emerge->params.mg_name.c_str(), "v7"))
287 MapgenV7 *mgv7 = (MapgenV7 *)mg;
289 float *arr = (mgobj == MGOBJ_HEATMAP) ?
290 mgv7->noise_heat->result : mgv7->noise_humidity->result;
295 for (size_t i = 0; i != maplen; i++) {
296 lua_pushnumber(L, arr[i]);
297 lua_rawseti(L, -2, i + 1);
302 case MGOBJ_GENNOTIFY: {
303 std::map<std::string, std::vector<v3s16> >event_map;
304 std::map<std::string, std::vector<v3s16> >::iterator it;
306 mg->gennotify.getEvents(event_map);
309 for (it = event_map.begin(); it != event_map.end(); ++it) {
312 for (size_t j = 0; j != it->second.size(); j++) {
313 push_v3s16(L, it->second[j]);
314 lua_rawseti(L, -2, j + 1);
317 lua_setfield(L, -2, it->first.c_str());
327 // set_mapgen_params(params)
328 // set mapgen parameters
329 int ModApiMapgen::l_set_mapgen_params(lua_State *L)
331 if (!lua_istable(L, 1))
334 EmergeManager *emerge = getServer(L)->getEmergeManager();
338 u32 flags = 0, flagmask = 0;
340 lua_getfield(L, 1, "mgname");
341 if (lua_isstring(L, -1)) {
342 emerge->params.mg_name = std::string(lua_tostring(L, -1));
343 delete emerge->params.sparams;
344 emerge->params.sparams = NULL;
347 lua_getfield(L, 1, "seed");
348 if (lua_isnumber(L, -1))
349 emerge->params.seed = lua_tointeger(L, -1);
351 lua_getfield(L, 1, "water_level");
352 if (lua_isnumber(L, -1))
353 emerge->params.water_level = lua_tointeger(L, -1);
355 lua_getfield(L, 1, "flagmask");
356 if (lua_isstring(L, -1)) {
357 flagstr = lua_tostring(L, -1);
358 emerge->params.flags &= ~readFlagString(flagstr, flagdesc_mapgen, NULL);
359 errorstream << "set_mapgen_params(): flagmask field is deprecated, "
360 "see lua_api.txt" << std::endl;
363 if (getflagsfield(L, 1, "flags", flagdesc_mapgen, &flags, &flagmask)) {
364 emerge->params.flags &= ~flagmask;
365 emerge->params.flags |= flags;
371 // set_noiseparams(name, noiseparams, set_default)
372 // set global config values for noise parameters
373 int ModApiMapgen::l_set_noiseparams(lua_State *L)
375 const char *name = luaL_checkstring(L, 1);
378 if (!read_noiseparams(L, 2, &np))
381 bool set_default = lua_isboolean(L, 3) ? lua_toboolean(L, 3) : true;
383 g_settings->setNoiseParams(name, np, set_default);
388 // set_gen_notify(flags, {deco_id_table})
389 int ModApiMapgen::l_set_gen_notify(lua_State *L)
391 u32 flags = 0, flagmask = 0;
392 EmergeManager *emerge = getServer(L)->getEmergeManager();
394 if (read_flags(L, 1, flagdesc_gennotify, &flags, &flagmask)) {
395 emerge->gen_notify_on &= ~flagmask;
396 emerge->gen_notify_on |= flags;
399 if (lua_istable(L, 2)) {
401 while (lua_next(L, 2)) {
402 if (lua_isnumber(L, -1))
403 emerge->gen_notify_on_deco_ids.insert(lua_tonumber(L, -1));
411 // register_biome({lots of stuff})
412 int ModApiMapgen::l_register_biome(lua_State *L)
415 luaL_checktype(L, index, LUA_TTABLE);
417 INodeDefManager *ndef = getServer(L)->getNodeDefManager();
418 BiomeManager *bmgr = getServer(L)->getEmergeManager()->biomemgr;
420 enum BiomeType biometype = (BiomeType)getenumfield(L, index, "type",
421 es_BiomeTerrainType, BIOME_TYPE_NORMAL);
422 Biome *b = bmgr->create(biometype);
424 b->name = getstringfield_default(L, index, "name", "");
425 b->depth_top = getintfield_default(L, index, "depth_top", 1);
426 b->depth_filler = getintfield_default(L, index, "depth_filler", 3);
427 b->height_min = getintfield_default(L, index, "height_min", 0);
428 b->height_max = getintfield_default(L, index, "height_max", 0);
429 b->heat_point = getfloatfield_default(L, index, "heat_point", 0.);
430 b->humidity_point = getfloatfield_default(L, index, "humidity_point", 0.);
431 b->flags = 0; //reserved
433 u32 id = bmgr->add(b);
439 NodeResolveInfo *nri = new NodeResolveInfo(b);
440 std::list<std::string> &nnames = nri->nodenames;
441 nnames.push_back(getstringfield_default(L, index, "node_top", ""));
442 nnames.push_back(getstringfield_default(L, index, "node_filler", ""));
443 nnames.push_back(getstringfield_default(L, index, "node_stone", ""));
444 nnames.push_back(getstringfield_default(L, index, "node_water", ""));
445 nnames.push_back(getstringfield_default(L, index, "node_dust", ""));
446 nnames.push_back(getstringfield_default(L, index, "node_dust_water", ""));
447 ndef->pendNodeResolve(nri);
449 verbosestream << "register_biome: " << b->name << std::endl;
451 lua_pushinteger(L, id);
455 int ModApiMapgen::l_clear_registered_biomes(lua_State *L)
457 BiomeManager *bmgr = getServer(L)->getEmergeManager()->biomemgr;
462 int ModApiMapgen::l_clear_registered_decorations(lua_State *L)
464 DecorationManager *dmgr = getServer(L)->getEmergeManager()->decomgr;
469 int ModApiMapgen::l_clear_registered_ores(lua_State *L)
471 OreManager *omgr = getServer(L)->getEmergeManager()->oremgr;
476 // register_decoration({lots of stuff})
477 int ModApiMapgen::l_register_decoration(lua_State *L)
480 luaL_checktype(L, index, LUA_TTABLE);
482 INodeDefManager *ndef = getServer(L)->getNodeDefManager();
483 DecorationManager *decomgr = getServer(L)->getEmergeManager()->decomgr;
484 BiomeManager *biomemgr = getServer(L)->getEmergeManager()->biomemgr;
486 enum DecorationType decotype = (DecorationType)getenumfield(L, index,
487 "deco_type", es_DecorationType, -1);
489 Decoration *deco = decomgr->create(decotype);
491 errorstream << "register_decoration: decoration placement type "
492 << decotype << " not implemented";
496 deco->name = getstringfield_default(L, index, "name", "");
497 deco->fill_ratio = getfloatfield_default(L, index, "fill_ratio", 0.02);
498 deco->sidelen = getintfield_default(L, index, "sidelen", 8);
499 if (deco->sidelen <= 0) {
500 errorstream << "register_decoration: sidelen must be "
501 "greater than 0" << std::endl;
506 NodeResolveInfo *nri = new NodeResolveInfo(deco);
508 //// Get node name(s) to place decoration on
509 std::vector<const char *> place_on_names;
510 getstringlistfield(L, index, "place_on", place_on_names);
511 nri->nodelistinfo.push_back(NodeListInfo(place_on_names.size()));
512 for (size_t i = 0; i != place_on_names.size(); i++)
513 nri->nodenames.push_back(place_on_names[i]);
515 getflagsfield(L, index, "flags", flagdesc_deco, &deco->flags, NULL);
517 //// Get NoiseParams to define how decoration is placed
518 lua_getfield(L, index, "noise_params");
519 if (read_noiseparams(L, -1, &deco->np))
520 deco->flags |= DECO_USE_NOISE;
523 //// Get biomes associated with this decoration (if any)
524 std::vector<const char *> biome_list;
525 getstringlistfield(L, index, "biomes", biome_list);
526 for (size_t i = 0; i != biome_list.size(); i++) {
527 Biome *b = (Biome *)biomemgr->getByName(biome_list[i]);
531 deco->biomes.insert(b->id);
534 //// Handle decoration type-specific parameters
535 bool success = false;
538 success = regDecoSimple(L, nri, (DecoSimple *)deco);
541 success = regDecoSchematic(L, ndef, (DecoSchematic *)deco);
547 ndef->pendNodeResolve(nri);
554 u32 id = decomgr->add(deco);
560 verbosestream << "register_decoration: " << deco->name << std::endl;
562 lua_pushinteger(L, id);
566 bool ModApiMapgen::regDecoSimple(lua_State *L,
567 NodeResolveInfo *nri, DecoSimple *deco)
571 deco->deco_height = getintfield_default(L, index, "height", 1);
572 deco->deco_height_max = getintfield_default(L, index, "height_max", 0);
573 deco->nspawnby = getintfield_default(L, index, "num_spawn_by", -1);
575 if (deco->deco_height <= 0) {
576 errorstream << "register_decoration: simple decoration height"
577 " must be greater than 0" << std::endl;
581 std::vector<const char *> deco_names;
582 getstringlistfield(L, index, "decoration", deco_names);
583 if (deco_names.size() == 0) {
584 errorstream << "register_decoration: no decoration nodes "
585 "defined" << std::endl;
588 nri->nodelistinfo.push_back(NodeListInfo(deco_names.size()));
589 for (size_t i = 0; i != deco_names.size(); i++)
590 nri->nodenames.push_back(deco_names[i]);
592 std::vector<const char *> spawnby_names;
593 getstringlistfield(L, index, "spawn_by", spawnby_names);
594 if (deco->nspawnby != -1 && spawnby_names.size() == 0) {
595 errorstream << "register_decoration: no spawn_by nodes defined,"
596 " but num_spawn_by specified" << std::endl;
599 nri->nodelistinfo.push_back(NodeListInfo(spawnby_names.size()));
600 for (size_t i = 0; i != spawnby_names.size(); i++)
601 nri->nodenames.push_back(spawnby_names[i]);
606 bool ModApiMapgen::regDecoSchematic(lua_State *L, INodeDefManager *ndef,
611 deco->rotation = (Rotation)getenumfield(L, index, "rotation",
612 es_Rotation, ROTATE_0);
614 std::map<std::string, std::string> replace_names;
615 lua_getfield(L, index, "replacements");
616 if (lua_istable(L, -1))
617 read_schematic_replacements(L, replace_names, lua_gettop(L));
620 // TODO(hmmmm): get a ref from registered schematics
621 Schematic *schem = new Schematic;
622 lua_getfield(L, index, "schematic");
623 if (!get_schematic(L, -1, schem, ndef, replace_names)) {
630 deco->schematic = schem;
635 // register_ore({lots of stuff})
636 int ModApiMapgen::l_register_ore(lua_State *L)
639 luaL_checktype(L, index, LUA_TTABLE);
641 INodeDefManager *ndef = getServer(L)->getNodeDefManager();
642 OreManager *oremgr = getServer(L)->getEmergeManager()->oremgr;
644 enum OreType oretype = (OreType)getenumfield(L, index,
645 "ore_type", es_OreType, ORE_SCATTER);
646 Ore *ore = oremgr->create(oretype);
648 errorstream << "register_ore: ore_type " << oretype << " not implemented";
652 ore->name = getstringfield_default(L, index, "name", "");
653 ore->ore_param2 = (u8)getintfield_default(L, index, "ore_param2", 0);
654 ore->clust_scarcity = getintfield_default(L, index, "clust_scarcity", 1);
655 ore->clust_num_ores = getintfield_default(L, index, "clust_num_ores", 1);
656 ore->clust_size = getintfield_default(L, index, "clust_size", 0);
657 ore->height_min = getintfield_default(L, index, "height_min", 0);
658 ore->height_max = getintfield_default(L, index, "height_max", 0);
659 ore->nthresh = getfloatfield_default(L, index, "noise_threshhold", 0);
663 if (ore->clust_scarcity <= 0 || ore->clust_num_ores <= 0) {
664 errorstream << "register_ore: clust_scarcity and clust_num_ores"
665 "must be greater than 0" << std::endl;
670 getflagsfield(L, index, "flags", flagdesc_ore, &ore->flags, NULL);
672 lua_getfield(L, index, "noise_params");
673 if (read_noiseparams(L, -1, &ore->np)) {
674 ore->flags |= OREFLAG_USE_NOISE;
675 } else if (ore->NEEDS_NOISE) {
676 errorstream << "register_ore: specified ore type requires valid "
677 "noise parameters" << std::endl;
683 u32 id = oremgr->add(ore);
689 NodeResolveInfo *nri = new NodeResolveInfo(ore);
690 nri->nodenames.push_back(getstringfield_default(L, index, "ore", ""));
692 std::vector<const char *> wherein_names;
693 getstringlistfield(L, index, "wherein", wherein_names);
694 nri->nodelistinfo.push_back(NodeListInfo(wherein_names.size()));
695 for (size_t i = 0; i != wherein_names.size(); i++)
696 nri->nodenames.push_back(wherein_names[i]);
698 ndef->pendNodeResolve(nri);
700 verbosestream << "register_ore: " << ore->name << std::endl;
702 lua_pushinteger(L, id);
706 // create_schematic(p1, p2, probability_list, filename)
707 int ModApiMapgen::l_create_schematic(lua_State *L)
711 Map *map = &(getEnv(L)->getMap());
712 INodeDefManager *ndef = getServer(L)->getNodeDefManager();
714 v3s16 p1 = read_v3s16(L, 1);
715 v3s16 p2 = read_v3s16(L, 2);
716 sortBoxVerticies(p1, p2);
718 std::vector<std::pair<v3s16, u8> > prob_list;
719 if (lua_istable(L, 3)) {
721 while (lua_next(L, 3)) {
722 if (lua_istable(L, -1)) {
723 lua_getfield(L, -1, "pos");
724 v3s16 pos = read_v3s16(L, -1);
727 u8 prob = getintfield_default(L, -1, "prob", MTSCHEM_PROB_ALWAYS);
728 prob_list.push_back(std::make_pair(pos, prob));
735 std::vector<std::pair<s16, u8> > slice_prob_list;
736 if (lua_istable(L, 5)) {
738 while (lua_next(L, 5)) {
739 if (lua_istable(L, -1)) {
740 s16 ypos = getintfield_default(L, -1, "ypos", 0);
741 u8 prob = getintfield_default(L, -1, "prob", MTSCHEM_PROB_ALWAYS);
742 slice_prob_list.push_back(std::make_pair(ypos, prob));
749 const char *filename = luaL_checkstring(L, 4);
751 if (!schem.getSchematicFromMap(map, p1, p2)) {
752 errorstream << "create_schematic: failed to get schematic "
753 "from map" << std::endl;
757 schem.applyProbabilities(p1, &prob_list, &slice_prob_list);
759 schem.saveSchematicToFile(filename, ndef);
760 actionstream << "create_schematic: saved schematic file '"
761 << filename << "'." << std::endl;
766 // place_schematic(p, schematic, rotation, replacement)
767 int ModApiMapgen::l_place_schematic(lua_State *L)
771 Map *map = &(getEnv(L)->getMap());
772 INodeDefManager *ndef = getServer(L)->getNodeDefManager();
775 v3s16 p = read_v3s16(L, 1);
779 if (lua_isstring(L, 3))
780 string_to_enum(es_Rotation, rot, std::string(lua_tostring(L, 3)));
782 //// Read force placement
783 bool force_placement = true;
784 if (lua_isboolean(L, 5))
785 force_placement = lua_toboolean(L, 5);
787 //// Read node replacements
788 std::map<std::string, std::string> replace_names;
789 if (lua_istable(L, 4))
790 read_schematic_replacements(L, replace_names, 4);
793 if (!get_schematic(L, 2, &schem, ndef, replace_names)) {
794 errorstream << "place_schematic: failed to get schematic" << std::endl;
798 schem.placeStructure(map, p, 0, (Rotation)rot, force_placement, ndef);
803 void ModApiMapgen::Initialize(lua_State *L, int top)
805 API_FCT(get_mapgen_object);
807 API_FCT(set_mapgen_params);
808 API_FCT(set_noiseparams);
809 API_FCT(set_gen_notify);
811 API_FCT(register_biome);
812 API_FCT(register_decoration);
813 API_FCT(register_ore);
815 API_FCT(clear_registered_biomes);
816 API_FCT(clear_registered_decorations);
817 API_FCT(clear_registered_ores);
819 API_FCT(create_schematic);
820 API_FCT(place_schematic);