l_mapgen.cpp: Fix LINT broken since b1b40fe
[oweals/minetest.git] / src / script / lua_api / l_mapgen.cpp
index b526111d4737b9466979a338fc7c1a7607f5b8c0..e7e002c160fc439e374929403cbf5aa927fa122b 100644 (file)
@@ -40,10 +40,6 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 struct EnumString ModApiMapgen::es_BiomeTerrainType[] =
 {
        {BIOMETYPE_NORMAL, "normal"},
-       {BIOMETYPE_LIQUID, "liquid"},
-       {BIOMETYPE_NETHER, "nether"},
-       {BIOMETYPE_AETHER, "aether"},
-       {BIOMETYPE_FLAT,   "flat"},
        {0, NULL},
 };
 
@@ -99,16 +95,16 @@ ObjDef *get_objdef(lua_State *L, int index, ObjDefManager *objmgr);
 
 Biome *get_or_load_biome(lua_State *L, int index,
        BiomeManager *biomemgr);
-Biome *read_biome_def(lua_State *L, int index, INodeDefManager *ndef);
+Biome *read_biome_def(lua_State *L, int index, const NodeDefManager *ndef);
 size_t get_biome_list(lua_State *L, int index,
        BiomeManager *biomemgr, std::unordered_set<u8> *biome_id_list);
 
 Schematic *get_or_load_schematic(lua_State *L, int index,
        SchematicManager *schemmgr, StringMap *replace_names);
-Schematic *load_schematic(lua_State *L, int index, INodeDefManager *ndef,
+Schematic *load_schematic(lua_State *L, int index, const NodeDefManager *ndef,
        StringMap *replace_names);
 Schematic *load_schematic_from_def(lua_State *L, int index,
-       INodeDefManager *ndef, StringMap *replace_names);
+       const NodeDefManager *ndef, StringMap *replace_names);
 bool read_schematic_def(lua_State *L, int index,
        Schematic *schem, std::vector<std::string> *names);
 
@@ -160,7 +156,7 @@ Schematic *get_or_load_schematic(lua_State *L, int index,
 }
 
 
-Schematic *load_schematic(lua_State *L, int index, INodeDefManager *ndef,
+Schematic *load_schematic(lua_State *L, int index, const NodeDefManager *ndef,
        StringMap *replace_names)
 {
        if (index < 0)
@@ -196,7 +192,7 @@ Schematic *load_schematic(lua_State *L, int index, INodeDefManager *ndef,
 
 
 Schematic *load_schematic_from_def(lua_State *L, int index,
-       INodeDefManager *ndef, StringMap *replace_names)
+       const NodeDefManager *ndef, StringMap *replace_names)
 {
        Schematic *schem = SchematicManager::create(SCHEMATIC_NORMAL);
 
@@ -374,7 +370,7 @@ Biome *get_or_load_biome(lua_State *L, int index, BiomeManager *biomemgr)
 }
 
 
-Biome *read_biome_def(lua_State *L, int index, INodeDefManager *ndef)
+Biome *read_biome_def(lua_State *L, int index, const NodeDefManager *ndef)
 {
        if (!lua_istable(L, index))
                return NULL;
@@ -388,22 +384,40 @@ Biome *read_biome_def(lua_State *L, int index, INodeDefManager *ndef)
        b->depth_filler    = getintfield_default(L,    index, "depth_filler",    -31000);
        b->depth_water_top = getintfield_default(L,    index, "depth_water_top", 0);
        b->depth_riverbed  = getintfield_default(L,    index, "depth_riverbed",  0);
-       b->y_min           = getintfield_default(L,    index, "y_min",           -31000);
-       b->y_max           = getintfield_default(L,    index, "y_max",           31000);
        b->heat_point      = getfloatfield_default(L,  index, "heat_point",      0.f);
        b->humidity_point  = getfloatfield_default(L,  index, "humidity_point",  0.f);
        b->vertical_blend  = getintfield_default(L,    index, "vertical_blend",  0);
-       b->flags           = 0; //reserved
+       b->flags           = 0; // reserved
+
+       b->min_pos = getv3s16field_default(
+               L, index, "min_pos", v3s16(-31000, -31000, -31000));
+       getintfield(L, index, "y_min", b->min_pos.Y);
+       b->max_pos = getv3s16field_default(
+               L, index, "max_pos", v3s16(31000, 31000, 31000));
+       getintfield(L, index, "y_max", b->max_pos.Y);
 
        std::vector<std::string> &nn = b->m_nodenames;
-       nn.push_back(getstringfield_default(L, index, "node_top",         ""));
-       nn.push_back(getstringfield_default(L, index, "node_filler",      ""));
-       nn.push_back(getstringfield_default(L, index, "node_stone",       ""));
-       nn.push_back(getstringfield_default(L, index, "node_water_top",   ""));
-       nn.push_back(getstringfield_default(L, index, "node_water",       ""));
-       nn.push_back(getstringfield_default(L, index, "node_river_water", ""));
-       nn.push_back(getstringfield_default(L, index, "node_riverbed",    ""));
-       nn.push_back(getstringfield_default(L, index, "node_dust",        ""));
+       nn.push_back(getstringfield_default(L, index, "node_top",           ""));
+       nn.push_back(getstringfield_default(L, index, "node_filler",        ""));
+       nn.push_back(getstringfield_default(L, index, "node_stone",         ""));
+       nn.push_back(getstringfield_default(L, index, "node_water_top",     ""));
+       nn.push_back(getstringfield_default(L, index, "node_water",         ""));
+       nn.push_back(getstringfield_default(L, index, "node_river_water",   ""));
+       nn.push_back(getstringfield_default(L, index, "node_riverbed",      ""));
+       nn.push_back(getstringfield_default(L, index, "node_dust",          ""));
+
+       size_t nnames = getstringlistfield(L, index, "node_cave_liquid", &nn);
+       // If no cave liquids defined, set list to "ignore" to trigger old hardcoded
+       // cave liquid behaviour.
+       if (nnames == 0) {
+               nn.emplace_back("ignore");
+               nnames = 1;
+       }
+       b->m_nnlistsizes.push_back(nnames);
+
+       nn.push_back(getstringfield_default(L, index, "node_dungeon",       ""));
+       nn.push_back(getstringfield_default(L, index, "node_dungeon_alt",   ""));
+       nn.push_back(getstringfield_default(L, index, "node_dungeon_stair", ""));
        ndef->pendNodeResolve(b);
 
        return b;
@@ -463,7 +477,7 @@ size_t get_biome_list(lua_State *L, int index,
 ///////////////////////////////////////////////////////////////////////////////
 
 // get_biome_id(biomename)
-// returns the biome id used in biomemap
+// returns the biome id as used in biomemap and returned by 'get_biome_data()'
 int ModApiMapgen::l_get_biome_id(lua_State *L)
 {
        NO_MAP_LOCK_REQUIRED;
@@ -473,16 +487,181 @@ int ModApiMapgen::l_get_biome_id(lua_State *L)
                return 0;
 
        BiomeManager *bmgr = getServer(L)->getEmergeManager()->biomemgr;
-
        if (!bmgr)
                return 0;
 
        Biome *biome = (Biome *)bmgr->getByName(biome_str);
+       if (!biome || biome->index == OBJDEF_INVALID_INDEX)
+               return 0;
+
+       lua_pushinteger(L, biome->index);
+
+       return 1;
+}
+
+
+// get_biome_name(biome_id)
+// returns the biome name string
+int ModApiMapgen::l_get_biome_name(lua_State *L)
+{
+       NO_MAP_LOCK_REQUIRED;
+
+       int biome_id = luaL_checkinteger(L, 1);
+
+       BiomeManager *bmgr = getServer(L)->getEmergeManager()->biomemgr;
+       if (!bmgr)
+               return 0;
+
+       Biome *b = (Biome *)bmgr->getRaw(biome_id);
+       lua_pushstring(L, b->name.c_str());
+
+       return 1;
+}
+
+
+// get_heat(pos)
+// returns the heat at the position
+int ModApiMapgen::l_get_heat(lua_State *L)
+{
+       NO_MAP_LOCK_REQUIRED;
+
+       v3s16 pos = read_v3s16(L, 1);
+
+       NoiseParams np_heat;
+       NoiseParams np_heat_blend;
+
+       MapSettingsManager *settingsmgr =
+               getServer(L)->getEmergeManager()->map_settings_mgr;
+
+       if (!settingsmgr->getMapSettingNoiseParams("mg_biome_np_heat",
+                       &np_heat) ||
+                       !settingsmgr->getMapSettingNoiseParams("mg_biome_np_heat_blend",
+                       &np_heat_blend))
+               return 0;
+
+       std::string value;
+       if (!settingsmgr->getMapSetting("seed", &value))
+               return 0;
+       std::istringstream ss(value);
+       u64 seed;
+       ss >> seed;
+
+       BiomeManager *bmgr = getServer(L)->getEmergeManager()->biomemgr;
+       if (!bmgr)
+               return 0;
+
+       float heat = bmgr->getHeatAtPosOriginal(pos, np_heat, np_heat_blend, seed);
+       if (!heat)
+               return 0;
+
+       lua_pushnumber(L, heat);
+
+       return 1;
+}
+
+
+// get_humidity(pos)
+// returns the humidity at the position
+int ModApiMapgen::l_get_humidity(lua_State *L)
+{
+       NO_MAP_LOCK_REQUIRED;
+
+       v3s16 pos = read_v3s16(L, 1);
+
+       NoiseParams np_humidity;
+       NoiseParams np_humidity_blend;
+
+       MapSettingsManager *settingsmgr =
+               getServer(L)->getEmergeManager()->map_settings_mgr;
+
+       if (!settingsmgr->getMapSettingNoiseParams("mg_biome_np_humidity",
+                       &np_humidity) ||
+                       !settingsmgr->getMapSettingNoiseParams("mg_biome_np_humidity_blend",
+                       &np_humidity_blend))
+               return 0;
+
+       std::string value;
+       if (!settingsmgr->getMapSetting("seed", &value))
+               return 0;
+       std::istringstream ss(value);
+       u64 seed;
+       ss >> seed;
+
+       BiomeManager *bmgr = getServer(L)->getEmergeManager()->biomemgr;
+       if (!bmgr)
+               return 0;
+
+       float humidity = bmgr->getHumidityAtPosOriginal(pos, np_humidity,
+               np_humidity_blend, seed);
+       if (!humidity)
+               return 0;
+
+       lua_pushnumber(L, humidity);
+
+       return 1;
+}
+
+
+// get_biome_data(pos)
+// returns a table containing the biome id, heat and humidity at the position
+int ModApiMapgen::l_get_biome_data(lua_State *L)
+{
+       NO_MAP_LOCK_REQUIRED;
+
+       v3s16 pos = read_v3s16(L, 1);
+
+       NoiseParams np_heat;
+       NoiseParams np_heat_blend;
+       NoiseParams np_humidity;
+       NoiseParams np_humidity_blend;
+
+       MapSettingsManager *settingsmgr =
+               getServer(L)->getEmergeManager()->map_settings_mgr;
+
+       if (!settingsmgr->getMapSettingNoiseParams("mg_biome_np_heat",
+                       &np_heat) ||
+                       !settingsmgr->getMapSettingNoiseParams("mg_biome_np_heat_blend",
+                       &np_heat_blend) ||
+                       !settingsmgr->getMapSettingNoiseParams("mg_biome_np_humidity",
+                       &np_humidity) ||
+                       !settingsmgr->getMapSettingNoiseParams("mg_biome_np_humidity_blend",
+                       &np_humidity_blend))
+               return 0;
 
+       std::string value;
+       if (!settingsmgr->getMapSetting("seed", &value))
+               return 0;
+       std::istringstream ss(value);
+       u64 seed;
+       ss >> seed;
+
+       BiomeManager *bmgr = getServer(L)->getEmergeManager()->biomemgr;
+       if (!bmgr)
+               return 0;
+
+       float heat = bmgr->getHeatAtPosOriginal(pos, np_heat, np_heat_blend, seed);
+       if (!heat)
+               return 0;
+
+       float humidity = bmgr->getHumidityAtPosOriginal(pos, np_humidity,
+               np_humidity_blend, seed);
+       if (!humidity)
+               return 0;
+
+       Biome *biome = (Biome *)bmgr->getBiomeFromNoiseOriginal(heat, humidity, pos);
        if (!biome || biome->index == OBJDEF_INVALID_INDEX)
                return 0;
 
+       lua_newtable(L);
+
        lua_pushinteger(L, biome->index);
+       lua_setfield(L, -2, "biome");
+
+       lua_pushnumber(L, heat);
+       lua_setfield(L, -2, "heat");
+
+       lua_pushnumber(L, humidity);
+       lua_setfield(L, -2, "humidity");
 
        return 1;
 }
@@ -606,6 +785,27 @@ int ModApiMapgen::l_get_mapgen_object(lua_State *L)
 }
 
 
+// get_spawn_level(x = num, z = num)
+int ModApiMapgen::l_get_spawn_level(lua_State *L)
+{
+       NO_MAP_LOCK_REQUIRED;
+
+       s16 x = luaL_checkinteger(L, 1);
+       s16 z = luaL_checkinteger(L, 2);
+
+       EmergeManager *emerge = getServer(L)->getEmergeManager();
+       int spawn_level = emerge->getSpawnLevelAtPoint(v2s16(x, z));
+       // Unsuitable spawn point
+       if (spawn_level == MAX_MAP_GENERATION_LIMIT)
+               return 0;
+
+       // 'findSpawnPos()' in server.cpp adds at least 1
+       lua_pushinteger(L, spawn_level + 1);
+
+       return 1;
+}
+
+
 int ModApiMapgen::l_get_mapgen_params(lua_State *L)
 {
        NO_MAP_LOCK_REQUIRED;
@@ -664,26 +864,26 @@ int ModApiMapgen::l_set_mapgen_params(lua_State *L)
 
        lua_getfield(L, 1, "mgname");
        if (lua_isstring(L, -1))
-               settingsmgr->setMapSetting("mg_name", lua_tostring(L, -1), true);
+               settingsmgr->setMapSetting("mg_name", readParam<std::string>(L, -1), true);
 
        lua_getfield(L, 1, "seed");
        if (lua_isnumber(L, -1))
-               settingsmgr->setMapSetting("seed", lua_tostring(L, -1), true);
+               settingsmgr->setMapSetting("seed", readParam<std::string>(L, -1), true);
 
        lua_getfield(L, 1, "water_level");
        if (lua_isnumber(L, -1))
-               settingsmgr->setMapSetting("water_level", lua_tostring(L, -1), true);
+               settingsmgr->setMapSetting("water_level", readParam<std::string>(L, -1), true);
 
        lua_getfield(L, 1, "chunksize");
        if (lua_isnumber(L, -1))
-               settingsmgr->setMapSetting("chunksize", lua_tostring(L, -1), true);
+               settingsmgr->setMapSetting("chunksize", readParam<std::string>(L, -1), true);
 
        warn_if_field_exists(L, 1, "flagmask",
                "Deprecated: flags field now includes unset flags.");
 
        lua_getfield(L, 1, "flags");
        if (lua_isstring(L, -1))
-               settingsmgr->setMapSetting("mg_flags", lua_tostring(L, -1), true);
+               settingsmgr->setMapSetting("mg_flags", readParam<std::string>(L, -1), true);
 
        return 0;
 }
@@ -733,7 +933,7 @@ int ModApiMapgen::l_set_mapgen_setting(lua_State *L)
 
        const char *name   = luaL_checkstring(L, 1);
        const char *value  = luaL_checkstring(L, 2);
-       bool override_meta = lua_isboolean(L, 3) && lua_toboolean(L, 3);
+       bool override_meta = readParam<bool>(L, 3, false);
 
        if (!settingsmgr->setMapSetting(name, value, override_meta)) {
                errorstream << "set_mapgen_setting: cannot set '"
@@ -762,7 +962,7 @@ int ModApiMapgen::l_set_mapgen_setting_noiseparams(lua_State *L)
                return 0;
        }
 
-       bool override_meta = lua_isboolean(L, 3) && lua_toboolean(L, 3);
+       bool override_meta = readParam<bool>(L, 3, false);
 
        if (!settingsmgr->setMapSettingNoiseParams(name, &np, override_meta)) {
                errorstream << "set_mapgen_setting_noiseparams: cannot set '"
@@ -788,7 +988,7 @@ int ModApiMapgen::l_set_noiseparams(lua_State *L)
                return 0;
        }
 
-       bool set_default = !lua_isboolean(L, 3) || lua_toboolean(L, 3);
+       bool set_default = !lua_isboolean(L, 3) || readParam<bool>(L, 3);
 
        g_settings->setNoiseParams(name, np, set_default);
 
@@ -851,13 +1051,38 @@ int ModApiMapgen::l_get_gen_notify(lua_State *L)
        int i = 1;
        for (u32 gen_notify_on_deco_id : emerge->gen_notify_on_deco_ids) {
                lua_pushnumber(L, gen_notify_on_deco_id);
-               lua_rawseti(L, -2, i);
-               i++;
+               lua_rawseti(L, -2, i++);
        }
        return 2;
 }
 
 
+// get_decoration_id(decoration_name)
+// returns the decoration ID as used in gennotify
+int ModApiMapgen::l_get_decoration_id(lua_State *L)
+{
+       NO_MAP_LOCK_REQUIRED;
+
+       const char *deco_str = luaL_checkstring(L, 1);
+       if (!deco_str)
+               return 0;
+
+       DecorationManager *dmgr = getServer(L)->getEmergeManager()->decomgr;
+
+       if (!dmgr)
+               return 0;
+
+       Decoration *deco = (Decoration *)dmgr->getByName(deco_str);
+
+       if (!deco)
+               return 0;
+
+       lua_pushinteger(L, deco->index);
+
+       return 1;
+}
+
+
 // register_biome({lots of stuff})
 int ModApiMapgen::l_register_biome(lua_State *L)
 {
@@ -866,8 +1091,8 @@ int ModApiMapgen::l_register_biome(lua_State *L)
        int index = 1;
        luaL_checktype(L, index, LUA_TTABLE);
 
-       INodeDefManager *ndef = getServer(L)->getNodeDefManager();
-       BiomeManager *bmgr    = getServer(L)->getEmergeManager()->biomemgr;
+       const NodeDefManager *ndef = getServer(L)->getNodeDefManager();
+       BiomeManager *bmgr = getServer(L)->getEmergeManager()->biomemgr;
 
        Biome *biome = read_biome_def(L, index, ndef);
        if (!biome)
@@ -892,7 +1117,7 @@ int ModApiMapgen::l_register_decoration(lua_State *L)
        int index = 1;
        luaL_checktype(L, index, LUA_TTABLE);
 
-       INodeDefManager *ndef      = getServer(L)->getNodeDefManager();
+       const NodeDefManager *ndef      = getServer(L)->getNodeDefManager();
        DecorationManager *decomgr = getServer(L)->getEmergeManager()->decomgr;
        BiomeManager *biomemgr     = getServer(L)->getEmergeManager()->biomemgr;
        SchematicManager *schemmgr = getServer(L)->getEmergeManager()->schemmgr;
@@ -1049,7 +1274,7 @@ int ModApiMapgen::l_register_ore(lua_State *L)
        int index = 1;
        luaL_checktype(L, index, LUA_TTABLE);
 
-       INodeDefManager *ndef = getServer(L)->getNodeDefManager();
+       const NodeDefManager *ndef = getServer(L)->getNodeDefManager();
        BiomeManager *bmgr    = getServer(L)->getEmergeManager()->biomemgr;
        OreManager *oremgr    = getServer(L)->getEmergeManager()->oremgr;
 
@@ -1321,7 +1546,7 @@ int ModApiMapgen::l_create_schematic(lua_State *L)
 {
        MAP_LOCK_REQUIRED;
 
-       INodeDefManager *ndef = getServer(L)->getNodeDefManager();
+       const NodeDefManager *ndef = getServer(L)->getNodeDefManager();
 
        const char *filename = luaL_checkstring(L, 4);
        CHECK_SECURE_PATH(L, filename, true);
@@ -1381,7 +1606,8 @@ int ModApiMapgen::l_create_schematic(lua_State *L)
 }
 
 
-// place_schematic(p, schematic, rotation, replacement)
+// place_schematic(p, schematic, rotation,
+//     replacements, force_placement, flagstring)
 int ModApiMapgen::l_place_schematic(lua_State *L)
 {
        MAP_LOCK_REQUIRED;
@@ -1396,14 +1622,14 @@ int ModApiMapgen::l_place_schematic(lua_State *L)
 
        //// Read rotation
        int rot = ROTATE_0;
-       const char *enumstr = lua_tostring(L, 3);
-       if (enumstr)
-               string_to_enum(es_Rotation, rot, std::string(enumstr));
+       std::string enumstr = readParam<std::string>(L, 3, "");
+       if (!enumstr.empty())
+               string_to_enum(es_Rotation, rot, enumstr);
 
        //// Read force placement
        bool force_placement = true;
        if (lua_isboolean(L, 5))
-               force_placement = lua_toboolean(L, 5);
+               force_placement = readParam<bool>(L, 5);
 
        //// Read node replacements
        StringMap replace_names;
@@ -1417,12 +1643,19 @@ int ModApiMapgen::l_place_schematic(lua_State *L)
                return 0;
        }
 
-       schem->placeOnMap(map, p, 0, (Rotation)rot, force_placement);
+       //// Read flags
+       u32 flags = 0;
+       read_flags(L, 6, flagdesc_deco, &flags, NULL);
+
+       schem->placeOnMap(map, p, flags, (Rotation)rot, force_placement);
 
        lua_pushboolean(L, true);
        return 1;
 }
 
+
+// place_schematic_on_vmanip(vm, p, schematic, rotation,
+//     replacements, force_placement, flagstring)
 int ModApiMapgen::l_place_schematic_on_vmanip(lua_State *L)
 {
        NO_MAP_LOCK_REQUIRED;
@@ -1437,14 +1670,14 @@ int ModApiMapgen::l_place_schematic_on_vmanip(lua_State *L)
 
        //// Read rotation
        int rot = ROTATE_0;
-       const char *enumstr = lua_tostring(L, 4);
-       if (enumstr)
+       std::string enumstr = readParam<std::string>(L, 4, "");
+       if (!enumstr.empty())
                string_to_enum(es_Rotation, rot, std::string(enumstr));
 
        //// Read force placement
        bool force_placement = true;
        if (lua_isboolean(L, 6))
-               force_placement = lua_toboolean(L, 6);
+               force_placement = readParam<bool>(L, 6);
 
        //// Read node replacements
        StringMap replace_names;
@@ -1458,13 +1691,18 @@ int ModApiMapgen::l_place_schematic_on_vmanip(lua_State *L)
                return 0;
        }
 
+       //// Read flags
+       u32 flags = 0;
+       read_flags(L, 7, flagdesc_deco, &flags, NULL);
+
        bool schematic_did_fit = schem->placeOnVManip(
-               vm, p, 0, (Rotation)rot, force_placement);
+               vm, p, flags, (Rotation)rot, force_placement);
 
        lua_pushboolean(L, schematic_did_fit);
        return 1;
 }
 
+
 // serialize_schematic(schematic, format, options={...})
 int ModApiMapgen::l_serialize_schematic(lua_State *L)
 {
@@ -1490,9 +1728,9 @@ int ModApiMapgen::l_serialize_schematic(lua_State *L)
 
        //// Read format of definition to save as
        int schem_format = SCHEM_FMT_MTS;
-       const char *enumstr = lua_tostring(L, 2);
-       if (enumstr)
-               string_to_enum(es_SchematicFormatType, schem_format, std::string(enumstr));
+       std::string enumstr = readParam<std::string>(L, 2, "");
+       if (!enumstr.empty())
+               string_to_enum(es_SchematicFormatType, schem_format, enumstr);
 
        //// Serialize to binary string
        std::ostringstream os(std::ios_base::binary);
@@ -1520,7 +1758,12 @@ int ModApiMapgen::l_serialize_schematic(lua_State *L)
 void ModApiMapgen::Initialize(lua_State *L, int top)
 {
        API_FCT(get_biome_id);
+       API_FCT(get_biome_name);
+       API_FCT(get_heat);
+       API_FCT(get_humidity);
+       API_FCT(get_biome_data);
        API_FCT(get_mapgen_object);
+       API_FCT(get_spawn_level);
 
        API_FCT(get_mapgen_params);
        API_FCT(set_mapgen_params);
@@ -1532,6 +1775,7 @@ void ModApiMapgen::Initialize(lua_State *L, int top)
        API_FCT(get_noiseparams);
        API_FCT(set_gen_notify);
        API_FCT(get_gen_notify);
+       API_FCT(get_decoration_id);
 
        API_FCT(register_biome);
        API_FCT(register_decoration);