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 {BIOME_NORMAL, "normal"},
43 {BIOME_LIQUID, "liquid"},
44 {BIOME_NETHER, "nether"},
45 {BIOME_AETHER, "aether"},
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, std::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 std::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 std::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, BIOME_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->y_min = getintfield_default(L, index, "y_min", -31000);
382 b->y_max = getintfield_default(L, index, "y_max", 31000);
383 b->heat_point = getfloatfield_default(L, index, "heat_point", 0.f);
384 b->humidity_point = getfloatfield_default(L, index, "humidity_point", 0.f);
385 b->flags = 0; //reserved
387 std::vector<std::string> &nn = b->m_nodenames;
388 nn.push_back(getstringfield_default(L, index, "node_top", ""));
389 nn.push_back(getstringfield_default(L, index, "node_filler", ""));
390 nn.push_back(getstringfield_default(L, index, "node_stone", ""));
391 nn.push_back(getstringfield_default(L, index, "node_water_top", ""));
392 nn.push_back(getstringfield_default(L, index, "node_water", ""));
393 nn.push_back(getstringfield_default(L, index, "node_river_water", ""));
394 nn.push_back(getstringfield_default(L, index, "node_dust", ""));
395 ndef->pendNodeResolve(b);
401 size_t get_biome_list(lua_State *L, int index,
402 BiomeManager *biomemgr, std::set<u8> *biome_id_list)
405 index = lua_gettop(L) + 1 + index;
407 if (lua_isnil(L, index))
410 bool is_single = true;
411 if (lua_istable(L, index)) {
412 lua_getfield(L, index, "name");
413 is_single = !lua_isnil(L, -1);
418 Biome *biome = get_or_load_biome(L, index, biomemgr);
420 errorstream << "get_biome_list: failed to get biome '"
421 << (lua_isstring(L, index) ? lua_tostring(L, index) : "")
422 << "'." << std::endl;
426 biome_id_list->insert(biome->index);
430 // returns number of failed resolutions
431 size_t fail_count = 0;
434 for (lua_pushnil(L); lua_next(L, index); lua_pop(L, 1)) {
436 Biome *biome = get_or_load_biome(L, -1, biomemgr);
439 errorstream << "get_biome_list: failed to get biome '"
440 << (lua_isstring(L, -1) ? lua_tostring(L, -1) : "")
445 biome_id_list->insert(biome->index);
451 ///////////////////////////////////////////////////////////////////////////////
453 // get_biome_id(biomename)
454 // returns the biome id used in biomemap
455 int ModApiMapgen::l_get_biome_id(lua_State *L)
457 NO_MAP_LOCK_REQUIRED;
459 const char *biome_str = lua_tostring(L, 1);
463 BiomeManager *bmgr = getServer(L)->getEmergeManager()->biomemgr;
468 Biome *biome = (Biome *)bmgr->getByName(biome_str);
470 if (!biome || biome->index == OBJDEF_INVALID_INDEX)
473 lua_pushinteger(L, biome->index);
479 // get_mapgen_object(objectname)
480 // returns the requested object used during map generation
481 int ModApiMapgen::l_get_mapgen_object(lua_State *L)
483 NO_MAP_LOCK_REQUIRED;
485 const char *mgobjstr = lua_tostring(L, 1);
488 if (!string_to_enum(es_MapgenObject, mgobjint, mgobjstr ? mgobjstr : ""))
491 enum MapgenObject mgobj = (MapgenObject)mgobjint;
493 EmergeManager *emerge = getServer(L)->getEmergeManager();
494 Mapgen *mg = emerge->getCurrentMapgen();
496 throw LuaError("Must only be called in a mapgen thread!");
498 size_t maplen = mg->csize.X * mg->csize.Z;
502 MMVManip *vm = mg->vm;
505 LuaVoxelManip *o = new LuaVoxelManip(vm, true);
506 *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
507 luaL_getmetatable(L, "VoxelManip");
508 lua_setmetatable(L, -2);
511 push_v3s16(L, vm->m_area.MinEdge);
514 push_v3s16(L, vm->m_area.MaxEdge);
518 case MGOBJ_HEIGHTMAP: {
523 for (size_t i = 0; i != maplen; i++) {
524 lua_pushinteger(L, mg->heightmap[i]);
525 lua_rawseti(L, -2, i + 1);
530 case MGOBJ_BIOMEMAP: {
535 for (size_t i = 0; i != maplen; i++) {
536 lua_pushinteger(L, mg->biomemap[i]);
537 lua_rawseti(L, -2, i + 1);
542 case MGOBJ_HEATMAP: {
547 for (size_t i = 0; i != maplen; i++) {
548 lua_pushnumber(L, mg->heatmap[i]);
549 lua_rawseti(L, -2, i + 1);
555 case MGOBJ_HUMIDMAP: {
560 for (size_t i = 0; i != maplen; i++) {
561 lua_pushnumber(L, mg->humidmap[i]);
562 lua_rawseti(L, -2, i + 1);
567 case MGOBJ_GENNOTIFY: {
568 std::map<std::string, std::vector<v3s16> >event_map;
569 std::map<std::string, std::vector<v3s16> >::iterator it;
571 mg->gennotify.getEvents(event_map);
574 for (it = event_map.begin(); it != event_map.end(); ++it) {
577 for (size_t j = 0; j != it->second.size(); j++) {
578 push_v3s16(L, it->second[j]);
579 lua_rawseti(L, -2, j + 1);
582 lua_setfield(L, -2, it->first.c_str());
593 int ModApiMapgen::l_get_mapgen_params(lua_State *L)
595 NO_MAP_LOCK_REQUIRED;
597 MapgenParams *params = &getServer(L)->getEmergeManager()->params;
601 lua_pushstring(L, params->mg_name.c_str());
602 lua_setfield(L, -2, "mgname");
604 lua_pushinteger(L, params->seed);
605 lua_setfield(L, -2, "seed");
607 lua_pushinteger(L, params->water_level);
608 lua_setfield(L, -2, "water_level");
610 lua_pushinteger(L, params->chunksize);
611 lua_setfield(L, -2, "chunksize");
613 std::string flagstr = writeFlagString(params->flags, flagdesc_mapgen, U32_MAX);
614 lua_pushstring(L, flagstr.c_str());
615 lua_setfield(L, -2, "flags");
621 // set_mapgen_params(params)
622 // set mapgen parameters
623 int ModApiMapgen::l_set_mapgen_params(lua_State *L)
625 NO_MAP_LOCK_REQUIRED;
627 if (!lua_istable(L, 1))
630 EmergeManager *emerge = getServer(L)->getEmergeManager();
631 if (emerge->isRunning())
632 throw LuaError("Cannot set parameters while mapgen is running");
634 MapgenParams *params = &emerge->params;
635 u32 flags = 0, flagmask = 0;
637 lua_getfield(L, 1, "mgname");
638 if (lua_isstring(L, -1)) {
639 params->mg_name = lua_tostring(L, -1);
640 delete params->sparams;
641 params->sparams = NULL;
644 lua_getfield(L, 1, "seed");
645 if (lua_isnumber(L, -1))
646 params->seed = lua_tointeger(L, -1);
648 lua_getfield(L, 1, "water_level");
649 if (lua_isnumber(L, -1))
650 params->water_level = lua_tointeger(L, -1);
652 lua_getfield(L, 1, "chunksize");
653 if (lua_isnumber(L, -1))
654 params->chunksize = lua_tointeger(L, -1);
656 warn_if_field_exists(L, 1, "flagmask",
657 "Deprecated: flags field now includes unset flags.");
658 lua_getfield(L, 1, "flagmask");
659 if (lua_isstring(L, -1))
660 params->flags &= ~readFlagString(lua_tostring(L, -1), flagdesc_mapgen, NULL);
662 if (getflagsfield(L, 1, "flags", flagdesc_mapgen, &flags, &flagmask)) {
663 params->flags &= ~flagmask;
664 params->flags |= flags;
671 // set_noiseparams(name, noiseparams, set_default)
672 // set global config values for noise parameters
673 int ModApiMapgen::l_set_noiseparams(lua_State *L)
675 NO_MAP_LOCK_REQUIRED;
677 const char *name = luaL_checkstring(L, 1);
680 if (!read_noiseparams(L, 2, &np))
683 bool set_default = lua_isboolean(L, 3) ? lua_toboolean(L, 3) : true;
685 g_settings->setNoiseParams(name, np, set_default);
691 // get_noiseparams(name)
692 int ModApiMapgen::l_get_noiseparams(lua_State *L)
694 NO_MAP_LOCK_REQUIRED;
696 std::string name = luaL_checkstring(L, 1);
699 if (!g_settings->getNoiseParams(name, np))
702 push_noiseparams(L, &np);
707 // set_gen_notify(flags, {deco_id_table})
708 int ModApiMapgen::l_set_gen_notify(lua_State *L)
710 NO_MAP_LOCK_REQUIRED;
712 u32 flags = 0, flagmask = 0;
713 EmergeManager *emerge = getServer(L)->getEmergeManager();
715 if (read_flags(L, 1, flagdesc_gennotify, &flags, &flagmask)) {
716 emerge->gen_notify_on &= ~flagmask;
717 emerge->gen_notify_on |= flags;
720 if (lua_istable(L, 2)) {
722 while (lua_next(L, 2)) {
723 if (lua_isnumber(L, -1))
724 emerge->gen_notify_on_deco_ids.insert((u32)lua_tonumber(L, -1));
734 int ModApiMapgen::l_get_gen_notify(lua_State *L)
736 NO_MAP_LOCK_REQUIRED;
738 EmergeManager *emerge = getServer(L)->getEmergeManager();
739 push_flags_string(L, flagdesc_gennotify, emerge->gen_notify_on,
740 emerge->gen_notify_on);
744 for (std::set<u32>::iterator it = emerge->gen_notify_on_deco_ids.begin();
745 it != emerge->gen_notify_on_deco_ids.end(); ++it) {
746 lua_pushnumber(L, *it);
747 lua_rawseti(L, -2, i);
754 // register_biome({lots of stuff})
755 int ModApiMapgen::l_register_biome(lua_State *L)
757 NO_MAP_LOCK_REQUIRED;
760 luaL_checktype(L, index, LUA_TTABLE);
762 INodeDefManager *ndef = getServer(L)->getNodeDefManager();
763 BiomeManager *bmgr = getServer(L)->getEmergeManager()->biomemgr;
765 Biome *biome = read_biome_def(L, index, ndef);
769 ObjDefHandle handle = bmgr->add(biome);
770 if (handle == OBJDEF_INVALID_HANDLE) {
775 lua_pushinteger(L, handle);
780 // register_decoration({lots of stuff})
781 int ModApiMapgen::l_register_decoration(lua_State *L)
783 NO_MAP_LOCK_REQUIRED;
786 luaL_checktype(L, index, LUA_TTABLE);
788 INodeDefManager *ndef = getServer(L)->getNodeDefManager();
789 DecorationManager *decomgr = getServer(L)->getEmergeManager()->decomgr;
790 BiomeManager *biomemgr = getServer(L)->getEmergeManager()->biomemgr;
791 SchematicManager *schemmgr = getServer(L)->getEmergeManager()->schemmgr;
793 enum DecorationType decotype = (DecorationType)getenumfield(L, index,
794 "deco_type", es_DecorationType, -1);
796 Decoration *deco = decomgr->create(decotype);
798 errorstream << "register_decoration: decoration placement type "
799 << decotype << " not implemented" << std::endl;
803 deco->name = getstringfield_default(L, index, "name", "");
804 deco->fill_ratio = getfloatfield_default(L, index, "fill_ratio", 0.02);
805 deco->y_min = getintfield_default(L, index, "y_min", -31000);
806 deco->y_max = getintfield_default(L, index, "y_max", 31000);
807 deco->sidelen = getintfield_default(L, index, "sidelen", 8);
808 if (deco->sidelen <= 0) {
809 errorstream << "register_decoration: sidelen must be "
810 "greater than 0" << std::endl;
815 //// Get node name(s) to place decoration on
816 size_t nread = getstringlistfield(L, index, "place_on", &deco->m_nodenames);
817 deco->m_nnlistsizes.push_back(nread);
819 //// Get decoration flags
820 getflagsfield(L, index, "flags", flagdesc_deco, &deco->flags, NULL);
822 //// Get NoiseParams to define how decoration is placed
823 lua_getfield(L, index, "noise_params");
824 if (read_noiseparams(L, -1, &deco->np))
825 deco->flags |= DECO_USE_NOISE;
828 //// Get biomes associated with this decoration (if any)
829 lua_getfield(L, index, "biomes");
830 if (get_biome_list(L, -1, biomemgr, &deco->biomes))
831 errorstream << "register_decoration: couldn't get all biomes " << std::endl;
834 //// Handle decoration type-specific parameters
835 bool success = false;
838 success = read_deco_simple(L, (DecoSimple *)deco);
841 success = read_deco_schematic(L, schemmgr, (DecoSchematic *)deco);
852 ndef->pendNodeResolve(deco);
854 ObjDefHandle handle = decomgr->add(deco);
855 if (handle == OBJDEF_INVALID_HANDLE) {
860 lua_pushinteger(L, handle);
865 bool read_deco_simple(lua_State *L, DecoSimple *deco)
870 deco->deco_height = getintfield_default(L, index, "height", 1);
871 deco->deco_height_max = getintfield_default(L, index, "height_max", 0);
872 deco->nspawnby = getintfield_default(L, index, "num_spawn_by", -1);
874 if (deco->deco_height <= 0) {
875 errorstream << "register_decoration: simple decoration height"
876 " must be greater than 0" << std::endl;
880 nnames = getstringlistfield(L, index, "decoration", &deco->m_nodenames);
881 deco->m_nnlistsizes.push_back(nnames);
883 errorstream << "register_decoration: no decoration nodes "
884 "defined" << std::endl;
888 nnames = getstringlistfield(L, index, "spawn_by", &deco->m_nodenames);
889 deco->m_nnlistsizes.push_back(nnames);
890 if (nnames == 0 && deco->nspawnby != -1) {
891 errorstream << "register_decoration: no spawn_by nodes defined,"
892 " but num_spawn_by specified" << std::endl;
900 bool read_deco_schematic(lua_State *L, SchematicManager *schemmgr, DecoSchematic *deco)
904 deco->rotation = (Rotation)getenumfield(L, index, "rotation",
905 ModApiMapgen::es_Rotation, ROTATE_0);
907 StringMap replace_names;
908 lua_getfield(L, index, "replacements");
909 if (lua_istable(L, -1))
910 read_schematic_replacements(L, -1, &replace_names);
913 lua_getfield(L, index, "schematic");
914 Schematic *schem = get_or_load_schematic(L, -1, schemmgr, &replace_names);
917 deco->schematic = schem;
918 return schem != NULL;
922 // register_ore({lots of stuff})
923 int ModApiMapgen::l_register_ore(lua_State *L)
925 NO_MAP_LOCK_REQUIRED;
928 luaL_checktype(L, index, LUA_TTABLE);
930 INodeDefManager *ndef = getServer(L)->getNodeDefManager();
931 BiomeManager *bmgr = getServer(L)->getEmergeManager()->biomemgr;
932 OreManager *oremgr = getServer(L)->getEmergeManager()->oremgr;
934 enum OreType oretype = (OreType)getenumfield(L, index,
935 "ore_type", es_OreType, ORE_SCATTER);
936 Ore *ore = oremgr->create(oretype);
938 errorstream << "register_ore: ore_type " << oretype << " not implemented\n";
942 ore->name = getstringfield_default(L, index, "name", "");
943 ore->ore_param2 = (u8)getintfield_default(L, index, "ore_param2", 0);
944 ore->clust_scarcity = getintfield_default(L, index, "clust_scarcity", 1);
945 ore->clust_num_ores = getintfield_default(L, index, "clust_num_ores", 1);
946 ore->clust_size = getintfield_default(L, index, "clust_size", 0);
950 //// Get noise_threshold
951 warn_if_field_exists(L, index, "noise_threshhold",
952 "Deprecated: new name is \"noise_threshold\".");
955 if (!getfloatfield(L, index, "noise_threshold", nthresh) &&
956 !getfloatfield(L, index, "noise_threshhold", nthresh))
958 ore->nthresh = nthresh;
961 warn_if_field_exists(L, index, "height_min",
962 "Deprecated: new name is \"y_min\".");
963 warn_if_field_exists(L, index, "height_max",
964 "Deprecated: new name is \"y_max\".");
967 if (!getintfield(L, index, "y_min", ymin) &&
968 !getintfield(L, index, "height_min", ymin))
970 if (!getintfield(L, index, "y_max", ymax) &&
971 !getintfield(L, index, "height_max", ymax))
976 if (ore->clust_scarcity <= 0 || ore->clust_num_ores <= 0) {
977 errorstream << "register_ore: clust_scarcity and clust_num_ores"
978 "must be greater than 0" << std::endl;
984 getflagsfield(L, index, "flags", flagdesc_ore, &ore->flags, NULL);
986 //// Get biomes associated with this decoration (if any)
987 lua_getfield(L, index, "biomes");
988 if (get_biome_list(L, -1, bmgr, &ore->biomes))
989 errorstream << "register_ore: couldn't get all biomes " << std::endl;
992 //// Get noise parameters if needed
993 lua_getfield(L, index, "noise_params");
994 if (read_noiseparams(L, -1, &ore->np)) {
995 ore->flags |= OREFLAG_USE_NOISE;
996 } else if (ore->NEEDS_NOISE) {
997 errorstream << "register_ore: specified ore type requires valid "
998 "noise parameters" << std::endl;
1004 //// Get type-specific parameters
1007 OreSheet *oresheet = (OreSheet *)ore;
1009 oresheet->column_height_min = getintfield_default(L, index,
1010 "column_height_min", 1);
1011 oresheet->column_height_max = getintfield_default(L, index,
1012 "column_height_max", ore->clust_size);
1013 oresheet->column_midpoint_factor = getfloatfield_default(L, index,
1014 "column_midpoint_factor", 0.5f);
1019 OrePuff *orepuff = (OrePuff *)ore;
1021 lua_getfield(L, index, "np_puff_top");
1022 read_noiseparams(L, -1, &orepuff->np_puff_top);
1025 lua_getfield(L, index, "np_puff_bottom");
1026 read_noiseparams(L, -1, &orepuff->np_puff_bottom);
1032 OreVein *orevein = (OreVein *)ore;
1034 orevein->random_factor = getfloatfield_default(L, index,
1035 "random_factor", 1.f);
1043 ObjDefHandle handle = oremgr->add(ore);
1044 if (handle == OBJDEF_INVALID_HANDLE) {
1049 ore->m_nodenames.push_back(getstringfield_default(L, index, "ore", ""));
1051 size_t nnames = getstringlistfield(L, index, "wherein", &ore->m_nodenames);
1052 ore->m_nnlistsizes.push_back(nnames);
1054 ndef->pendNodeResolve(ore);
1056 lua_pushinteger(L, handle);
1061 // register_schematic({schematic}, replacements={})
1062 int ModApiMapgen::l_register_schematic(lua_State *L)
1064 NO_MAP_LOCK_REQUIRED;
1066 SchematicManager *schemmgr = getServer(L)->getEmergeManager()->schemmgr;
1068 StringMap replace_names;
1069 if (lua_istable(L, 2))
1070 read_schematic_replacements(L, 2, &replace_names);
1072 Schematic *schem = load_schematic(L, 1, schemmgr->getNodeDef(),
1077 ObjDefHandle handle = schemmgr->add(schem);
1078 if (handle == OBJDEF_INVALID_HANDLE) {
1083 lua_pushinteger(L, handle);
1088 // clear_registered_biomes()
1089 int ModApiMapgen::l_clear_registered_biomes(lua_State *L)
1091 NO_MAP_LOCK_REQUIRED;
1093 BiomeManager *bmgr = getServer(L)->getEmergeManager()->biomemgr;
1099 // clear_registered_decorations()
1100 int ModApiMapgen::l_clear_registered_decorations(lua_State *L)
1102 NO_MAP_LOCK_REQUIRED;
1104 DecorationManager *dmgr = getServer(L)->getEmergeManager()->decomgr;
1110 // clear_registered_ores()
1111 int ModApiMapgen::l_clear_registered_ores(lua_State *L)
1113 NO_MAP_LOCK_REQUIRED;
1115 OreManager *omgr = getServer(L)->getEmergeManager()->oremgr;
1121 // clear_registered_schematics()
1122 int ModApiMapgen::l_clear_registered_schematics(lua_State *L)
1124 NO_MAP_LOCK_REQUIRED;
1126 SchematicManager *smgr = getServer(L)->getEmergeManager()->schemmgr;
1132 // generate_ores(vm, p1, p2, [ore_id])
1133 int ModApiMapgen::l_generate_ores(lua_State *L)
1135 NO_MAP_LOCK_REQUIRED;
1137 EmergeManager *emerge = getServer(L)->getEmergeManager();
1140 mg.seed = emerge->params.seed;
1141 mg.vm = LuaVoxelManip::checkobject(L, 1)->vm;
1142 mg.ndef = getServer(L)->getNodeDefManager();
1144 v3s16 pmin = lua_istable(L, 2) ? check_v3s16(L, 2) :
1145 mg.vm->m_area.MinEdge + v3s16(1,1,1) * MAP_BLOCKSIZE;
1146 v3s16 pmax = lua_istable(L, 3) ? check_v3s16(L, 3) :
1147 mg.vm->m_area.MaxEdge - v3s16(1,1,1) * MAP_BLOCKSIZE;
1148 sortBoxVerticies(pmin, pmax);
1150 u32 blockseed = Mapgen::getBlockSeed(pmin, mg.seed);
1152 emerge->oremgr->placeAllOres(&mg, blockseed, pmin, pmax);
1158 // generate_decorations(vm, p1, p2, [deco_id])
1159 int ModApiMapgen::l_generate_decorations(lua_State *L)
1161 NO_MAP_LOCK_REQUIRED;
1163 EmergeManager *emerge = getServer(L)->getEmergeManager();
1166 mg.seed = emerge->params.seed;
1167 mg.vm = LuaVoxelManip::checkobject(L, 1)->vm;
1168 mg.ndef = getServer(L)->getNodeDefManager();
1170 v3s16 pmin = lua_istable(L, 2) ? check_v3s16(L, 2) :
1171 mg.vm->m_area.MinEdge + v3s16(1,1,1) * MAP_BLOCKSIZE;
1172 v3s16 pmax = lua_istable(L, 3) ? check_v3s16(L, 3) :
1173 mg.vm->m_area.MaxEdge - v3s16(1,1,1) * MAP_BLOCKSIZE;
1174 sortBoxVerticies(pmin, pmax);
1176 u32 blockseed = Mapgen::getBlockSeed(pmin, mg.seed);
1178 emerge->decomgr->placeAllDecos(&mg, blockseed, pmin, pmax);
1184 // create_schematic(p1, p2, probability_list, filename, y_slice_prob_list)
1185 int ModApiMapgen::l_create_schematic(lua_State *L)
1189 INodeDefManager *ndef = getServer(L)->getNodeDefManager();
1191 const char *filename = luaL_checkstring(L, 4);
1192 CHECK_SECURE_PATH_OPTIONAL(L, filename);
1194 Map *map = &(getEnv(L)->getMap());
1197 v3s16 p1 = check_v3s16(L, 1);
1198 v3s16 p2 = check_v3s16(L, 2);
1199 sortBoxVerticies(p1, p2);
1201 std::vector<std::pair<v3s16, u8> > prob_list;
1202 if (lua_istable(L, 3)) {
1204 while (lua_next(L, 3)) {
1205 if (lua_istable(L, -1)) {
1206 lua_getfield(L, -1, "pos");
1207 v3s16 pos = check_v3s16(L, -1);
1210 u8 prob = getintfield_default(L, -1, "prob", MTSCHEM_PROB_ALWAYS);
1211 prob_list.push_back(std::make_pair(pos, prob));
1218 std::vector<std::pair<s16, u8> > slice_prob_list;
1219 if (lua_istable(L, 5)) {
1221 while (lua_next(L, 5)) {
1222 if (lua_istable(L, -1)) {
1223 s16 ypos = getintfield_default(L, -1, "ypos", 0);
1224 u8 prob = getintfield_default(L, -1, "prob", MTSCHEM_PROB_ALWAYS);
1225 slice_prob_list.push_back(std::make_pair(ypos, prob));
1232 if (!schem.getSchematicFromMap(map, p1, p2)) {
1233 errorstream << "create_schematic: failed to get schematic "
1234 "from map" << std::endl;
1238 schem.applyProbabilities(p1, &prob_list, &slice_prob_list);
1240 schem.saveSchematicToFile(filename, ndef);
1241 actionstream << "create_schematic: saved schematic file '"
1242 << filename << "'." << std::endl;
1244 lua_pushboolean(L, true);
1249 // place_schematic(p, schematic, rotation, replacement)
1250 int ModApiMapgen::l_place_schematic(lua_State *L)
1254 Map *map = &(getEnv(L)->getMap());
1255 SchematicManager *schemmgr = getServer(L)->getEmergeManager()->schemmgr;
1258 v3s16 p = check_v3s16(L, 1);
1262 const char *enumstr = lua_tostring(L, 3);
1264 string_to_enum(es_Rotation, rot, std::string(enumstr));
1266 //// Read force placement
1267 bool force_placement = true;
1268 if (lua_isboolean(L, 5))
1269 force_placement = lua_toboolean(L, 5);
1271 //// Read node replacements
1272 StringMap replace_names;
1273 if (lua_istable(L, 4))
1274 read_schematic_replacements(L, 4, &replace_names);
1277 Schematic *schem = get_or_load_schematic(L, 2, schemmgr, &replace_names);
1279 errorstream << "place_schematic: failed to get schematic" << std::endl;
1283 schem->placeOnMap(map, p, 0, (Rotation)rot, force_placement);
1285 lua_pushboolean(L, true);
1289 int ModApiMapgen::l_place_schematic_on_vmanip(lua_State *L)
1291 NO_MAP_LOCK_REQUIRED;
1293 SchematicManager *schemmgr = getServer(L)->getEmergeManager()->schemmgr;
1295 //// Read VoxelManip object
1296 MMVManip *vm = LuaVoxelManip::checkobject(L, 1)->vm;
1299 v3s16 p = check_v3s16(L, 2);
1303 const char *enumstr = lua_tostring(L, 4);
1305 string_to_enum(es_Rotation, rot, std::string(enumstr));
1307 //// Read force placement
1308 bool force_placement = true;
1309 if (lua_isboolean(L, 6))
1310 force_placement = lua_toboolean(L, 6);
1312 //// Read node replacements
1313 StringMap replace_names;
1314 if (lua_istable(L, 5))
1315 read_schematic_replacements(L, 5, &replace_names);
1318 Schematic *schem = get_or_load_schematic(L, 3, schemmgr, &replace_names);
1320 errorstream << "place_schematic: failed to get schematic" << std::endl;
1324 bool schematic_did_fit = schem->placeOnVManip(
1325 vm, p, 0, (Rotation)rot, force_placement);
1327 lua_pushboolean(L, schematic_did_fit);
1331 // serialize_schematic(schematic, format, options={...})
1332 int ModApiMapgen::l_serialize_schematic(lua_State *L)
1334 NO_MAP_LOCK_REQUIRED;
1336 SchematicManager *schemmgr = getServer(L)->getEmergeManager()->schemmgr;
1339 bool use_comments = getboolfield_default(L, 3, "lua_use_comments", false);
1340 u32 indent_spaces = getintfield_default(L, 3, "lua_num_indent_spaces", 0);
1343 bool was_loaded = false;
1344 Schematic *schem = (Schematic *)get_objdef(L, 1, schemmgr);
1346 schem = load_schematic(L, 1, NULL, NULL);
1350 errorstream << "serialize_schematic: failed to get schematic" << std::endl;
1354 //// Read format of definition to save as
1355 int schem_format = SCHEM_FMT_MTS;
1356 const char *enumstr = lua_tostring(L, 2);
1358 string_to_enum(es_SchematicFormatType, schem_format, std::string(enumstr));
1360 //// Serialize to binary string
1361 std::ostringstream os(std::ios_base::binary);
1362 switch (schem_format) {
1364 schem->serializeToMts(&os, schem->m_nodenames);
1367 schem->serializeToLua(&os, schem->m_nodenames,
1368 use_comments, indent_spaces);
1377 std::string ser = os.str();
1378 lua_pushlstring(L, ser.c_str(), ser.length());
1383 void ModApiMapgen::Initialize(lua_State *L, int top)
1385 API_FCT(get_biome_id);
1386 API_FCT(get_mapgen_object);
1388 API_FCT(get_mapgen_params);
1389 API_FCT(set_mapgen_params);
1390 API_FCT(set_noiseparams);
1391 API_FCT(get_noiseparams);
1392 API_FCT(set_gen_notify);
1393 API_FCT(get_gen_notify);
1395 API_FCT(register_biome);
1396 API_FCT(register_decoration);
1397 API_FCT(register_ore);
1398 API_FCT(register_schematic);
1400 API_FCT(clear_registered_biomes);
1401 API_FCT(clear_registered_decorations);
1402 API_FCT(clear_registered_ores);
1403 API_FCT(clear_registered_schematics);
1405 API_FCT(generate_ores);
1406 API_FCT(generate_decorations);
1407 API_FCT(create_schematic);
1408 API_FCT(place_schematic);
1409 API_FCT(place_schematic_on_vmanip);
1410 API_FCT(serialize_schematic);