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 "cpp_api/s_security.h"
26 #include "util/serialize.h"
28 #include "environment.h"
32 #include "mg_decoration.h"
33 #include "mg_schematic.h"
34 #include "mapgen_v5.h"
35 #include "mapgen_v7.h"
40 struct EnumString ModApiMapgen::es_BiomeTerrainType[] =
42 {BIOMETYPE_NORMAL, "normal"},
43 {BIOMETYPE_LIQUID, "liquid"},
44 {BIOMETYPE_NETHER, "nether"},
45 {BIOMETYPE_AETHER, "aether"},
46 {BIOMETYPE_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"},
79 struct EnumString ModApiMapgen::es_Rotation[] =
85 {ROTATE_RAND, "random"},
89 struct EnumString ModApiMapgen::es_SchematicFormatType[] =
91 {SCHEM_FMT_HANDLE, "handle"},
92 {SCHEM_FMT_MTS, "mts"},
93 {SCHEM_FMT_LUA, "lua"},
97 ObjDef *get_objdef(lua_State *L, int index, ObjDefManager *objmgr);
99 Biome *get_or_load_biome(lua_State *L, int index,
100 BiomeManager *biomemgr);
101 Biome *read_biome_def(lua_State *L, int index, INodeDefManager *ndef);
102 size_t get_biome_list(lua_State *L, int index,
103 BiomeManager *biomemgr, UNORDERED_SET<u8> *biome_id_list);
105 Schematic *get_or_load_schematic(lua_State *L, int index,
106 SchematicManager *schemmgr, StringMap *replace_names);
107 Schematic *load_schematic(lua_State *L, int index, INodeDefManager *ndef,
108 StringMap *replace_names);
109 Schematic *load_schematic_from_def(lua_State *L, int index,
110 INodeDefManager *ndef, StringMap *replace_names);
111 bool read_schematic_def(lua_State *L, int index,
112 Schematic *schem, std::vector<std::string> *names);
114 bool read_deco_simple(lua_State *L, DecoSimple *deco);
115 bool read_deco_schematic(lua_State *L, SchematicManager *schemmgr, DecoSchematic *deco);
118 ///////////////////////////////////////////////////////////////////////////////
120 ObjDef *get_objdef(lua_State *L, int index, ObjDefManager *objmgr)
123 index = lua_gettop(L) + 1 + index;
125 // If a number, assume this is a handle to an object def
126 if (lua_isnumber(L, index))
127 return objmgr->get(lua_tointeger(L, index));
129 // If a string, assume a name is given instead
130 if (lua_isstring(L, index))
131 return objmgr->getByName(lua_tostring(L, index));
136 ///////////////////////////////////////////////////////////////////////////////
138 Schematic *get_or_load_schematic(lua_State *L, int index,
139 SchematicManager *schemmgr, StringMap *replace_names)
142 index = lua_gettop(L) + 1 + index;
144 Schematic *schem = (Schematic *)get_objdef(L, index, schemmgr);
148 schem = load_schematic(L, index, schemmgr->getNodeDef(),
153 if (schemmgr->add(schem) == OBJDEF_INVALID_HANDLE) {
162 Schematic *load_schematic(lua_State *L, int index, INodeDefManager *ndef,
163 StringMap *replace_names)
166 index = lua_gettop(L) + 1 + index;
168 Schematic *schem = NULL;
170 if (lua_istable(L, index)) {
171 schem = load_schematic_from_def(L, index, ndef,
177 } else if (lua_isnumber(L, index)) {
179 } else if (lua_isstring(L, index)) {
180 schem = SchematicManager::create(SCHEMATIC_NORMAL);
182 std::string filepath = lua_tostring(L, index);
183 if (!fs::IsPathAbsolute(filepath))
184 filepath = ModApiBase::getCurrentModPath(L) + DIR_DELIM + filepath;
186 if (!schem->loadSchematicFromFile(filepath, ndef,
197 Schematic *load_schematic_from_def(lua_State *L, int index,
198 INodeDefManager *ndef, StringMap *replace_names)
200 Schematic *schem = SchematicManager::create(SCHEMATIC_NORMAL);
202 if (!read_schematic_def(L, index, schem, &schem->m_nodenames)) {
207 size_t num_nodes = schem->m_nodenames.size();
209 schem->m_nnlistsizes.push_back(num_nodes);
212 for (size_t i = 0; i != num_nodes; i++) {
213 StringMap::iterator it = replace_names->find(schem->m_nodenames[i]);
214 if (it != replace_names->end())
215 schem->m_nodenames[i] = it->second;
220 ndef->pendNodeResolve(schem);
226 bool read_schematic_def(lua_State *L, int index,
227 Schematic *schem, std::vector<std::string> *names)
229 if (!lua_istable(L, index))
232 //// Get schematic size
233 lua_getfield(L, index, "size");
234 v3s16 size = check_v3s16(L, -1);
239 //// Get schematic data
240 lua_getfield(L, index, "data");
241 luaL_checktype(L, -1, LUA_TTABLE);
243 u32 numnodes = size.X * size.Y * size.Z;
244 schem->schemdata = new MapNode[numnodes];
246 size_t names_base = names->size();
247 UNORDERED_MAP<std::string, content_t> name_id_map;
250 for (lua_pushnil(L); lua_next(L, -2); i++, lua_pop(L, 1)) {
256 if (!getstringfield(L, -1, "name", name))
257 throw LuaError("Schematic data definition with missing name field");
259 //// Read param1/prob
261 if (!getintfield(L, -1, "param1", param1) &&
262 !getintfield(L, -1, "prob", param1))
263 param1 = MTSCHEM_PROB_ALWAYS_OLD;
266 u8 param2 = getintfield_default(L, -1, "param2", 0);
268 //// Find or add new nodename-to-ID mapping
269 UNORDERED_MAP<std::string, content_t>::iterator it = name_id_map.find(name);
270 content_t name_index;
271 if (it != name_id_map.end()) {
272 name_index = it->second;
274 name_index = names->size() - names_base;
275 name_id_map[name] = name_index;
276 names->push_back(name);
279 //// Perform probability/force_place fixup on param1
281 if (getboolfield_default(L, -1, "force_place", false))
282 param1 |= MTSCHEM_FORCE_PLACE;
284 //// Actually set the node in the schematic
285 schem->schemdata[i] = MapNode(name_index, param1, param2);
289 errorstream << "read_schematic_def: incorrect number of "
290 "nodes provided in raw schematic data (got " << i <<
291 ", expected " << numnodes << ")." << std::endl;
295 //// Get Y-slice probability values (if present)
296 schem->slice_probs = new u8[size.Y];
297 for (i = 0; i != (u32) size.Y; i++)
298 schem->slice_probs[i] = MTSCHEM_PROB_ALWAYS;
300 lua_getfield(L, index, "yslice_prob");
301 if (lua_istable(L, -1)) {
302 for (lua_pushnil(L); lua_next(L, -2); lua_pop(L, 1)) {
304 if (!getintfield(L, -1, "ypos", ypos) || (ypos >= size.Y) ||
305 !getintfield(L, -1, "prob", schem->slice_probs[ypos]))
308 schem->slice_probs[ypos] >>= 1;
316 void read_schematic_replacements(lua_State *L, int index, StringMap *replace_names)
319 index = lua_gettop(L) + 1 + index;
322 while (lua_next(L, index)) {
323 std::string replace_from;
324 std::string replace_to;
326 if (lua_istable(L, -1)) { // Old {{"x", "y"}, ...} format
327 lua_rawgeti(L, -1, 1);
328 replace_from = lua_tostring(L, -1);
331 lua_rawgeti(L, -1, 2);
332 replace_to = lua_tostring(L, -1);
334 } else { // New {x = "y", ...} format
335 replace_from = lua_tostring(L, -2);
336 replace_to = lua_tostring(L, -1);
339 replace_names->insert(std::make_pair(replace_from, replace_to));
344 ///////////////////////////////////////////////////////////////////////////////
346 Biome *get_or_load_biome(lua_State *L, int index, BiomeManager *biomemgr)
349 index = lua_gettop(L) + 1 + index;
351 Biome *biome = (Biome *)get_objdef(L, index, biomemgr);
355 biome = read_biome_def(L, index, biomemgr->getNodeDef());
359 if (biomemgr->add(biome) == OBJDEF_INVALID_HANDLE) {
368 Biome *read_biome_def(lua_State *L, int index, INodeDefManager *ndef)
370 if (!lua_istable(L, index))
373 BiomeType biometype = (BiomeType)getenumfield(L, index, "type",
374 ModApiMapgen::es_BiomeTerrainType, BIOMETYPE_NORMAL);
375 Biome *b = BiomeManager::create(biometype);
377 b->name = getstringfield_default(L, index, "name", "");
378 b->depth_top = getintfield_default(L, index, "depth_top", 0);
379 b->depth_filler = getintfield_default(L, index, "depth_filler", -31000);
380 b->depth_water_top = getintfield_default(L, index, "depth_water_top", 0);
381 b->depth_riverbed = getintfield_default(L, index, "depth_riverbed", 0);
382 b->y_min = getintfield_default(L, index, "y_min", -31000);
383 b->y_max = getintfield_default(L, index, "y_max", 31000);
384 b->heat_point = getfloatfield_default(L, index, "heat_point", 0.f);
385 b->humidity_point = getfloatfield_default(L, index, "humidity_point", 0.f);
386 b->flags = 0; //reserved
388 std::vector<std::string> &nn = b->m_nodenames;
389 nn.push_back(getstringfield_default(L, index, "node_top", ""));
390 nn.push_back(getstringfield_default(L, index, "node_filler", ""));
391 nn.push_back(getstringfield_default(L, index, "node_stone", ""));
392 nn.push_back(getstringfield_default(L, index, "node_water_top", ""));
393 nn.push_back(getstringfield_default(L, index, "node_water", ""));
394 nn.push_back(getstringfield_default(L, index, "node_river_water", ""));
395 nn.push_back(getstringfield_default(L, index, "node_riverbed", ""));
396 nn.push_back(getstringfield_default(L, index, "node_dust", ""));
397 ndef->pendNodeResolve(b);
403 size_t get_biome_list(lua_State *L, int index,
404 BiomeManager *biomemgr, UNORDERED_SET<u8> *biome_id_list)
407 index = lua_gettop(L) + 1 + index;
409 if (lua_isnil(L, index))
412 bool is_single = true;
413 if (lua_istable(L, index)) {
414 lua_getfield(L, index, "name");
415 is_single = !lua_isnil(L, -1);
420 Biome *biome = get_or_load_biome(L, index, biomemgr);
422 errorstream << "get_biome_list: failed to get biome '"
423 << (lua_isstring(L, index) ? lua_tostring(L, index) : "")
424 << "'." << std::endl;
428 biome_id_list->insert(biome->index);
432 // returns number of failed resolutions
433 size_t fail_count = 0;
436 for (lua_pushnil(L); lua_next(L, index); lua_pop(L, 1)) {
438 Biome *biome = get_or_load_biome(L, -1, biomemgr);
441 errorstream << "get_biome_list: failed to get biome '"
442 << (lua_isstring(L, -1) ? lua_tostring(L, -1) : "")
447 biome_id_list->insert(biome->index);
453 ///////////////////////////////////////////////////////////////////////////////
455 // get_biome_id(biomename)
456 // returns the biome id used in biomemap
457 int ModApiMapgen::l_get_biome_id(lua_State *L)
459 NO_MAP_LOCK_REQUIRED;
461 const char *biome_str = lua_tostring(L, 1);
465 BiomeManager *bmgr = getServer(L)->getEmergeManager()->biomemgr;
470 Biome *biome = (Biome *)bmgr->getByName(biome_str);
472 if (!biome || biome->index == OBJDEF_INVALID_INDEX)
475 lua_pushinteger(L, biome->index);
481 // get_mapgen_object(objectname)
482 // returns the requested object used during map generation
483 int ModApiMapgen::l_get_mapgen_object(lua_State *L)
485 NO_MAP_LOCK_REQUIRED;
487 const char *mgobjstr = lua_tostring(L, 1);
490 if (!string_to_enum(es_MapgenObject, mgobjint, mgobjstr ? mgobjstr : ""))
493 enum MapgenObject mgobj = (MapgenObject)mgobjint;
495 EmergeManager *emerge = getServer(L)->getEmergeManager();
496 Mapgen *mg = emerge->getCurrentMapgen();
498 throw LuaError("Must only be called in a mapgen thread!");
500 size_t maplen = mg->csize.X * mg->csize.Z;
504 MMVManip *vm = mg->vm;
507 LuaVoxelManip *o = new LuaVoxelManip(vm, true);
508 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
509 luaL_getmetatable(L, "VoxelManip");
510 lua_setmetatable(L, -2);
513 push_v3s16(L, vm->m_area.MinEdge);
516 push_v3s16(L, vm->m_area.MaxEdge);
520 case MGOBJ_HEIGHTMAP: {
525 for (size_t i = 0; i != maplen; i++) {
526 lua_pushinteger(L, mg->heightmap[i]);
527 lua_rawseti(L, -2, i + 1);
532 case MGOBJ_BIOMEMAP: {
537 for (size_t i = 0; i != maplen; i++) {
538 lua_pushinteger(L, mg->biomegen->biomemap[i]);
539 lua_rawseti(L, -2, i + 1);
544 case MGOBJ_HEATMAP: {
545 if (!mg->biomegen || mg->biomegen->getType() != BIOMEGEN_ORIGINAL)
548 BiomeGenOriginal *bg = (BiomeGenOriginal *)mg->biomegen;
551 for (size_t i = 0; i != maplen; i++) {
552 lua_pushnumber(L, bg->heatmap[i]);
553 lua_rawseti(L, -2, i + 1);
559 case MGOBJ_HUMIDMAP: {
560 if (!mg->biomegen || mg->biomegen->getType() != BIOMEGEN_ORIGINAL)
563 BiomeGenOriginal *bg = (BiomeGenOriginal *)mg->biomegen;
566 for (size_t i = 0; i != maplen; i++) {
567 lua_pushnumber(L, bg->humidmap[i]);
568 lua_rawseti(L, -2, i + 1);
573 case MGOBJ_GENNOTIFY: {
574 std::map<std::string, std::vector<v3s16> >event_map;
575 std::map<std::string, std::vector<v3s16> >::iterator it;
577 mg->gennotify.getEvents(event_map);
580 for (it = event_map.begin(); it != event_map.end(); ++it) {
583 for (size_t j = 0; j != it->second.size(); j++) {
584 push_v3s16(L, it->second[j]);
585 lua_rawseti(L, -2, j + 1);
588 lua_setfield(L, -2, it->first.c_str());
599 int ModApiMapgen::l_get_mapgen_params(lua_State *L)
601 NO_MAP_LOCK_REQUIRED;
603 log_deprecated(L, "get_mapgen_params is deprecated; "
604 "use get_mapgen_setting instead");
608 MapSettingsManager *settingsmgr =
609 getServer(L)->getEmergeManager()->map_settings_mgr;
613 settingsmgr->getMapSetting("mg_name", &value);
614 lua_pushstring(L, value.c_str());
615 lua_setfield(L, -2, "mgname");
617 settingsmgr->getMapSetting("seed", &value);
618 std::istringstream ss(value);
621 lua_pushinteger(L, seed);
622 lua_setfield(L, -2, "seed");
624 settingsmgr->getMapSetting("water_level", &value);
625 lua_pushinteger(L, stoi(value, -32768, 32767));
626 lua_setfield(L, -2, "water_level");
628 settingsmgr->getMapSetting("chunksize", &value);
629 lua_pushinteger(L, stoi(value, -32768, 32767));
630 lua_setfield(L, -2, "chunksize");
632 settingsmgr->getMapSetting("mg_flags", &value);
633 lua_pushstring(L, value.c_str());
634 lua_setfield(L, -2, "flags");
640 // set_mapgen_params(params)
641 // set mapgen parameters
642 int ModApiMapgen::l_set_mapgen_params(lua_State *L)
644 NO_MAP_LOCK_REQUIRED;
646 log_deprecated(L, "set_mapgen_params is deprecated; "
647 "use set_mapgen_setting instead");
649 if (!lua_istable(L, 1))
652 MapSettingsManager *settingsmgr =
653 getServer(L)->getEmergeManager()->map_settings_mgr;
655 lua_getfield(L, 1, "mgname");
656 if (lua_isstring(L, -1))
657 settingsmgr->setMapSetting("mg_name", lua_tostring(L, -1), true);
659 lua_getfield(L, 1, "seed");
660 if (lua_isnumber(L, -1))
661 settingsmgr->setMapSetting("seed", lua_tostring(L, -1), true);
663 lua_getfield(L, 1, "water_level");
664 if (lua_isnumber(L, -1))
665 settingsmgr->setMapSetting("water_level", lua_tostring(L, -1), true);
667 lua_getfield(L, 1, "chunksize");
668 if (lua_isnumber(L, -1))
669 settingsmgr->setMapSetting("chunksize", lua_tostring(L, -1), true);
671 warn_if_field_exists(L, 1, "flagmask",
672 "Deprecated: flags field now includes unset flags.");
674 lua_getfield(L, 1, "flags");
675 if (lua_isstring(L, -1))
676 settingsmgr->setMapSetting("mg_flags", lua_tostring(L, -1), true);
681 // get_mapgen_setting(name)
682 int ModApiMapgen::l_get_mapgen_setting(lua_State *L)
684 NO_MAP_LOCK_REQUIRED;
687 MapSettingsManager *settingsmgr =
688 getServer(L)->getEmergeManager()->map_settings_mgr;
690 const char *name = luaL_checkstring(L, 1);
691 if (!settingsmgr->getMapSetting(name, &value))
694 lua_pushstring(L, value.c_str());
698 // get_mapgen_setting_noiseparams(name)
699 int ModApiMapgen::l_get_mapgen_setting_noiseparams(lua_State *L)
701 NO_MAP_LOCK_REQUIRED;
704 MapSettingsManager *settingsmgr =
705 getServer(L)->getEmergeManager()->map_settings_mgr;
707 const char *name = luaL_checkstring(L, 1);
708 if (!settingsmgr->getMapSettingNoiseParams(name, &np))
711 push_noiseparams(L, &np);
715 // set_mapgen_setting(name, value, override_meta)
716 // set mapgen config values
717 int ModApiMapgen::l_set_mapgen_setting(lua_State *L)
719 NO_MAP_LOCK_REQUIRED;
721 MapSettingsManager *settingsmgr =
722 getServer(L)->getEmergeManager()->map_settings_mgr;
724 const char *name = luaL_checkstring(L, 1);
725 const char *value = luaL_checkstring(L, 2);
726 bool override_meta = lua_isboolean(L, 3) ? lua_toboolean(L, 3) : false;
728 if (!settingsmgr->setMapSetting(name, value, override_meta)) {
729 errorstream << "set_mapgen_setting: cannot set '"
730 << name << "' after initialization" << std::endl;
737 // set_mapgen_setting_noiseparams(name, noiseparams, set_default)
738 // set mapgen config values for noise parameters
739 int ModApiMapgen::l_set_mapgen_setting_noiseparams(lua_State *L)
741 NO_MAP_LOCK_REQUIRED;
743 MapSettingsManager *settingsmgr =
744 getServer(L)->getEmergeManager()->map_settings_mgr;
746 const char *name = luaL_checkstring(L, 1);
749 if (!read_noiseparams(L, 2, &np)) {
750 errorstream << "set_mapgen_setting_noiseparams: cannot set '" << name
751 << "'; invalid noiseparams table" << std::endl;
755 bool override_meta = lua_isboolean(L, 3) ? lua_toboolean(L, 3) : false;
757 if (!settingsmgr->setMapSettingNoiseParams(name, &np, override_meta)) {
758 errorstream << "set_mapgen_setting_noiseparams: cannot set '"
759 << name << "' after initialization" << std::endl;
766 // set_noiseparams(name, noiseparams, set_default)
767 // set global config values for noise parameters
768 int ModApiMapgen::l_set_noiseparams(lua_State *L)
770 NO_MAP_LOCK_REQUIRED;
772 const char *name = luaL_checkstring(L, 1);
775 if (!read_noiseparams(L, 2, &np)) {
776 errorstream << "set_noiseparams: cannot set '" << name
777 << "'; invalid noiseparams table" << std::endl;
781 bool set_default = lua_isboolean(L, 3) ? lua_toboolean(L, 3) : true;
783 g_settings->setNoiseParams(name, np, set_default);
789 // get_noiseparams(name)
790 int ModApiMapgen::l_get_noiseparams(lua_State *L)
792 NO_MAP_LOCK_REQUIRED;
794 std::string name = luaL_checkstring(L, 1);
797 if (!g_settings->getNoiseParams(name, np))
800 push_noiseparams(L, &np);
805 // set_gen_notify(flags, {deco_id_table})
806 int ModApiMapgen::l_set_gen_notify(lua_State *L)
808 NO_MAP_LOCK_REQUIRED;
810 u32 flags = 0, flagmask = 0;
811 EmergeManager *emerge = getServer(L)->getEmergeManager();
813 if (read_flags(L, 1, flagdesc_gennotify, &flags, &flagmask)) {
814 emerge->gen_notify_on &= ~flagmask;
815 emerge->gen_notify_on |= flags;
818 if (lua_istable(L, 2)) {
820 while (lua_next(L, 2)) {
821 if (lua_isnumber(L, -1))
822 emerge->gen_notify_on_deco_ids.insert((u32)lua_tonumber(L, -1));
832 int ModApiMapgen::l_get_gen_notify(lua_State *L)
834 NO_MAP_LOCK_REQUIRED;
836 EmergeManager *emerge = getServer(L)->getEmergeManager();
837 push_flags_string(L, flagdesc_gennotify, emerge->gen_notify_on,
838 emerge->gen_notify_on);
842 for (std::set<u32>::iterator it = emerge->gen_notify_on_deco_ids.begin();
843 it != emerge->gen_notify_on_deco_ids.end(); ++it) {
844 lua_pushnumber(L, *it);
845 lua_rawseti(L, -2, i);
852 // register_biome({lots of stuff})
853 int ModApiMapgen::l_register_biome(lua_State *L)
855 NO_MAP_LOCK_REQUIRED;
858 luaL_checktype(L, index, LUA_TTABLE);
860 INodeDefManager *ndef = getServer(L)->getNodeDefManager();
861 BiomeManager *bmgr = getServer(L)->getEmergeManager()->biomemgr;
863 Biome *biome = read_biome_def(L, index, ndef);
867 ObjDefHandle handle = bmgr->add(biome);
868 if (handle == OBJDEF_INVALID_HANDLE) {
873 lua_pushinteger(L, handle);
878 // register_decoration({lots of stuff})
879 int ModApiMapgen::l_register_decoration(lua_State *L)
881 NO_MAP_LOCK_REQUIRED;
884 luaL_checktype(L, index, LUA_TTABLE);
886 INodeDefManager *ndef = getServer(L)->getNodeDefManager();
887 DecorationManager *decomgr = getServer(L)->getEmergeManager()->decomgr;
888 BiomeManager *biomemgr = getServer(L)->getEmergeManager()->biomemgr;
889 SchematicManager *schemmgr = getServer(L)->getEmergeManager()->schemmgr;
891 enum DecorationType decotype = (DecorationType)getenumfield(L, index,
892 "deco_type", es_DecorationType, -1);
894 Decoration *deco = decomgr->create(decotype);
896 errorstream << "register_decoration: decoration placement type "
897 << decotype << " not implemented" << std::endl;
901 deco->name = getstringfield_default(L, index, "name", "");
902 deco->fill_ratio = getfloatfield_default(L, index, "fill_ratio", 0.02);
903 deco->y_min = getintfield_default(L, index, "y_min", -31000);
904 deco->y_max = getintfield_default(L, index, "y_max", 31000);
905 deco->nspawnby = getintfield_default(L, index, "num_spawn_by", -1);
906 deco->sidelen = getintfield_default(L, index, "sidelen", 8);
907 if (deco->sidelen <= 0) {
908 errorstream << "register_decoration: sidelen must be "
909 "greater than 0" << std::endl;
914 //// Get node name(s) to place decoration on
915 size_t nread = getstringlistfield(L, index, "place_on", &deco->m_nodenames);
916 deco->m_nnlistsizes.push_back(nread);
918 //// Get decoration flags
919 getflagsfield(L, index, "flags", flagdesc_deco, &deco->flags, NULL);
921 //// Get NoiseParams to define how decoration is placed
922 lua_getfield(L, index, "noise_params");
923 if (read_noiseparams(L, -1, &deco->np))
924 deco->flags |= DECO_USE_NOISE;
927 //// Get biomes associated with this decoration (if any)
928 lua_getfield(L, index, "biomes");
929 if (get_biome_list(L, -1, biomemgr, &deco->biomes))
930 errorstream << "register_decoration: couldn't get all biomes " << std::endl;
933 //// Get node name(s) to 'spawn by'
934 size_t nnames = getstringlistfield(L, index, "spawn_by", &deco->m_nodenames);
935 deco->m_nnlistsizes.push_back(nnames);
936 if (nnames == 0 && deco->nspawnby != -1) {
937 errorstream << "register_decoration: no spawn_by nodes defined,"
938 " but num_spawn_by specified" << std::endl;
941 //// Handle decoration type-specific parameters
942 bool success = false;
945 success = read_deco_simple(L, (DecoSimple *)deco);
948 success = read_deco_schematic(L, schemmgr, (DecoSchematic *)deco);
959 ndef->pendNodeResolve(deco);
961 ObjDefHandle handle = decomgr->add(deco);
962 if (handle == OBJDEF_INVALID_HANDLE) {
967 lua_pushinteger(L, handle);
972 bool read_deco_simple(lua_State *L, DecoSimple *deco)
976 deco->deco_height = getintfield_default(L, index, "height", 1);
977 deco->deco_height_max = getintfield_default(L, index, "height_max", 0);
979 if (deco->deco_height <= 0) {
980 errorstream << "register_decoration: simple decoration height"
981 " must be greater than 0" << std::endl;
985 size_t nnames = getstringlistfield(L, index, "decoration", &deco->m_nodenames);
986 deco->m_nnlistsizes.push_back(nnames);
988 errorstream << "register_decoration: no decoration nodes "
989 "defined" << std::endl;
997 bool read_deco_schematic(lua_State *L, SchematicManager *schemmgr, DecoSchematic *deco)
1001 deco->rotation = (Rotation)getenumfield(L, index, "rotation",
1002 ModApiMapgen::es_Rotation, ROTATE_0);
1004 StringMap replace_names;
1005 lua_getfield(L, index, "replacements");
1006 if (lua_istable(L, -1))
1007 read_schematic_replacements(L, -1, &replace_names);
1010 lua_getfield(L, index, "schematic");
1011 Schematic *schem = get_or_load_schematic(L, -1, schemmgr, &replace_names);
1014 deco->schematic = schem;
1015 return schem != NULL;
1019 // register_ore({lots of stuff})
1020 int ModApiMapgen::l_register_ore(lua_State *L)
1022 NO_MAP_LOCK_REQUIRED;
1025 luaL_checktype(L, index, LUA_TTABLE);
1027 INodeDefManager *ndef = getServer(L)->getNodeDefManager();
1028 BiomeManager *bmgr = getServer(L)->getEmergeManager()->biomemgr;
1029 OreManager *oremgr = getServer(L)->getEmergeManager()->oremgr;
1031 enum OreType oretype = (OreType)getenumfield(L, index,
1032 "ore_type", es_OreType, ORE_SCATTER);
1033 Ore *ore = oremgr->create(oretype);
1035 errorstream << "register_ore: ore_type " << oretype << " not implemented\n";
1039 ore->name = getstringfield_default(L, index, "name", "");
1040 ore->ore_param2 = (u8)getintfield_default(L, index, "ore_param2", 0);
1041 ore->clust_scarcity = getintfield_default(L, index, "clust_scarcity", 1);
1042 ore->clust_num_ores = getintfield_default(L, index, "clust_num_ores", 1);
1043 ore->clust_size = getintfield_default(L, index, "clust_size", 0);
1047 //// Get noise_threshold
1048 warn_if_field_exists(L, index, "noise_threshhold",
1049 "Deprecated: new name is \"noise_threshold\".");
1052 if (!getfloatfield(L, index, "noise_threshold", nthresh) &&
1053 !getfloatfield(L, index, "noise_threshhold", nthresh))
1055 ore->nthresh = nthresh;
1057 //// Get y_min/y_max
1058 warn_if_field_exists(L, index, "height_min",
1059 "Deprecated: new name is \"y_min\".");
1060 warn_if_field_exists(L, index, "height_max",
1061 "Deprecated: new name is \"y_max\".");
1064 if (!getintfield(L, index, "y_min", ymin) &&
1065 !getintfield(L, index, "height_min", ymin))
1067 if (!getintfield(L, index, "y_max", ymax) &&
1068 !getintfield(L, index, "height_max", ymax))
1073 if (ore->clust_scarcity <= 0 || ore->clust_num_ores <= 0) {
1074 errorstream << "register_ore: clust_scarcity and clust_num_ores"
1075 "must be greater than 0" << std::endl;
1081 getflagsfield(L, index, "flags", flagdesc_ore, &ore->flags, NULL);
1083 //// Get biomes associated with this decoration (if any)
1084 lua_getfield(L, index, "biomes");
1085 if (get_biome_list(L, -1, bmgr, &ore->biomes))
1086 errorstream << "register_ore: couldn't get all biomes " << std::endl;
1089 //// Get noise parameters if needed
1090 lua_getfield(L, index, "noise_params");
1091 if (read_noiseparams(L, -1, &ore->np)) {
1092 ore->flags |= OREFLAG_USE_NOISE;
1093 } else if (ore->NEEDS_NOISE) {
1094 errorstream << "register_ore: specified ore type requires valid "
1095 "noise parameters" << std::endl;
1101 //// Get type-specific parameters
1104 OreSheet *oresheet = (OreSheet *)ore;
1106 oresheet->column_height_min = getintfield_default(L, index,
1107 "column_height_min", 1);
1108 oresheet->column_height_max = getintfield_default(L, index,
1109 "column_height_max", ore->clust_size);
1110 oresheet->column_midpoint_factor = getfloatfield_default(L, index,
1111 "column_midpoint_factor", 0.5f);
1116 OrePuff *orepuff = (OrePuff *)ore;
1118 lua_getfield(L, index, "np_puff_top");
1119 read_noiseparams(L, -1, &orepuff->np_puff_top);
1122 lua_getfield(L, index, "np_puff_bottom");
1123 read_noiseparams(L, -1, &orepuff->np_puff_bottom);
1129 OreVein *orevein = (OreVein *)ore;
1131 orevein->random_factor = getfloatfield_default(L, index,
1132 "random_factor", 1.f);
1140 ObjDefHandle handle = oremgr->add(ore);
1141 if (handle == OBJDEF_INVALID_HANDLE) {
1146 ore->m_nodenames.push_back(getstringfield_default(L, index, "ore", ""));
1148 size_t nnames = getstringlistfield(L, index, "wherein", &ore->m_nodenames);
1149 ore->m_nnlistsizes.push_back(nnames);
1151 ndef->pendNodeResolve(ore);
1153 lua_pushinteger(L, handle);
1158 // register_schematic({schematic}, replacements={})
1159 int ModApiMapgen::l_register_schematic(lua_State *L)
1161 NO_MAP_LOCK_REQUIRED;
1163 SchematicManager *schemmgr = getServer(L)->getEmergeManager()->schemmgr;
1165 StringMap replace_names;
1166 if (lua_istable(L, 2))
1167 read_schematic_replacements(L, 2, &replace_names);
1169 Schematic *schem = load_schematic(L, 1, schemmgr->getNodeDef(),
1174 ObjDefHandle handle = schemmgr->add(schem);
1175 if (handle == OBJDEF_INVALID_HANDLE) {
1180 lua_pushinteger(L, handle);
1185 // clear_registered_biomes()
1186 int ModApiMapgen::l_clear_registered_biomes(lua_State *L)
1188 NO_MAP_LOCK_REQUIRED;
1190 BiomeManager *bmgr = getServer(L)->getEmergeManager()->biomemgr;
1196 // clear_registered_decorations()
1197 int ModApiMapgen::l_clear_registered_decorations(lua_State *L)
1199 NO_MAP_LOCK_REQUIRED;
1201 DecorationManager *dmgr = getServer(L)->getEmergeManager()->decomgr;
1207 // clear_registered_ores()
1208 int ModApiMapgen::l_clear_registered_ores(lua_State *L)
1210 NO_MAP_LOCK_REQUIRED;
1212 OreManager *omgr = getServer(L)->getEmergeManager()->oremgr;
1218 // clear_registered_schematics()
1219 int ModApiMapgen::l_clear_registered_schematics(lua_State *L)
1221 NO_MAP_LOCK_REQUIRED;
1223 SchematicManager *smgr = getServer(L)->getEmergeManager()->schemmgr;
1229 // generate_ores(vm, p1, p2, [ore_id])
1230 int ModApiMapgen::l_generate_ores(lua_State *L)
1232 NO_MAP_LOCK_REQUIRED;
1234 EmergeManager *emerge = getServer(L)->getEmergeManager();
1237 mg.seed = emerge->mgparams->seed;
1238 mg.vm = LuaVoxelManip::checkobject(L, 1)->vm;
1239 mg.ndef = getServer(L)->getNodeDefManager();
1241 v3s16 pmin = lua_istable(L, 2) ? check_v3s16(L, 2) :
1242 mg.vm->m_area.MinEdge + v3s16(1,1,1) * MAP_BLOCKSIZE;
1243 v3s16 pmax = lua_istable(L, 3) ? check_v3s16(L, 3) :
1244 mg.vm->m_area.MaxEdge - v3s16(1,1,1) * MAP_BLOCKSIZE;
1245 sortBoxVerticies(pmin, pmax);
1247 u32 blockseed = Mapgen::getBlockSeed(pmin, mg.seed);
1249 emerge->oremgr->placeAllOres(&mg, blockseed, pmin, pmax);
1255 // generate_decorations(vm, p1, p2, [deco_id])
1256 int ModApiMapgen::l_generate_decorations(lua_State *L)
1258 NO_MAP_LOCK_REQUIRED;
1260 EmergeManager *emerge = getServer(L)->getEmergeManager();
1263 mg.seed = emerge->mgparams->seed;
1264 mg.vm = LuaVoxelManip::checkobject(L, 1)->vm;
1265 mg.ndef = getServer(L)->getNodeDefManager();
1267 v3s16 pmin = lua_istable(L, 2) ? check_v3s16(L, 2) :
1268 mg.vm->m_area.MinEdge + v3s16(1,1,1) * MAP_BLOCKSIZE;
1269 v3s16 pmax = lua_istable(L, 3) ? check_v3s16(L, 3) :
1270 mg.vm->m_area.MaxEdge - v3s16(1,1,1) * MAP_BLOCKSIZE;
1271 sortBoxVerticies(pmin, pmax);
1273 u32 blockseed = Mapgen::getBlockSeed(pmin, mg.seed);
1275 emerge->decomgr->placeAllDecos(&mg, blockseed, pmin, pmax);
1281 // create_schematic(p1, p2, probability_list, filename, y_slice_prob_list)
1282 int ModApiMapgen::l_create_schematic(lua_State *L)
1286 INodeDefManager *ndef = getServer(L)->getNodeDefManager();
1288 const char *filename = luaL_checkstring(L, 4);
1289 CHECK_SECURE_PATH_OPTIONAL(L, filename);
1291 Map *map = &(getEnv(L)->getMap());
1294 v3s16 p1 = check_v3s16(L, 1);
1295 v3s16 p2 = check_v3s16(L, 2);
1296 sortBoxVerticies(p1, p2);
1298 std::vector<std::pair<v3s16, u8> > prob_list;
1299 if (lua_istable(L, 3)) {
1301 while (lua_next(L, 3)) {
1302 if (lua_istable(L, -1)) {
1303 lua_getfield(L, -1, "pos");
1304 v3s16 pos = check_v3s16(L, -1);
1307 u8 prob = getintfield_default(L, -1, "prob", MTSCHEM_PROB_ALWAYS);
1308 prob_list.push_back(std::make_pair(pos, prob));
1315 std::vector<std::pair<s16, u8> > slice_prob_list;
1316 if (lua_istable(L, 5)) {
1318 while (lua_next(L, 5)) {
1319 if (lua_istable(L, -1)) {
1320 s16 ypos = getintfield_default(L, -1, "ypos", 0);
1321 u8 prob = getintfield_default(L, -1, "prob", MTSCHEM_PROB_ALWAYS);
1322 slice_prob_list.push_back(std::make_pair(ypos, prob));
1329 if (!schem.getSchematicFromMap(map, p1, p2)) {
1330 errorstream << "create_schematic: failed to get schematic "
1331 "from map" << std::endl;
1335 schem.applyProbabilities(p1, &prob_list, &slice_prob_list);
1337 schem.saveSchematicToFile(filename, ndef);
1338 actionstream << "create_schematic: saved schematic file '"
1339 << filename << "'." << std::endl;
1341 lua_pushboolean(L, true);
1346 // place_schematic(p, schematic, rotation, replacement)
1347 int ModApiMapgen::l_place_schematic(lua_State *L)
1351 Map *map = &(getEnv(L)->getMap());
1352 SchematicManager *schemmgr = getServer(L)->getEmergeManager()->schemmgr;
1355 v3s16 p = check_v3s16(L, 1);
1359 const char *enumstr = lua_tostring(L, 3);
1361 string_to_enum(es_Rotation, rot, std::string(enumstr));
1363 //// Read force placement
1364 bool force_placement = true;
1365 if (lua_isboolean(L, 5))
1366 force_placement = lua_toboolean(L, 5);
1368 //// Read node replacements
1369 StringMap replace_names;
1370 if (lua_istable(L, 4))
1371 read_schematic_replacements(L, 4, &replace_names);
1374 Schematic *schem = get_or_load_schematic(L, 2, schemmgr, &replace_names);
1376 errorstream << "place_schematic: failed to get schematic" << std::endl;
1380 schem->placeOnMap(map, p, 0, (Rotation)rot, force_placement);
1382 lua_pushboolean(L, true);
1386 int ModApiMapgen::l_place_schematic_on_vmanip(lua_State *L)
1388 NO_MAP_LOCK_REQUIRED;
1390 SchematicManager *schemmgr = getServer(L)->getEmergeManager()->schemmgr;
1392 //// Read VoxelManip object
1393 MMVManip *vm = LuaVoxelManip::checkobject(L, 1)->vm;
1396 v3s16 p = check_v3s16(L, 2);
1400 const char *enumstr = lua_tostring(L, 4);
1402 string_to_enum(es_Rotation, rot, std::string(enumstr));
1404 //// Read force placement
1405 bool force_placement = true;
1406 if (lua_isboolean(L, 6))
1407 force_placement = lua_toboolean(L, 6);
1409 //// Read node replacements
1410 StringMap replace_names;
1411 if (lua_istable(L, 5))
1412 read_schematic_replacements(L, 5, &replace_names);
1415 Schematic *schem = get_or_load_schematic(L, 3, schemmgr, &replace_names);
1417 errorstream << "place_schematic: failed to get schematic" << std::endl;
1421 bool schematic_did_fit = schem->placeOnVManip(
1422 vm, p, 0, (Rotation)rot, force_placement);
1424 lua_pushboolean(L, schematic_did_fit);
1428 // serialize_schematic(schematic, format, options={...})
1429 int ModApiMapgen::l_serialize_schematic(lua_State *L)
1431 NO_MAP_LOCK_REQUIRED;
1433 SchematicManager *schemmgr = getServer(L)->getEmergeManager()->schemmgr;
1436 bool use_comments = getboolfield_default(L, 3, "lua_use_comments", false);
1437 u32 indent_spaces = getintfield_default(L, 3, "lua_num_indent_spaces", 0);
1440 bool was_loaded = false;
1441 Schematic *schem = (Schematic *)get_objdef(L, 1, schemmgr);
1443 schem = load_schematic(L, 1, NULL, NULL);
1447 errorstream << "serialize_schematic: failed to get schematic" << std::endl;
1451 //// Read format of definition to save as
1452 int schem_format = SCHEM_FMT_MTS;
1453 const char *enumstr = lua_tostring(L, 2);
1455 string_to_enum(es_SchematicFormatType, schem_format, std::string(enumstr));
1457 //// Serialize to binary string
1458 std::ostringstream os(std::ios_base::binary);
1459 switch (schem_format) {
1461 schem->serializeToMts(&os, schem->m_nodenames);
1464 schem->serializeToLua(&os, schem->m_nodenames,
1465 use_comments, indent_spaces);
1474 std::string ser = os.str();
1475 lua_pushlstring(L, ser.c_str(), ser.length());
1480 void ModApiMapgen::Initialize(lua_State *L, int top)
1482 API_FCT(get_biome_id);
1483 API_FCT(get_mapgen_object);
1485 API_FCT(get_mapgen_params);
1486 API_FCT(set_mapgen_params);
1487 API_FCT(get_mapgen_setting);
1488 API_FCT(set_mapgen_setting);
1489 API_FCT(get_mapgen_setting_noiseparams);
1490 API_FCT(set_mapgen_setting_noiseparams);
1491 API_FCT(set_noiseparams);
1492 API_FCT(get_noiseparams);
1493 API_FCT(set_gen_notify);
1494 API_FCT(get_gen_notify);
1496 API_FCT(register_biome);
1497 API_FCT(register_decoration);
1498 API_FCT(register_ore);
1499 API_FCT(register_schematic);
1501 API_FCT(clear_registered_biomes);
1502 API_FCT(clear_registered_decorations);
1503 API_FCT(clear_registered_ores);
1504 API_FCT(clear_registered_schematics);
1506 API_FCT(generate_ores);
1507 API_FCT(generate_decorations);
1508 API_FCT(create_schematic);
1509 API_FCT(place_schematic);
1510 API_FCT(place_schematic_on_vmanip);
1511 API_FCT(serialize_schematic);