1 --- Generic node manipulations.
\r
2 -- @module worldedit.manipulations
\r
4 local mh = worldedit.manip_helpers
\r
7 --- Sets a region to `node_names`.
\r
10 -- @param node_names Node name or list of node names.
\r
11 -- @return The number of nodes set.
\r
12 function worldedit.set(pos1, pos2, node_names)
\r
13 pos1, pos2 = worldedit.sort_pos(pos1, pos2)
\r
15 local manip, area = mh.init(pos1, pos2)
\r
16 local data = mh.get_empty_data(area)
\r
18 if type(node_names) == "string" then -- Only one type of node
\r
19 local id = minetest.get_content_id(node_names)
\r
20 -- Fill area with node
\r
21 for i in area:iterp(pos1, pos2) do
\r
24 else -- Several types of nodes specified
\r
26 for i, v in ipairs(node_names) do
\r
27 node_ids[i] = minetest.get_content_id(v)
\r
29 -- Fill area randomly with nodes
\r
30 local id_count, rand = #node_ids, math.random
\r
31 for i in area:iterp(pos1, pos2) do
\r
32 data[i] = node_ids[rand(id_count)]
\r
36 mh.finish(manip, data)
\r
38 return worldedit.volume(pos1, pos2)
\r
42 --- Replaces all instances of `search_node` with `replace_node` in a region.
\r
43 -- When `inverse` is `true`, replaces all instances that are NOT `search_node`.
\r
44 -- @return The number of nodes replaced.
\r
45 function worldedit.replace(pos1, pos2, search_node, replace_node, inverse)
\r
46 local pos1, pos2 = worldedit.sort_pos(pos1, pos2)
\r
48 local manip, area = mh.init(pos1, pos2)
\r
49 local data = manip:get_data()
\r
51 local search_id = minetest.get_content_id(search_node)
\r
52 local replace_id = minetest.get_content_id(replace_node)
\r
56 --- TODO: This could be shortened by checking `inverse` in the loop,
\r
57 -- but that would have a speed penalty. Is the penalty big enough
\r
60 for i in area:iterp(pos1, pos2) do
\r
61 if data[i] == search_id then
\r
62 data[i] = replace_id
\r
67 for i in area:iterp(pos1, pos2) do
\r
68 if data[i] ~= search_id then
\r
69 data[i] = replace_id
\r
75 mh.finish(manip, data)
\r
81 --- Duplicates a region `amount` times with offset vector `direction`.
\r
82 -- Stacking is spread across server steps, one copy per step.
\r
83 -- @return The number of nodes stacked.
\r
84 function worldedit.stack2(pos1, pos2, direction, amount, finished)
\r
86 local translated = {x=0, y=0, z=0}
\r
87 local function next_one()
\r
90 translated.x = translated.x + direction.x
\r
91 translated.y = translated.y + direction.y
\r
92 translated.z = translated.z + direction.z
\r
93 worldedit.copy2(pos1, pos2, translated, volume)
\r
94 minetest.after(0, next_one)
\r
102 return worldedit.volume(pos1, pos2) * amount
\r
106 --- Copies a region along `axis` by `amount` nodes.
\r
109 -- @param axis Axis ("x", "y", or "z")
\r
111 -- @return The number of nodes copied.
\r
112 function worldedit.copy(pos1, pos2, axis, amount)
\r
113 local pos1, pos2 = worldedit.sort_pos(pos1, pos2)
\r
115 worldedit.keep_loaded(pos1, pos2)
\r
117 local get_node, get_meta, set_node = minetest.get_node,
\r
118 minetest.get_meta, minetest.set_node
\r
119 -- Copy things backwards when negative to avoid corruption.
\r
120 -- FIXME: Lots of code duplication here.
\r
124 while pos.x <= pos2.x do
\r
126 while pos.y <= pos2.y do
\r
128 while pos.z <= pos2.z do
\r
129 local node = get_node(pos) -- Obtain current node
\r
130 local meta = get_meta(pos):to_table() -- Get meta of current node
\r
131 local value = pos[axis] -- Store current position
\r
132 pos[axis] = value + amount -- Move along axis
\r
133 set_node(pos, node) -- Copy node to new position
\r
134 get_meta(pos):from_table(meta) -- Set metadata of new node
\r
135 pos[axis] = value -- Restore old position
\r
145 while pos.x >= pos1.x do
\r
147 while pos.y >= pos1.y do
\r
149 while pos.z >= pos1.z do
\r
150 local node = get_node(pos) -- Obtain current node
\r
151 local meta = get_meta(pos):to_table() -- Get meta of current node
\r
152 local value = pos[axis] -- Store current position
\r
153 pos[axis] = value + amount -- Move along axis
\r
154 set_node(pos, node) -- Copy node to new position
\r
155 get_meta(pos):from_table(meta) -- Set metadata of new node
\r
156 pos[axis] = value -- Restore old position
\r
164 return worldedit.volume(pos1, pos2)
\r
168 --- Moves a region along `axis` by `amount` nodes.
\r
169 -- @return The number of nodes moved.
\r
170 function worldedit.move(pos1, pos2, axis, amount)
\r
171 local pos1, pos2 = worldedit.sort_pos(pos1, pos2)
\r
173 worldedit.keep_loaded(pos1, pos2)
\r
175 --- TODO: Move slice by slice using schematic method in the move axis
\r
176 -- and transfer metadata in separate loop (and if the amount is
\r
177 -- greater than the length in the axis, copy whole thing at a time and
\r
178 -- erase original after, using schematic method).
\r
179 local get_node, get_meta, set_node, remove_node = minetest.get_node,
\r
180 minetest.get_meta, minetest.set_node, minetest.remove_node
\r
181 -- Copy things backwards when negative to avoid corruption.
\r
182 --- FIXME: Lots of code duplication here.
\r
186 while pos.x <= pos2.x do
\r
188 while pos.y <= pos2.y do
\r
190 while pos.z <= pos2.z do
\r
191 local node = get_node(pos) -- Obtain current node
\r
192 local meta = get_meta(pos):to_table() -- Get metadata of current node
\r
193 remove_node(pos) -- Remove current node
\r
194 local value = pos[axis] -- Store current position
\r
195 pos[axis] = value + amount -- Move along axis
\r
196 set_node(pos, node) -- Move node to new position
\r
197 get_meta(pos):from_table(meta) -- Set metadata of new node
\r
198 pos[axis] = value -- Restore old position
\r
208 while pos.x >= pos1.x do
\r
210 while pos.y >= pos1.y do
\r
212 while pos.z >= pos1.z do
\r
213 local node = get_node(pos) -- Obtain current node
\r
214 local meta = get_meta(pos):to_table() -- Get metadata of current node
\r
215 remove_node(pos) -- Remove current node
\r
216 local value = pos[axis] -- Store current position
\r
217 pos[axis] = value + amount -- Move along axis
\r
218 set_node(pos, node) -- Move node to new position
\r
219 get_meta(pos):from_table(meta) -- Set metadata of new node
\r
220 pos[axis] = value -- Restore old position
\r
228 return worldedit.volume(pos1, pos2)
\r
232 --- Duplicates a region along `axis` `amount` times.
\r
233 -- Stacking is spread across server steps, one copy per step.
\r
236 -- @param axis Axis direction, "x", "y", or "z".
\r
238 -- @return The number of nodes stacked.
\r
239 function worldedit.stack(pos1, pos2, axis, count)
\r
240 local pos1, pos2 = worldedit.sort_pos(pos1, pos2)
\r
241 local length = pos2[axis] - pos1[axis] + 1
\r
247 local copy = worldedit.copy
\r
249 function next_one()
\r
252 amount = amount + length
\r
253 copy(pos1, pos2, axis, amount)
\r
254 minetest.after(0, next_one)
\r
258 return worldedit.volume(pos1, pos2) * count
\r
262 --- Stretches a region by a factor of positive integers along the X, Y, and Z
\r
263 -- axes, respectively, with `pos1` as the origin.
\r
266 -- @param stretch_x Amount to stretch along X axis.
\r
267 -- @param stretch_y Amount to stretch along Y axis.
\r
268 -- @param stretch_z Amount to stretch along Z axis.
\r
269 -- @return The number of nodes scaled.
\r
270 -- @return The new scaled position 1.
\r
271 -- @return The new scaled position 2.
\r
272 function worldedit.stretch(pos1, pos2, stretch_x, stretch_y, stretch_z)
\r
273 local pos1, pos2 = worldedit.sort_pos(pos1, pos2)
\r
275 -- Prepare schematic of large node
\r
276 local get_node, get_meta, place_schematic = minetest.get_node,
\r
277 minetest.get_meta, minetest.place_schematic
\r
278 local placeholder_node = {name="", param1=255, param2=0}
\r
280 for i = 1, stretch_x * stretch_y * stretch_z do
\r
281 nodes[i] = placeholder_node
\r
283 local schematic = {size={x=stretch_x, y=stretch_y, z=stretch_z}, data=nodes}
\r
285 local size_x, size_y, size_z = stretch_x - 1, stretch_y - 1, stretch_z - 1
\r
288 x = pos1.x + (pos2.x - pos1.x) * stretch_x + size_x,
\r
289 y = pos1.y + (pos2.y - pos1.y) * stretch_y + size_y,
\r
290 z = pos1.z + (pos2.z - pos1.z) * stretch_z + size_z,
\r
292 worldedit.keep_loaded(pos1, new_pos2)
\r
294 local pos = {x=pos2.x, y=0, z=0}
\r
295 local big_pos = {x=0, y=0, z=0}
\r
296 while pos.x >= pos1.x do
\r
298 while pos.y >= pos1.y do
\r
300 while pos.z >= pos1.z do
\r
301 local node = get_node(pos) -- Get current node
\r
302 local meta = get_meta(pos):to_table() -- Get meta of current node
\r
304 -- Calculate far corner of the big node
\r
305 local pos_x = pos1.x + (pos.x - pos1.x) * stretch_x
\r
306 local pos_y = pos1.y + (pos.y - pos1.y) * stretch_y
\r
307 local pos_z = pos1.z + (pos.z - pos1.z) * stretch_z
\r
309 -- Create large node
\r
310 placeholder_node.name = node.name
\r
311 placeholder_node.param2 = node.param2
\r
312 big_pos.x, big_pos.y, big_pos.z = pos_x, pos_y, pos_z
\r
313 place_schematic(big_pos, schematic)
\r
315 -- Fill in large node meta
\r
316 if next(meta.fields) ~= nil or next(meta.inventory) ~= nil then
\r
317 -- Node has meta fields
\r
318 for x = 0, size_x do
\r
319 for y = 0, size_y do
\r
320 for z = 0, size_z do
\r
321 big_pos.x = pos_x + x
\r
322 big_pos.y = pos_y + y
\r
323 big_pos.z = pos_z + z
\r
324 -- Set metadata of new node
\r
325 get_meta(big_pos):from_table(meta)
\r
336 return worldedit.volume(pos1, pos2) * stretch_x * stretch_y * stretch_z, pos1, new_pos2
\r
340 --- Transposes a region between two axes.
\r
341 -- @return The number of nodes transposed.
\r
342 -- @return The new transposed position 1.
\r
343 -- @return The new transposed position 2.
\r
344 function worldedit.transpose(pos1, pos2, axis1, axis2)
\r
345 local pos1, pos2 = worldedit.sort_pos(pos1, pos2)
\r
348 local extent1, extent2 = pos2[axis1] - pos1[axis1], pos2[axis2] - pos1[axis2]
\r
350 if extent1 > extent2 then
\r
351 compare = function(extent1, extent2)
\r
352 return extent1 > extent2
\r
355 compare = function(extent1, extent2)
\r
356 return extent1 < extent2
\r
360 -- Calculate the new position 2 after transposition
\r
361 local new_pos2 = {x=pos2.x, y=pos2.y, z=pos2.z}
\r
362 new_pos2[axis1] = pos1[axis1] + extent2
\r
363 new_pos2[axis2] = pos1[axis2] + extent1
\r
365 local upper_bound = {x=pos2.x, y=pos2.y, z=pos2.z}
\r
366 if upper_bound[axis1] < new_pos2[axis1] then upper_bound[axis1] = new_pos2[axis1] end
\r
367 if upper_bound[axis2] < new_pos2[axis2] then upper_bound[axis2] = new_pos2[axis2] end
\r
368 worldedit.keep_loaded(pos1, upper_bound)
\r
370 local pos = {x=pos1.x, y=0, z=0}
\r
371 local get_node, get_meta, set_node = minetest.get_node,
\r
372 minetest.get_meta, minetest.set_node
\r
373 while pos.x <= pos2.x do
\r
375 while pos.y <= pos2.y do
\r
377 while pos.z <= pos2.z do
\r
378 local extent1, extent2 = pos[axis1] - pos1[axis1], pos[axis2] - pos1[axis2]
\r
379 if compare(extent1, extent2) then -- Transpose only if below the diagonal
\r
380 local node1 = get_node(pos)
\r
381 local meta1 = get_meta(pos):to_table()
\r
382 local value1, value2 = pos[axis1], pos[axis2] -- Save position values
\r
383 pos[axis1], pos[axis2] = pos1[axis1] + extent2, pos1[axis2] + extent1 -- Swap axis extents
\r
384 local node2 = get_node(pos)
\r
385 local meta2 = get_meta(pos):to_table()
\r
386 set_node(pos, node1)
\r
387 get_meta(pos):from_table(meta1)
\r
388 pos[axis1], pos[axis2] = value1, value2 -- Restore position values
\r
389 set_node(pos, node2)
\r
390 get_meta(pos):from_table(meta2)
\r
398 return worldedit.volume(pos1, pos2), pos1, new_pos2
\r
402 --- Flips a region along `axis`.
\r
403 -- @return The number of nodes flipped.
\r
404 function worldedit.flip(pos1, pos2, axis)
\r
405 local pos1, pos2 = worldedit.sort_pos(pos1, pos2)
\r
407 worldedit.keep_loaded(pos1, pos2)
\r
409 --- TODO: Flip the region slice by slice along the flip axis using schematic method.
\r
410 local pos = {x=pos1.x, y=0, z=0}
\r
411 local start = pos1[axis] + pos2[axis]
\r
412 pos2[axis] = pos1[axis] + math.floor((pos2[axis] - pos1[axis]) / 2)
\r
413 local get_node, get_meta, set_node = minetest.get_node,
\r
414 minetest.get_meta, minetest.set_node
\r
415 while pos.x <= pos2.x do
\r
417 while pos.y <= pos2.y do
\r
419 while pos.z <= pos2.z do
\r
420 local node1 = get_node(pos)
\r
421 local meta1 = get_meta(pos):to_table()
\r
422 local value = pos[axis] -- Save position
\r
423 pos[axis] = start - value -- Shift position
\r
424 local node2 = get_node(pos)
\r
425 local meta2 = get_meta(pos):to_table()
\r
426 set_node(pos, node1)
\r
427 get_meta(pos):from_table(meta1)
\r
428 pos[axis] = value -- Restore position
\r
429 set_node(pos, node2)
\r
430 get_meta(pos):from_table(meta2)
\r
437 return worldedit.volume(pos1, pos2)
\r
441 --- Rotates a region clockwise around an axis.
\r
444 -- @param axis Axis ("x", "y", or "z").
\r
445 -- @param angle Angle in degrees (90 degree increments only).
\r
446 -- @return The number of nodes rotated.
\r
447 -- @return The new first position.
\r
448 -- @return The new second position.
\r
449 function worldedit.rotate(pos1, pos2, axis, angle)
\r
450 local pos1, pos2 = worldedit.sort_pos(pos1, pos2)
\r
452 local other1, other2 = worldedit.get_axis_others(axis)
\r
453 angle = angle % 360
\r
456 if angle == 90 then
\r
457 worldedit.flip(pos1, pos2, other1)
\r
458 count, pos1, pos2 = worldedit.transpose(pos1, pos2, other1, other2)
\r
459 elseif angle == 180 then
\r
460 worldedit.flip(pos1, pos2, other1)
\r
461 count = worldedit.flip(pos1, pos2, other2)
\r
462 elseif angle == 270 then
\r
463 worldedit.flip(pos1, pos2, other2)
\r
464 count, pos1, pos2 = worldedit.transpose(pos1, pos2, other1, other2)
\r
466 error("Only 90 degree increments are supported!")
\r
468 return count, pos1, pos2
\r
472 --- Rotates all oriented nodes in a region clockwise around the Y axis.
\r
475 -- @param angle Angle in degrees (90 degree increments only).
\r
476 -- @return The number of nodes oriented.
\r
477 -- TODO: Support 6D facedir rotation along arbitrary axis.
\r
478 function worldedit.orient(pos1, pos2, angle)
\r
479 local pos1, pos2 = worldedit.sort_pos(pos1, pos2)
\r
480 local registered_nodes = minetest.registered_nodes
\r
482 local wallmounted = {
\r
483 [90] = {[0]=0, 1, 5, 4, 2, 3},
\r
484 [180] = {[0]=0, 1, 3, 2, 5, 4},
\r
485 [270] = {[0]=0, 1, 4, 5, 3, 2}
\r
488 [90] = {[0]=1, 2, 3, 0},
\r
489 [180] = {[0]=2, 3, 0, 1},
\r
490 [270] = {[0]=3, 0, 1, 2}
\r
493 angle = angle % 360
\r
497 if angle % 90 ~= 0 then
\r
498 error("Only 90 degree increments are supported!")
\r
500 local wallmounted_substitution = wallmounted[angle]
\r
501 local facedir_substitution = facedir[angle]
\r
503 worldedit.keep_loaded(pos1, pos2)
\r
506 local get_node, get_meta, swap_node = minetest.get_node,
\r
507 minetest.get_meta, minetest.swap_node
\r
508 local pos = {x=pos1.x, y=0, z=0}
\r
509 while pos.x <= pos2.x do
\r
511 while pos.y <= pos2.y do
\r
513 while pos.z <= pos2.z do
\r
514 local node = get_node(pos)
\r
515 local def = registered_nodes[node.name]
\r
517 if def.paramtype2 == "wallmounted" then
\r
518 node.param2 = wallmounted_substitution[node.param2]
\r
519 local meta = get_meta(pos):to_table()
\r
520 set_node(pos, node)
\r
521 get_meta(pos):from_table(meta)
\r
523 elseif def.paramtype2 == "facedir" then
\r
524 node.param2 = facedir_substitution[node.param2]
\r
525 local meta = get_meta(pos):to_table()
\r
526 set_node(pos, node)
\r
527 get_meta(pos):from_table(meta)
\r
541 --- Attempts to fix the lighting in a region.
\r
542 -- @return The number of nodes updated.
\r
543 function worldedit.fixlight(pos1, pos2)
\r
544 local pos1, pos2 = worldedit.sort_pos(pos1, pos2)
\r
546 worldedit.keep_loaded(pos1, pos2)
\r
548 local nodes = minetest.find_nodes_in_area(pos1, pos2, "air")
\r
549 local dig_node = minetest.dig_node
\r
550 for _, pos in ipairs(nodes) do
\r
557 --- Clears all objects in a region.
\r
558 -- @return The number of objects cleared.
\r
559 function worldedit.clear_objects(pos1, pos2)
\r
560 pos1, pos2 = worldedit.sort_pos(pos1, pos2)
\r
562 worldedit.keep_loaded(pos1, pos2)
\r
564 -- Offset positions to include full nodes (positions are in the center of nodes)
\r
565 local pos1x, pos1y, pos1z = pos1.x - 0.5, pos1.y - 0.5, pos1.z - 0.5
\r
566 local pos2x, pos2y, pos2z = pos2.x + 0.5, pos2.y + 0.5, pos2.z + 0.5
\r
568 -- Center of region
\r
570 x = pos1x + ((pos2x - pos1x) / 2),
\r
571 y = pos1y + ((pos2y - pos1y) / 2),
\r
572 z = pos1z + ((pos2z - pos1z) / 2)
\r
574 -- Bounding sphere radius
\r
575 local radius = math.sqrt(
\r
576 (center.x - pos1x) ^ 2 +
\r
577 (center.y - pos1y) ^ 2 +
\r
578 (center.z - pos1z) ^ 2)
\r
580 for _, obj in pairs(minetest.get_objects_inside_radius(center, radius)) do
\r
581 local entity = obj:get_luaentity()
\r
582 -- Avoid players and WorldEdit entities
\r
583 if not obj:is_player() and (not entity or
\r
584 not entity.name:find("^worldedit:")) then
\r
585 local pos = obj:getpos()
\r
586 if pos.x >= pos1x and pos.x <= pos2x and
\r
587 pos.y >= pos1y and pos.y <= pos2y and
\r
588 pos.z >= pos1z and pos.z <= pos2z then
\r