Update API docs

[worldedit.git] / worldedit / compatibility.lua

diff --git a/worldedit/compatibility.lua b/worldedit/compatibility.lua
index e44e43b98e76f4d24f3eaf35af1b30d666dcc54f..c989a05805b8bfba07dc581c7d0ad8c57394258b 100644 (file)
--- a/worldedit/compatibility.lua
+++ b/worldedit/compatibility.lua
@@ -1,11 +1,21 @@
-worldedit = worldedit or {}\r
-local minetest = minetest --local copy of global\r
+--- Compatibility functions.\r
+-- @module worldedit.compatibility\r
+\r
+local function deprecated(new_func)\r
+       local info = debug.getinfo(1, "n")\r
+       local msg = "worldedit." .. info.name .. "() is deprecated."\r
+       if new_func then\r
+               msg = msg .. "  Use worldedit." .. new_func .. "() instead."\r
+       end\r
+       minetest.log("deprecated", msg)\r
+end\r
 \r
 worldedit.allocate_old = worldedit.allocate\r
 \r
 worldedit.deserialize_old = worldedit.deserialize\r
 \r
-worldedit.metasave = function(pos1, pos2, filename)\r
+function worldedit.metasave(pos1, pos2, filename)\r
+       deprecated("save")\r
        local file, err = io.open(filename, "wb")\r
        if err then return 0 end\r
        local data, count = worldedit.serialize(pos1, pos2)\r
@@ -14,7 +24,8 @@ worldedit.metasave = function(pos1, pos2, filename)
        return count\r
 end\r
 \r
-worldedit.metaload = function(originpos, filename)\r
+function worldedit.metaload(originpos, filename)\r
+       deprecated("load")\r
        filename = minetest.get_worldpath() .. "/schems/" .. file .. ".wem"\r
        local file, err = io.open(filename, "wb")\r
        if err then return 0 end\r
@@ -22,11 +33,13 @@ worldedit.metaload = function(originpos, filename)
        return worldedit.deserialize(originpos, data)\r
 end\r
 \r
-worldedit.scale = function(pos1, pos2, factor)\r
+function worldedit.scale(pos1, pos2, factor)\r
+       deprecated("stretch")\r
        return worldedit.stretch(pos1, pos2, factor, factor, factor)\r
 end\r
 \r
-worldedit.valueversion = function(value)\r
+function worldedit.valueversion(value)\r
+       deprecated("read_header")\r
        local version = worldedit.read_header(value)\r
        if not version or version > worldedit.LATEST_SERIALIZATION_VERSION then\r
                return 0\r
@@ -34,3 +47,28 @@ worldedit.valueversion = function(value)
        return version\r
 end\r
 \r
+function worldedit.replaceinverse(pos1, pos2, search_node, replace_node)\r
+       deprecated("replace")\r
+       return worldedit.replace(pos1, pos2, search_node, replace_node, true)\r
+end\r
+\r
+function worldedit.clearobjects(...)\r
+       deprecated("clear_objects")\r
+       return worldedit.clear_objects(...)\r
+end\r
+\r
+function worldedit.hollow_sphere(pos, radius, node_name)\r
+       deprecated("sphere")\r
+       return worldedit.sphere(pos, radius, node_name, true)\r
+end\r
+\r
+function worldedit.hollow_dome(pos, radius, node_name)\r
+       deprecated("dome")\r
+       return worldedit.dome(pos, radius, node_name, true)\r
+end\r
+\r
+function worldedit.hollow_cylinder(pos, axis, length, radius, node_name)\r
+       deprecated("cylinder")\r
+       return worldedit.cylinder(pos, axis, length, radius, node_name, true)\r
+end\r
+\r