LuaVoxelManip: Throw warning or error instead of silently doing nothing (#7567)
[oweals/minetest.git] / src / script / lua_api / l_vmanip.cpp
index 554a573430827d37a593f2670d5332587c8ac7b8..c92983bd3d332dcca373a0781fcecf48e83f4378 100644 (file)
@@ -25,12 +25,10 @@ with this program; if not, write to the Free Software Foundation, Inc.,
 #include "emerge.h"
 #include "environment.h"
 #include "map.h"
+#include "mapblock.h"
 #include "server.h"
-#include "mapgen.h"
-
-#define GET_ENV_PTR ServerEnvironment* env =                                   \
-                               dynamic_cast<ServerEnvironment*>(getEnv(L));                   \
-                               if (env == NULL) return 0
+#include "mapgen/mapgen.h"
+#include "voxelalgorithms.h"
 
 // garbage collector
 int LuaVoxelManip::gc_object(lua_State *L)
@@ -43,11 +41,13 @@ int LuaVoxelManip::gc_object(lua_State *L)
 
 int LuaVoxelManip::l_read_from_map(lua_State *L)
 {
+       MAP_LOCK_REQUIRED;
+
        LuaVoxelManip *o = checkobject(L, 1);
-       ManualMapVoxelManipulator *vm = o->vm;
+       MMVManip *vm = o->vm;
 
-       v3s16 bp1 = getNodeBlockPos(read_v3s16(L, 2));
-       v3s16 bp2 = getNodeBlockPos(read_v3s16(L, 3));
+       v3s16 bp1 = getNodeBlockPos(check_v3s16(L, 2));
+       v3s16 bp2 = getNodeBlockPos(check_v3s16(L, 3));
        sortBoxVerticies(bp1, bp2);
 
        vm->initialEmerge(bp1, bp2);
@@ -63,12 +63,18 @@ int LuaVoxelManip::l_get_data(lua_State *L)
        NO_MAP_LOCK_REQUIRED;
 
        LuaVoxelManip *o = checkobject(L, 1);
-       ManualMapVoxelManipulator *vm = o->vm;
+       bool use_buffer  = lua_istable(L, 2);
 
-       int volume = vm->m_area.getVolume();
+       MMVManip *vm = o->vm;
 
-       lua_newtable(L);
-       for (int i = 0; i != volume; i++) {
+       u32 volume = vm->m_area.getVolume();
+
+       if (use_buffer)
+               lua_pushvalue(L, 2);
+       else
+               lua_newtable(L);
+
+       for (u32 i = 0; i != volume; i++) {
                lua_Integer cid = vm->m_data[i].getContent();
                lua_pushinteger(L, cid);
                lua_rawseti(L, -2, i + 1);
@@ -82,13 +88,13 @@ int LuaVoxelManip::l_set_data(lua_State *L)
        NO_MAP_LOCK_REQUIRED;
 
        LuaVoxelManip *o = checkobject(L, 1);
-       ManualMapVoxelManipulator *vm = o->vm;
+       MMVManip *vm = o->vm;
 
        if (!lua_istable(L, 2))
-               return 0;
+               throw LuaError("VoxelManip:set_data called with missing parameter");
 
-       int volume = vm->m_area.getVolume();
-       for (int i = 0; i != volume; i++) {
+       u32 volume = vm->m_area.getVolume();
+       for (u32 i = 0; i != volume; i++) {
                lua_rawgeti(L, 2, i + 1);
                content_t c = lua_tointeger(L, -1);
 
@@ -102,34 +108,52 @@ int LuaVoxelManip::l_set_data(lua_State *L)
 
 int LuaVoxelManip::l_write_to_map(lua_State *L)
 {
+       MAP_LOCK_REQUIRED;
+
        LuaVoxelManip *o = checkobject(L, 1);
-       ManualMapVoxelManipulator *vm = o->vm;
+       bool update_light = !lua_isboolean(L, 2) || readParam<bool>(L, 2);
+       GET_ENV_PTR;
+       ServerMap *map = &(env->getServerMap());
+       if (o->is_mapgen_vm || !update_light) {
+               o->vm->blitBackAll(&(o->modified_blocks));
+       } else {
+               voxalgo::blit_back_with_light(map, o->vm,
+                       &(o->modified_blocks));
+       }
+
+       MapEditEvent event;
+       event.type = MEET_OTHER;
+       for (const auto &modified_block : o->modified_blocks)
+               event.modified_blocks.insert(modified_block.first);
 
-       vm->blitBackAll(&o->modified_blocks);
+       map->dispatchEvent(&event);
 
+       o->modified_blocks.clear();
        return 0;
 }
 
 int LuaVoxelManip::l_get_node_at(lua_State *L)
 {
        NO_MAP_LOCK_REQUIRED;
-       GET_ENV_PTR;
+
+       const NodeDefManager *ndef = getServer(L)->getNodeDefManager();
 
        LuaVoxelManip *o = checkobject(L, 1);
-       v3s16 pos        = read_v3s16(L, 2);
+       v3s16 pos        = check_v3s16(L, 2);
 
-       pushnode(L, o->vm->getNodeNoExNoEmerge(pos), env->getGameDef()->ndef());
+       pushnode(L, o->vm->getNodeNoExNoEmerge(pos), ndef);
        return 1;
 }
 
 int LuaVoxelManip::l_set_node_at(lua_State *L)
 {
        NO_MAP_LOCK_REQUIRED;
-       GET_ENV_PTR;
+
+       const NodeDefManager *ndef = getServer(L)->getNodeDefManager();
 
        LuaVoxelManip *o = checkobject(L, 1);
-       v3s16 pos        = read_v3s16(L, 2);
-       MapNode n        = readnode(L, 3, env->getGameDef()->ndef());
+       v3s16 pos        = check_v3s16(L, 2);
+       MapNode n        = readnode(L, 3, ndef);
 
        o->vm->setNodeNoEmerge(pos, n);
 
@@ -143,8 +167,8 @@ int LuaVoxelManip::l_update_liquids(lua_State *L)
        LuaVoxelManip *o = checkobject(L, 1);
 
        Map *map = &(env->getMap());
-       INodeDefManager *ndef = getServer(L)->getNodeDefManager();
-       ManualMapVoxelManipulator *vm = o->vm;
+       const NodeDefManager *ndef = getServer(L)->getNodeDefManager();
+       MMVManip *vm = o->vm;
 
        Mapgen mg;
        mg.vm   = vm;
@@ -161,25 +185,33 @@ int LuaVoxelManip::l_calc_lighting(lua_State *L)
        NO_MAP_LOCK_REQUIRED;
 
        LuaVoxelManip *o = checkobject(L, 1);
-       if (!o->is_mapgen_vm)
+       if (!o->is_mapgen_vm) {
+               warningstream << "VoxelManip:calc_lighting called for a non-mapgen "
+                       "VoxelManip object" << std::endl;
                return 0;
+       }
 
-       INodeDefManager *ndef = getServer(L)->getNodeDefManager();
+       const NodeDefManager *ndef = getServer(L)->getNodeDefManager();
        EmergeManager *emerge = getServer(L)->getEmergeManager();
-       ManualMapVoxelManipulator *vm = o->vm;
+       MMVManip *vm = o->vm;
 
-       v3s16 p1 = lua_istable(L, 2) ? read_v3s16(L, 2) :
-               vm->m_area.MinEdge + v3s16(0, 1, 0) * MAP_BLOCKSIZE;
-       v3s16 p2 = lua_istable(L, 3) ? read_v3s16(L, 3) :
-               vm->m_area.MaxEdge - v3s16(0, 1, 0) * MAP_BLOCKSIZE;
-       sortBoxVerticies(p1, p2);
+       v3s16 yblock = v3s16(0, 1, 0) * MAP_BLOCKSIZE;
+       v3s16 fpmin  = vm->m_area.MinEdge;
+       v3s16 fpmax  = vm->m_area.MaxEdge;
+       v3s16 pmin   = lua_istable(L, 2) ? check_v3s16(L, 2) : fpmin + yblock;
+       v3s16 pmax   = lua_istable(L, 3) ? check_v3s16(L, 3) : fpmax - yblock;
+       bool propagate_shadow = !lua_isboolean(L, 4) || readParam<bool>(L, 4);
+
+       sortBoxVerticies(pmin, pmax);
+       if (!vm->m_area.contains(VoxelArea(pmin, pmax)))
+               throw LuaError("Specified voxel area out of VoxelManipulator bounds");
 
        Mapgen mg;
        mg.vm          = vm;
        mg.ndef        = ndef;
-       mg.water_level = emerge->params.water_level;
+       mg.water_level = emerge->mgparams->water_level;
 
-       mg.calcLighting(p1, p2);
+       mg.calcLighting(pmin, pmax, fpmin, fpmax, propagate_shadow);
 
        return 0;
 }
@@ -189,28 +221,33 @@ int LuaVoxelManip::l_set_lighting(lua_State *L)
        NO_MAP_LOCK_REQUIRED;
 
        LuaVoxelManip *o = checkobject(L, 1);
-       if (!o->is_mapgen_vm)
+       if (!o->is_mapgen_vm) {
+               warningstream << "VoxelManip:set_lighting called for a non-mapgen "
+                       "VoxelManip object" << std::endl;
                return 0;
+       }
 
        if (!lua_istable(L, 2))
-               return 0;
+               throw LuaError("VoxelManip:set_lighting called with missing parameter");
 
        u8 light;
        light  = (getintfield_default(L, 2, "day",   0) & 0x0F);
        light |= (getintfield_default(L, 2, "night", 0) & 0x0F) << 4;
 
-       ManualMapVoxelManipulator *vm = o->vm;
+       MMVManip *vm = o->vm;
+
+       v3s16 yblock = v3s16(0, 1, 0) * MAP_BLOCKSIZE;
+       v3s16 pmin = lua_istable(L, 3) ? check_v3s16(L, 3) : vm->m_area.MinEdge + yblock;
+       v3s16 pmax = lua_istable(L, 4) ? check_v3s16(L, 4) : vm->m_area.MaxEdge - yblock;
 
-       v3s16 p1 = lua_istable(L, 3) ? read_v3s16(L, 3) :
-               vm->m_area.MinEdge + v3s16(0, 1, 0) * MAP_BLOCKSIZE;
-       v3s16 p2 = lua_istable(L, 4) ? read_v3s16(L, 4) :
-               vm->m_area.MaxEdge - v3s16(0, 1, 0) * MAP_BLOCKSIZE;
-       sortBoxVerticies(p1, p2);
+       sortBoxVerticies(pmin, pmax);
+       if (!vm->m_area.contains(VoxelArea(pmin, pmax)))
+               throw LuaError("Specified voxel area out of VoxelManipulator bounds");
 
        Mapgen mg;
        mg.vm = vm;
 
-       mg.setLighting(p1, p2, light);
+       mg.setLighting(light, pmin, pmax);
 
        return 0;
 }
@@ -220,12 +257,12 @@ int LuaVoxelManip::l_get_light_data(lua_State *L)
        NO_MAP_LOCK_REQUIRED;
 
        LuaVoxelManip *o = checkobject(L, 1);
-       ManualMapVoxelManipulator *vm = o->vm;
+       MMVManip *vm = o->vm;
 
-       int volume = vm->m_area.getVolume();
+       u32 volume = vm->m_area.getVolume();
 
        lua_newtable(L);
-       for (int i = 0; i != volume; i++) {
+       for (u32 i = 0; i != volume; i++) {
                lua_Integer light = vm->m_data[i].param1;
                lua_pushinteger(L, light);
                lua_rawseti(L, -2, i + 1);
@@ -239,13 +276,14 @@ int LuaVoxelManip::l_set_light_data(lua_State *L)
        NO_MAP_LOCK_REQUIRED;
 
        LuaVoxelManip *o = checkobject(L, 1);
-       ManualMapVoxelManipulator *vm = o->vm;
+       MMVManip *vm = o->vm;
 
        if (!lua_istable(L, 2))
-               return 0;
+               throw LuaError("VoxelManip:set_light_data called with missing "
+                               "parameter");
 
-       int volume = vm->m_area.getVolume();
-       for (int i = 0; i != volume; i++) {
+       u32 volume = vm->m_area.getVolume();
+       for (u32 i = 0; i != volume; i++) {
                lua_rawgeti(L, 2, i + 1);
                u8 light = lua_tointeger(L, -1);
 
@@ -262,12 +300,18 @@ int LuaVoxelManip::l_get_param2_data(lua_State *L)
        NO_MAP_LOCK_REQUIRED;
 
        LuaVoxelManip *o = checkobject(L, 1);
-       ManualMapVoxelManipulator *vm = o->vm;
+       bool use_buffer  = lua_istable(L, 2);
 
-       int volume = vm->m_area.getVolume();
+       MMVManip *vm = o->vm;
 
-       lua_newtable(L);
-       for (int i = 0; i != volume; i++) {
+       u32 volume = vm->m_area.getVolume();
+
+       if (use_buffer)
+               lua_pushvalue(L, 2);
+       else
+               lua_newtable(L);
+
+       for (u32 i = 0; i != volume; i++) {
                lua_Integer param2 = vm->m_data[i].param2;
                lua_pushinteger(L, param2);
                lua_rawseti(L, -2, i + 1);
@@ -281,13 +325,14 @@ int LuaVoxelManip::l_set_param2_data(lua_State *L)
        NO_MAP_LOCK_REQUIRED;
 
        LuaVoxelManip *o = checkobject(L, 1);
-       ManualMapVoxelManipulator *vm = o->vm;
+       MMVManip *vm = o->vm;
 
        if (!lua_istable(L, 2))
-               return 0;
+               throw LuaError("VoxelManip:set_param2_data called with missing "
+                               "parameter");
 
-       int volume = vm->m_area.getVolume();
-       for (int i = 0; i != volume; i++) {
+       u32 volume = vm->m_area.getVolume();
+       for (u32 i = 0; i != volume; i++) {
                lua_rawgeti(L, 2, i + 1);
                u8 param2 = lua_tointeger(L, -1);
 
@@ -301,35 +346,6 @@ int LuaVoxelManip::l_set_param2_data(lua_State *L)
 
 int LuaVoxelManip::l_update_map(lua_State *L)
 {
-       LuaVoxelManip *o = checkobject(L, 1);
-       if (o->is_mapgen_vm)
-               return 0;
-
-       Environment *env = getEnv(L);
-       if (!env)
-               return 0;
-
-       Map *map = &(env->getMap());
-
-       // TODO: Optimize this by using Mapgen::calcLighting() instead
-       std::map<v3s16, MapBlock *> lighting_mblocks;
-       std::map<v3s16, MapBlock *> *mblocks = &o->modified_blocks;
-
-       lighting_mblocks.insert(mblocks->begin(), mblocks->end());
-
-       map->updateLighting(lighting_mblocks, *mblocks);
-
-       MapEditEvent event;
-       event.type = MEET_OTHER;
-       for (std::map<v3s16, MapBlock *>::iterator
-               it = mblocks->begin();
-               it != mblocks->end(); ++it)
-               event.modified_blocks.insert(it->first);
-
-       map->dispatchEvent(&event);
-
-       mblocks->clear();
-
        return 0;
 }
 
@@ -338,23 +354,43 @@ int LuaVoxelManip::l_was_modified(lua_State *L)
        NO_MAP_LOCK_REQUIRED;
 
        LuaVoxelManip *o = checkobject(L, 1);
-       ManualMapVoxelManipulator *vm = o->vm;
+       MMVManip *vm = o->vm;
 
        lua_pushboolean(L, vm->m_is_dirty);
 
        return 1;
 }
 
-LuaVoxelManip::LuaVoxelManip(ManualMapVoxelManipulator *mmvm, bool is_mg_vm)
+int LuaVoxelManip::l_get_emerged_area(lua_State *L)
+{
+       NO_MAP_LOCK_REQUIRED;
+
+       LuaVoxelManip *o = checkobject(L, 1);
+
+       push_v3s16(L, o->vm->m_area.MinEdge);
+       push_v3s16(L, o->vm->m_area.MaxEdge);
+
+       return 2;
+}
+
+LuaVoxelManip::LuaVoxelManip(MMVManip *mmvm, bool is_mg_vm) :
+       is_mapgen_vm(is_mg_vm),
+       vm(mmvm)
 {
-       this->vm           = mmvm;
-       this->is_mapgen_vm = is_mg_vm;
 }
 
-LuaVoxelManip::LuaVoxelManip(Map *map)
+LuaVoxelManip::LuaVoxelManip(Map *map) : vm(new MMVManip(map))
 {
-       this->vm = new ManualMapVoxelManipulator(map);
-       this->is_mapgen_vm = false;
+}
+
+LuaVoxelManip::LuaVoxelManip(Map *map, v3s16 p1, v3s16 p2)
+{
+       vm = new MMVManip(map);
+
+       v3s16 bp1 = getNodeBlockPos(p1);
+       v3s16 bp2 = getNodeBlockPos(p2);
+       sortBoxVerticies(bp1, bp2);
+       vm->initialEmerge(bp1, bp2);
 }
 
 LuaVoxelManip::~LuaVoxelManip()
@@ -367,14 +403,12 @@ LuaVoxelManip::~LuaVoxelManip()
 // Creates an LuaVoxelManip and leaves it on top of stack
 int LuaVoxelManip::create_object(lua_State *L)
 {
-       NO_MAP_LOCK_REQUIRED;
-
-       Environment *env = getEnv(L);
-       if (!env)
-               return 0;
+       GET_ENV_PTR;
 
        Map *map = &(env->getMap());
-       LuaVoxelManip *o = new LuaVoxelManip(map);
+       LuaVoxelManip *o = (lua_istable(L, 1) && lua_istable(L, 2)) ?
+               new LuaVoxelManip(map, check_v3s16(L, 1), check_v3s16(L, 2)) :
+               new LuaVoxelManip(map);
 
        *(void **)(lua_newuserdata(L, sizeof(void *))) = o;
        luaL_getmetatable(L, className);
@@ -424,7 +458,7 @@ void LuaVoxelManip::Register(lua_State *L)
 }
 
 const char LuaVoxelManip::className[] = "VoxelManip";
-const luaL_reg LuaVoxelManip::methods[] = {
+const luaL_Reg LuaVoxelManip::methods[] = {
        luamethod(LuaVoxelManip, read_from_map),
        luamethod(LuaVoxelManip, get_data),
        luamethod(LuaVoxelManip, set_data),
@@ -440,5 +474,6 @@ const luaL_reg LuaVoxelManip::methods[] = {
        luamethod(LuaVoxelManip, get_param2_data),
        luamethod(LuaVoxelManip, set_param2_data),
        luamethod(LuaVoxelManip, was_modified),
+       luamethod(LuaVoxelManip, get_emerged_area),
        {0,0}
 };