From bb8456b71119ca6303b9e9706829a84dc7f81ab3 Mon Sep 17 00:00:00 2001 From: ShadowNinja Date: Wed, 29 Oct 2014 22:47:08 -0400 Subject: Cleanup and fixup Non-stylistic changes: * Add LuaDoc/LDoc support. * Fix `clear_objects` area size calculation. * Fix `clear_objects` removing player objects. * Fix shadowing of marker entity name with player name. * Make visualization functions use `swap_node`. * Make hidden nodes unwalkable. * Prevent `hide` from hiding air. * Make deprecated functions log to deprecated stream when called. * Fixed `replaceinverse` not using normalized node names. * Added .gitignore. * Bump version to 1.1. Stylistic changes: * Change `x = function` to `function x`. * Change comment format. * Make missing VoxelManip error less obnoxious. * Move `sort_pos` into `common.lua`, which is a required module. * Remove local copies of `minetest`. * Remove `worldedit = worldedit or {}` from modules. * Replace replaceinverse with an inverse argument to `replace`. * Added `error()`s on on invalid axes. * Change `wip` to `TODO`. * Rename `clearobjects` to `clear_objects`. * Remove `hollow_{sphere,dome,cylinder}` and replace them with a hollow parameter to each function. * Add helpers to reduce code duplication. * Renamed `Chat Commands.md` to `ChatCommands.md`. --- worldedit/visualization.lua | 145 ++++++++++++++++++++------------------------ 1 file changed, 67 insertions(+), 78 deletions(-) (limited to 'worldedit/visualization.lua') diff --git a/worldedit/visualization.lua b/worldedit/visualization.lua index dbee5d0..5ac49f3 100644 --- a/worldedit/visualization.lua +++ b/worldedit/visualization.lua @@ -1,57 +1,38 @@ -worldedit = worldedit or {} -local minetest = minetest --local copy of global - ---modifies positions `pos1` and `pos2` so that each component of `pos1` is less than or equal to its corresponding conent of `pos2`, returning two new positions -worldedit.sort_pos = function(pos1, pos2) - pos1 = {x=pos1.x, y=pos1.y, z=pos1.z} - pos2 = {x=pos2.x, y=pos2.y, z=pos2.z} - if pos1.x > pos2.x then - pos2.x, pos1.x = pos1.x, pos2.x - end - if pos1.y > pos2.y then - pos2.y, pos1.y = pos1.y, pos2.y - end - if pos1.z > pos2.z then - pos2.z, pos1.z = pos1.z, pos2.z - end - return pos1, pos2 -end - ---determines the volume of the region defined by positions `pos1` and `pos2`, returning the volume -worldedit.volume = function(pos1, pos2) - local pos1, pos2 = worldedit.sort_pos(pos1, pos2) - return (pos2.x - pos1.x + 1) * (pos2.y - pos1.y + 1) * (pos2.z - pos1.z + 1) -end +--- Functions for visibly hiding nodes +-- @module worldedit.visualization minetest.register_node("worldedit:placeholder", { drawtype = "airlike", paramtype = "light", sunlight_propagates = true, diggable = false, + walkable = false, groups = {not_in_creative_inventory=1}, }) ---hides all nodes in a region defined by positions `pos1` and `pos2` by non-destructively replacing them with invisible nodes, returning the number of nodes hidden -worldedit.hide = function(pos1, pos2) - --make area stay loaded - local manip = minetest.get_voxel_manip() - manip:read_from_map(pos1, pos2) +--- Hides all nodes in a region defined by positions `pos1` and `pos2` by +-- non-destructively replacing them with invisible nodes. +-- @return The number of nodes hidden. +function worldedit.hide(pos1, pos2) + pos1, pos2 = worldedit.sort_pos(pos1, pos2) + + worldedit.keep_loaded(pos1, pos2) - local pos1, pos2 = worldedit.sort_pos(pos1, pos2) local pos = {x=pos1.x, y=0, z=0} - local get_node, get_meta, add_node = minetest.get_node, minetest.get_meta, minetest.add_node + local get_node, get_meta, swap_node = minetest.get_node, + minetest.get_meta, minetest.swap_node while pos.x <= pos2.x do pos.y = pos1.y while pos.y <= pos2.y do pos.z = pos1.z while pos.z <= pos2.z do local node = get_node(pos) - if node.name ~= "worldedit:placeholder" then - local data = get_meta(pos):to_table() --obtain metadata of original node - data.fields.worldedit_placeholder = node.name --add the node's name - node.name = "worldedit:placeholder" --set node name - add_node(pos, node) --add placeholder node - get_meta(pos):from_table(data) --set placeholder metadata to the original node's metadata + if node.name ~= "air" and node.name ~= "worldedit:placeholder" then + -- Save the node's original name + get_meta(pos):set_string("worldedit_placeholder", node.name) + -- Swap in placeholder node + node.name = "worldedit:placeholder" + swap_node(pos, node) end pos.z = pos.z + 1 end @@ -62,40 +43,44 @@ worldedit.hide = function(pos1, pos2) return worldedit.volume(pos1, pos2) end ---suppresses all instances of `nodename` in a region defined by positions `pos1` and `pos2` by non-destructively replacing them with invisible nodes, returning the number of nodes suppressed -worldedit.suppress = function(pos1, pos2, nodename) - --ignore placeholder supression - if nodename == "worldedit:placeholder" then +--- Suppresses all instances of `node_name` in a region defined by positions +-- `pos1` and `pos2` by non-destructively replacing them with invisible nodes. +-- @return The number of nodes suppressed. +function worldedit.suppress(pos1, pos2, node_name) + -- Ignore placeholder supression + if node_name == "worldedit:placeholder" then return 0 end - --make area stay loaded - local manip = minetest.get_voxel_manip() - manip:read_from_map(pos1, pos2) + pos1, pos2 = worldedit.sort_pos(pos1, pos2) - local pos1, pos2 = worldedit.sort_pos(pos1, pos2) - local nodes = minetest.find_nodes_in_area(pos1, pos2, nodename) - local get_node, get_meta, add_node = minetest.get_node, minetest.get_meta, minetest.add_node + worldedit.keep_loaded(pos1, pos2) + + local nodes = minetest.find_nodes_in_area(pos1, pos2, node_name) + local get_node, get_meta, swap_node = minetest.get_node, + minetest.get_meta, minetest.swap_node for _, pos in ipairs(nodes) do local node = get_node(pos) - local data = get_meta(pos):to_table() --obtain metadata of original node - data.fields.worldedit_placeholder = node.name --add the node's name - node.name = "worldedit:placeholder" --set node name - add_node(pos, node) --add placeholder node - get_meta(pos):from_table(data) --set placeholder metadata to the original node's metadata + -- Save the node's original name + get_meta(pos):set_string("worldedit_placeholder", node.name) + -- Swap in placeholder node + node.name = "worldedit:placeholder" + swap_node(pos, node) end return #nodes end ---highlights all instances of `nodename` in a region defined by positions `pos1` and `pos2` by non-destructively hiding all other nodes, returning the number of nodes found -worldedit.highlight = function(pos1, pos2, nodename) - --make area stay loaded - local manip = minetest.get_voxel_manip() - manip:read_from_map(pos1, pos2) +--- Highlights all instances of `node_name` in a region defined by positions +-- `pos1` and `pos2` by non-destructively hiding all other nodes. +-- @return The number of nodes found. +function worldedit.highlight(pos1, pos2, node_name) + pos1, pos2 = worldedit.sort_pos(pos1, pos2) + + worldedit.keep_loaded(pos1, pos2) - local pos1, pos2 = worldedit.sort_pos(pos1, pos2) local pos = {x=pos1.x, y=0, z=0} - local get_node, get_meta, add_node = minetest.get_node, minetest.get_meta, minetest.add_node + local get_node, get_meta, swap_node = minetest.get_node, + minetest.get_meta, minetest.swap_node local count = 0 while pos.x <= pos2.x do pos.y = pos1.y @@ -103,14 +88,14 @@ worldedit.highlight = function(pos1, pos2, nodename) pos.z = pos1.z while pos.z <= pos2.z do local node = get_node(pos) - if node.name == nodename then --node found + if node.name == node_name then -- Node found count = count + 1 - elseif node.name ~= "worldedit:placeholder" then --hide other nodes - local data = get_meta(pos):to_table() --obtain metadata of original node - data.fields.worldedit_placeholder = node.name --add the node's name - node.name = "worldedit:placeholder" --set node name - add_node(pos, node) --add placeholder node - get_meta(pos):from_table(data) --set placeholder metadata to the original node's metadata + elseif node.name ~= "worldedit:placeholder" then -- Hide other nodes + -- Save the node's original name + get_meta(pos):set_string("worldedit_placeholder", node.name) + -- Swap in placeholder node + node.name = "worldedit:placeholder" + swap_node(pos, node) end pos.z = pos.z + 1 end @@ -121,22 +106,26 @@ worldedit.highlight = function(pos1, pos2, nodename) return count end ---restores all nodes hidden with WorldEdit functions in a region defined by positions `pos1` and `pos2`, returning the number of nodes restored -worldedit.restore = function(pos1, pos2) - --make area stay loaded - local manip = minetest.get_voxel_manip() - manip:read_from_map(pos1, pos2) - +-- Restores all nodes hidden with WorldEdit functions in a region defined +-- by positions `pos1` and `pos2`. +-- @return The number of nodes restored. +function worldedit.restore(pos1, pos2) local pos1, pos2 = worldedit.sort_pos(pos1, pos2) + + worldedit.keep_loaded(pos1, pos2) + local nodes = minetest.find_nodes_in_area(pos1, pos2, "worldedit:placeholder") - local get_node, get_meta, add_node = minetest.get_node, minetest.get_meta, minetest.add_node + local get_node, get_meta, swap_node = minetest.get_node, + minetest.get_meta, minetest.swap_node for _, pos in ipairs(nodes) do local node = get_node(pos) - local data = get_meta(pos):to_table() --obtain node metadata - node.name = data.fields.worldedit_placeholder --set node name - data.fields.worldedit_placeholder = nil --delete old nodename - add_node(pos, node) --add original node - get_meta(pos):from_table(data) --set original node metadata + local meta = get_meta(pos) + local data = meta:to_table() + node.name = data.fields.worldedit_placeholder + data.fields.worldedit_placeholder = nil + meta:from_table(data) + swap_node(pos, node) end return #nodes end + -- cgit v1.2.3