1 local S
= minetest
.get_translator("schemedit")
2 local F
= minetest
.formspec_escape
8 local export_path_full
= table.concat({minetest
.get_worldpath(), "schems"}, DIR_DELIM
)
10 -- truncated export path so the server directory structure is not exposed publicly
11 local export_path_trunc
= table.concat({S("<world path>"), "schems"}, DIR_DELIM
)
13 local text_color
= "#D79E9E"
14 local text_color_number
= 0xD79E9E
16 local can_import
= minetest
.read_schematic
~= nil
18 schemedit
.markers
= {}
20 -- [local function] Renumber table
21 local function renumber(t
)
23 for _
, i
in pairs(t
) do
29 local NEEDED_PRIV
= "server"
30 local function check_priv(player_name
, quit
)
31 local privs
= minetest
.get_player_privs(player_name
)
32 if privs
[NEEDED_PRIV
] then
36 minetest
.chat_send_player(player_name
, minetest
.colorize("red",
37 S("Insufficient privileges! You need the “@1” privilege to use this.", NEEDED_PRIV
)))
44 local export_schematic_to_lua
46 export_schematic_to_lua
= function(schematic
, filepath
, options
)
47 if not options
then options
= {} end
48 local str
= minetest
.serialize_schematic(schematic
, "lua", options
)
49 local file
= io
.open(filepath
, "w")
69 local displayed_waypoints
= {}
71 -- Sadly, the probabilities presented in Lua (0-255) are not identical to the REAL probabilities in the
72 -- schematic file (0-127). There are two converter functions to convert from one probability type to another.
73 -- This mod tries to retain the “Lua probability” as long as possible and only switches to “schematic probability”
74 -- on an actual export to a schematic.
76 function schemedit
.lua_prob_to_schematic_prob(lua_prob
)
77 return math
.floor(lua_prob
/ 2)
80 function schemedit
.schematic_prob_to_lua_prob(schematic_prob
)
81 return schematic_prob
* 2
85 -- [function] Add form
86 function schemedit
.add_form(name
, def
)
91 tabs
[#tabs
+ 1] = name
95 -- [function] Generate tabs
96 function schemedit
.generate_tabs(current
)
97 local retval
= "tabheader[0,0;tabs;"
98 for _
, t
in pairs(tabs
) do
100 if f
.tab
~= false and f
.caption
then
101 retval
= retval
..f
.caption
..","
103 if type(current
) ~= "number" and current
== f
.name
then
108 retval
= retval
:sub(1, -2) -- Strip last comma
109 retval
= retval
..";"..current
.."]" -- Close tabheader
113 -- [function] Handle tabs
114 function schemedit
.handle_tabs(pos
, name
, fields
)
115 local tab
= tonumber(fields
.tabs
)
116 if tab
and tabs
[tab
] and forms
[tabs
[tab]]
then
117 schemedit
.show_formspec(pos
, name
, forms
[tabs
[tab]]
.name
)
122 -- [function] Show formspec
123 function schemedit
.show_formspec(pos
, player
, tab
, show
, ...)
125 if type(player
) == "string" then
126 player
= minetest
.get_player_by_name(player
)
128 local name
= player
:get_player_name()
130 if show
~= false then
131 if not form_data
[name
] then
135 local form
= forms
[tab
].get(form_data
[name
], pos
, name
, ...)
136 if forms
[tab
].tab
then
137 form
= form
..schemedit
.generate_tabs(tab
)
140 minetest
.show_formspec(name
, "schemedit:"..tab
, form
)
143 -- Update player attribute
144 if forms
[tab
].cache_name
~= false then
145 local pmeta
= player
:get_meta()
146 pmeta
:set_string("schemedit:tab", tab
)
149 minetest
.close_formspec(pname
, "schemedit:"..tab
)
154 -- [event] On receive fields
155 minetest
.register_on_player_receive_fields(function(player
, formname
, fields
)
156 local formname
= formname
:split(":")
158 if formname
[1] == "schemedit" and forms
[formname
[2]]
then
159 local handle
= forms
[formname
[2]]
.handle
160 local name
= player
:get_player_name()
161 if contexts
[name
] then
162 if not form_data
[name
] then
166 if not schemedit
.handle_tabs(contexts
[name
], name
, fields
) and handle
then
167 handle(form_data
[name
], contexts
[name
], name
, fields
)
173 -- Helper function. Scans probabilities of all nodes in the given area and returns a prob_list
174 schemedit
.scan_metadata
= function(pos1
, pos2
)
177 for x
=pos1
.x
, pos2
.x
do
178 for y
=pos1
.y
, pos2
.y
do
179 for z
=pos1
.z
, pos2
.z
do
180 local scanpos
= {x
=x
, y
=y
, z
=z
}
181 local node
= minetest
.get_node_or_nil(scanpos
)
183 local prob
, force_place
184 if node
== nil or node
.name
== "schemedit:void" then
188 local meta
= minetest
.get_meta(scanpos
)
190 prob
= tonumber(meta
:get_string("schemedit_prob")) or 255
191 local fp
= meta
:get_string("schemedit_force_place")
199 local hashpos
= minetest
.hash_node_position(scanpos
)
200 prob_list
[hashpos
] = {
203 force_place
= force_place
,
212 -- Sets probability and force_place metadata of an item.
213 -- Also updates item description.
214 -- The itemstack is updated in-place.
215 local function set_item_metadata(itemstack
, prob
, force_place
)
216 local smeta
= itemstack
:get_meta()
217 local prob_desc
= "\n"..S("Probability: @1", prob
or
218 smeta
:get_string("schemedit_prob") or S("Not Set"))
219 -- Update probability
220 if prob
and prob
>= 0 and prob
< 255 then
221 smeta
:set_string("schemedit_prob", tostring(prob
))
222 elseif prob
and prob
== 255 then
223 -- Clear prob metadata for default probability
225 smeta
:set_string("schemedit_prob", nil)
227 prob_desc
= "\n"..S("Probability: @1", smeta
:get_string("schemedit_prob") or
231 -- Update force place
232 if force_place
== true then
233 smeta
:set_string("schemedit_force_place", "true")
234 elseif force_place
== false then
235 smeta
:set_string("schemedit_force_place", nil)
238 -- Update description
239 local desc
= minetest
.registered_items
[itemstack
:get_name()].description
240 local meta_desc
= smeta
:get_string("description")
241 if meta_desc
and meta_desc
~= "" then
245 local original_desc
= smeta
:get_string("original_description")
246 if original_desc
and original_desc
~= "" then
249 smeta
:set_string("original_description", desc
)
252 local force_desc
= ""
253 if smeta
:get_string("schemedit_force_place") == "true" then
254 force_desc
= "\n"..S("Force placement")
257 desc
= desc
..minetest
.colorize(text_color
, prob_desc
..force_desc
)
259 smeta
:set_string("description", desc
)
267 local import_btn
= ""
269 import_btn
= "button[0.5,2.5;6,1;import;"..F(S("Import schematic")).."]"
271 schemedit
.add_form("main", {
274 get
= function(self
, pos
, name
)
275 local meta
= minetest
.get_meta(pos
):to_table().fields
276 local strpos
= minetest
.pos_to_string(pos
)
277 local hashpos
= minetest
.hash_node_position(pos
)
280 if meta
.schem_border
== "true" and schemedit
.markers
[hashpos
] then
281 border_button
= "button[3.5,7.5;3,1;border;"..F(S("Hide border")).."]"
283 border_button
= "button[3.5,7.5;3,1;border;"..F(S("Show border")).."]"
286 local xs
, ys
, zs
= meta
.x_size
or 1, meta
.y_size
or 1, meta
.z_size
or 1
287 local size
= {x
=xs
, y
=ys
, z
=zs
}
288 local schem_name
= meta
.schem_name
or ""
292 label[0.5,-0.1;]]..F(S("Position: @1", strpos
))..[[]
293 label[3,-0.1;]]..F(S("Owner: @1", name
))..[[]
294 label[0.5,0.4;]]..F(S("Schematic name: @1", F(schem_name
)))..[[]
295 label[0.5,0.9;]]..F(S("Size: @1", minetest
.pos_to_string(size
)))..[[]
297 field[0.8,2;5,1;name;]]..F(S("Schematic name:"))..[[;]]..F(schem_name
or "")..[[]
298 button[5.3,1.69;1.2,1;save_name;]]..F(S("OK"))..[[]
299 tooltip[save_name;]]..F(S("Save schematic name"))..[[]
300 field_close_on_enter[name;false]
302 button[0.5,3.5;6,1;export;]]..F(S("Export schematic")).."]"..
304 textarea[0.8,4.5;6.2,1;;]]..F(S("Export/import path:\n@1",
305 export_path_trunc
.. DIR_DELIM
.. F(S("<name>"))..".mts"))..[[;]
306 button[0.5,5.5;3,1;air2void;]]..F(S("Air to voids"))..[[]
307 button[3.5,5.5;3,1;void2air;]]..F(S("Voids to air"))..[[]
308 tooltip[air2void;]]..F(S("Turn all air nodes into schematic void nodes"))..[[]
309 tooltip[void2air;]]..F(S("Turn all schematic void nodes into air nodes"))..[[]
310 field[0.8,7;2,1;x;]]..F(S("X size:"))..[[;]]..xs
..[[]
311 field[2.8,7;2,1;y;]]..F(S("Y size:"))..[[;]]..ys
..[[]
312 field[4.8,7;2,1;z;]]..F(S("Z size:"))..[[;]]..zs
..[[]
313 field_close_on_enter[x;false]
314 field_close_on_enter[y;false]
315 field_close_on_enter[z;false]
316 button[0.5,7.5;3,1;save;]]..F(S("Save size"))..[[]
319 if minetest
.get_modpath("doc") then
320 form
= form
.. "image_button[6.4,-0.2;0.8,0.8;doc_button_icon_lores.png;doc;]" ..
321 "tooltip[doc;"..F(S("Help")).."]"
325 handle
= function(self
, pos
, name
, fields
)
327 doc
.show_entry(name
, "nodes", "schemedit:creator", true)
331 if not check_priv(name
, fields
.quit
) then
335 local realmeta
= minetest
.get_meta(pos
)
336 local meta
= realmeta
:to_table().fields
337 local hashpos
= minetest
.hash_node_position(pos
)
339 -- Save size vector values
340 if (fields
.x
and fields
.x
~= "") then
341 local x
= tonumber(fields
.x
)
343 meta
.x_size
= math
.max(x
, 1)
346 if (fields
.y
and fields
.y
~= "") then
347 local y
= tonumber(fields
.y
)
349 meta
.y_size
= math
.max(y
, 1)
352 if (fields
.z
and fields
.z
~= "") then
353 local z
= tonumber(fields
.z
)
355 meta
.z_size
= math
.max(z
, 1)
359 -- Save schematic name
361 meta
.schem_name
= fields
.name
365 if (fields
.air2void
) then
366 local pos1
, pos2
= schemedit
.size(pos
)
367 pos1
, pos2
= schemedit
.sort_pos(pos1
, pos2
)
368 local nodes
= minetest
.find_nodes_in_area(pos1
, pos2
, {"air"})
369 minetest
.bulk_set_node(nodes
, {name
="schemedit:void"})
371 elseif (fields
.void2air
) then
372 local pos1
, pos2
= schemedit
.size(pos
)
373 pos1
, pos2
= schemedit
.sort_pos(pos1
, pos2
)
374 local nodes
= minetest
.find_nodes_in_area(pos1
, pos2
, {"schemedit:void"})
375 minetest
.bulk_set_node(nodes
, {name
="air"})
380 if fields
.border
then
381 if meta
.schem_border
== "true" and schemedit
.markers
[hashpos
] then
382 schemedit
.unmark(pos
)
383 meta
.schem_border
= "false"
386 meta
.schem_border
= "true"
391 if fields
.export
and meta
.schem_name
and meta
.schem_name
~= "" then
392 local pos1
, pos2
= schemedit
.size(pos
)
393 pos1
, pos2
= schemedit
.sort_pos(pos1
, pos2
)
394 local path
= export_path_full
.. DIR_DELIM
397 local plist
= schemedit
.scan_metadata(pos1
, pos2
)
398 local probability_list
= {}
399 for hash
, i
in pairs(plist
) do
400 local prob
= schemedit
.lua_prob_to_schematic_prob(i
.prob
)
401 if i
.force_place
== true then
405 table.insert(probability_list
, {
406 pos
= minetest
.get_position_from_hash(hash
),
411 local slist
= minetest
.deserialize(meta
.slices
)
412 local slice_list
= {}
413 for _
, i
in pairs(slist
) do
414 slice_list
[#slice_list
+ 1] = {
415 ypos
= pos
.y
+ i
.ypos
,
416 prob
= schemedit
.lua_prob_to_schematic_prob(i
.prob
),
420 local filepath
= path
..meta
.schem_name
..".mts"
421 local res
= minetest
.create_schematic(pos1
, pos2
, probability_list
, filepath
, slice_list
)
424 minetest
.chat_send_player(name
, minetest
.colorize("#00ff00",
425 S("Exported schematic to @1", filepath
)))
426 -- Additional export to Lua file if MTS export was successful
427 local schematic
= minetest
.read_schematic(filepath
, {})
428 if schematic
and minetest
.settings
:get_bool("schemedit_export_lua") then
429 local filepath_lua
= path
..meta
.schem_name
..".lua"
430 res
= export_schematic_to_lua(schematic
, filepath_lua
)
432 minetest
.chat_send_player(name
, minetest
.colorize("#00ff00",
433 S("Exported schematic to @1", filepath_lua
)))
437 minetest
.chat_send_player(name
, minetest
.colorize("red",
438 S("Failed to export schematic to @1", filepath
)))
443 if fields
.import
and meta
.schem_name
and meta
.schem_name
~= "" then
444 if not can_import
then
448 local node
= minetest
.get_node(pos
)
449 local path
= export_path_full
.. DIR_DELIM
451 local filepath
= path
..meta
.schem_name
..".mts"
452 local schematic
= minetest
.read_schematic(filepath
, {write_yslice_prob
="low"})
453 local success
= false
456 meta
.x_size
= schematic
.size
.x
457 meta
.y_size
= schematic
.size
.y
458 meta
.z_size
= schematic
.size
.z
459 meta
.slices
= minetest
.serialize(schematic
.yslice_prob
)
460 local special_x_size
= meta
.x_size
461 local special_y_size
= meta
.y_size
462 local special_z_size
= meta
.z_size
464 if node
.param2
== 1 then
465 pos1
= vector
.add(pos
, {x
=1,y
=0,z
=-meta
.z_size
+1})
466 meta
.x_size
, meta
.z_size
= meta
.z_size
, meta
.x_size
467 elseif node
.param2
== 2 then
468 pos1
= vector
.add(pos
, {x
=-meta
.x_size
+1,y
=0,z
=-meta
.z_size
})
469 elseif node
.param2
== 3 then
470 pos1
= vector
.add(pos
, {x
=-meta
.x_size
,y
=0,z
=0})
471 meta
.x_size
, meta
.z_size
= meta
.z_size
, meta
.x_size
473 pos1
= vector
.add(pos
, {x
=0,y
=0,z
=1})
476 local schematic_for_meta
= table.copy(schematic
)
477 -- Strip probability data for placement
478 schematic
.yslice_prob
= {}
479 for d
=1, #schematic
.data
do
480 schematic
.data
[d
].prob
= nil
484 success
= minetest
.place_schematic(pos1
, schematic
, "0", nil, true)
486 -- Add special schematic data to nodes
489 for z
=0, special_z_size
-1 do
490 for y
=0, special_y_size
-1 do
491 for x
=0, special_x_size
-1 do
492 local data
= schematic_for_meta
.data
[d
]
493 local pp
= {x
=pos1
.x
+x
, y
=pos1
.y
+y
, z
=pos1
.z
+z
}
494 if data
.prob
== 0 then
495 minetest
.set_node(pp
, {name
="schemedit:void"})
497 local meta
= minetest
.get_meta(pp
)
498 if data
.prob
and data
.prob
~= 255 and data
.prob
~= 254 then
499 meta
:set_string("schemedit_prob", tostring(data
.prob
))
501 meta
:set_string("schemedit_prob", "")
503 if data
.force_place
then
504 meta
:set_string("schemedit_force_place", "true")
506 meta
:set_string("schemedit_force_place", "")
516 minetest
.chat_send_player(name
, minetest
.colorize("#00ff00",
517 S("Imported schematic from @1", filepath
)))
519 minetest
.chat_send_player(name
, minetest
.colorize("red",
520 S("Failed to import schematic from @1", filepath
)))
526 -- Save meta before updating visuals
527 local inv
= realmeta
:get_inventory():get_lists()
528 realmeta
:from_table({fields
= meta
, inventory
= inv
})
531 if not fields
.border
and meta
.schem_border
== "true" then
536 if not fields
.quit
then
537 schemedit
.show_formspec(pos
, minetest
.get_player_by_name(name
), "main")
542 schemedit
.add_form("slice", {
543 caption
= S("Y Slices"),
545 get
= function(self
, pos
, name
, visible_panel
)
546 local meta
= minetest
.get_meta(pos
):to_table().fields
548 self
.selected
= self
.selected
or 1
549 local selected
= tostring(self
.selected
)
550 local slice_list
= minetest
.deserialize(meta
.slices
)
552 for _
, i
in pairs(slice_list
) do
553 local insert
= F(S("Y = @1; Probability = @2", tostring(i
.ypos
), tostring(i
.prob
)))
554 slices
= slices
..insert
..","
556 slices
= slices
:sub(1, -2) -- Remove final comma
560 table[0,0;6.8,6;slices;]]..slices
..[[;]]..selected
..[[]
563 if self
.panel_add
or self
.panel_edit
then
564 local ypos_default
, prob_default
= "", ""
565 local done_button
= "button[5,7.18;2,1;done_add;"..F(S("Done")).."]"
566 if self
.panel_edit
then
567 done_button
= "button[5,7.18;2,1;done_edit;"..F(S("Done")).."]"
568 if slice_list
[self
.selected
] then
569 ypos_default
= slice_list
[self
.selected
].ypos
570 prob_default
= slice_list
[self
.selected
].prob
575 field[0.3,7.5;2.5,1;ypos;]]..F(S("Y position (max. @1):", (meta
.y_size
- 1)))..[[;]]..ypos_default
..[[]
576 field[2.8,7.5;2.5,1;prob;]]..F(S("Probability (0-255):"))..[[;]]..prob_default
..[[]
577 field_close_on_enter[ypos;false]
578 field_close_on_enter[prob;false]
582 if not self
.panel_edit
then
583 form
= form
.."button[0,6;2.4,1;add;"..F(S("Add slice")).."]"
586 if slices
~= "" and self
.selected
and not self
.panel_add
then
587 if not self
.panel_edit
then
589 button[2.4,6;2.4,1;remove;]]..F(S("Remove slice"))..[[]
590 button[4.8,6;2.4,1;edit;]]..F(S("Edit slice"))..[[]
594 button[2.4,6;2.4,1;remove;]]..F(S("Remove slice"))..[[]
595 button[4.8,6;2.4,1;edit;]]..F(S("Edit slice"))..[[]
602 handle
= function(self
, pos
, name
, fields
)
603 if not check_priv(name
, fields
.quit
) then
607 local meta
= minetest
.get_meta(pos
)
608 local player
= minetest
.get_player_by_name(name
)
610 if fields
.slices
then
611 local slices
= fields
.slices
:split(":")
612 self
.selected
= tonumber(slices
[2])
616 if not self
.panel_add
then
617 self
.panel_add
= true
618 schemedit
.show_formspec(pos
, player
, "slice")
621 schemedit
.show_formspec(pos
, player
, "slice")
625 local ypos
, prob
= tonumber(fields
.ypos
), tonumber(fields
.prob
)
626 if (fields
.done_add
or fields
.done_edit
) and fields
.ypos
and fields
.prob
and
627 fields
.ypos
~= "" and fields
.prob
~= "" and ypos
and prob
and
628 ypos
<= (meta
:get_int("y_size") - 1) and prob
>= 0 and prob
<= 255 then
629 local slice_list
= minetest
.deserialize(meta
:get_string("slices"))
630 local index
= #slice_list
+ 1
631 if fields
.done_edit
then
632 index
= self
.selected
635 slice_list
[index
] = {ypos
= ypos
, prob
= prob
}
637 meta
:set_string("slices", minetest
.serialize(slice_list
))
639 -- Update and show formspec
641 schemedit
.show_formspec(pos
, player
, "slice")
644 if fields
.remove and self
.selected
then
645 local slice_list
= minetest
.deserialize(meta
:get_string("slices"))
646 slice_list
[self
.selected
] = nil
647 meta
:set_string("slices", minetest
.serialize(renumber(slice_list
)))
651 self
.panel_edit
= nil
652 schemedit
.show_formspec(pos
, player
, "slice")
656 if not self
.panel_edit
then
657 self
.panel_edit
= true
658 schemedit
.show_formspec(pos
, player
, "slice")
660 self
.panel_edit
= nil
661 schemedit
.show_formspec(pos
, player
, "slice")
667 schemedit
.add_form("probtool", {
669 caption
= S("Schematic Node Probability Tool"),
670 get
= function(self
, pos
, name
)
671 local player
= minetest
.get_player_by_name(name
)
675 local probtool
= player
:get_wielded_item()
676 if probtool
:get_name() ~= "schemedit:probtool" then
680 local meta
= probtool
:get_meta()
681 local prob
= tonumber(meta
:get_string("schemedit_prob"))
682 local force_place
= meta
:get_string("schemedit_force_place")
687 if force_place
== nil or force_place
== "" then
688 force_place
= "false"
690 local form
= "size[5,4]"..
691 "label[0,0;"..F(S("Schematic Node Probability Tool")).."]"..
692 "field[0.75,1;4,1;prob;"..F(S("Probability (0-255)"))..";"..prob
.."]"..
693 "checkbox[0.60,1.5;force_place;"..F(S("Force placement"))..";" .. force_place
.. "]" ..
694 "button_exit[0.25,3;2,1;cancel;"..F(S("Cancel")).."]"..
695 "button_exit[2.75,3;2,1;submit;"..F(S("Apply")).."]"..
696 "tooltip[prob;"..F(S("Probability that the node will be placed")).."]"..
697 "tooltip[force_place;"..F(S("If enabled, the node will replace nodes other than air and ignore")).."]"..
698 "field_close_on_enter[prob;false]"
701 handle
= function(self
, pos
, name
, fields
)
702 if not check_priv(name
, fields
.quit
) then
706 if fields
.submit
then
707 local prob
= tonumber(fields
.prob
)
709 local player
= minetest
.get_player_by_name(name
)
713 local probtool
= player
:get_wielded_item()
714 if probtool
:get_name() ~= "schemedit:probtool" then
718 local force_place
= self
.force_place
== true
720 set_item_metadata(probtool
, prob
, force_place
)
722 -- Repurpose the tool's wear bar to display the set probability
723 probtool
:set_wear(math
.floor(((255-prob
)/255)*65535))
725 player
:set_wielded_item(probtool
)
728 if fields
.force_place
== "true" then
729 self
.force_place
= true
730 elseif fields
.force_place
== "false" then
731 self
.force_place
= false
740 --- Copies and modifies positions `pos1` and `pos2` so that each component of
741 -- `pos1` is less than or equal to the corresponding component of `pos2`.
742 -- Returns the new positions.
743 function schemedit
.sort_pos(pos1
, pos2
)
744 if not pos1
or not pos2
then
748 pos1
, pos2
= table.copy(pos1
), table.copy(pos2
)
749 if pos1
.x
> pos2
.x
then
750 pos2
.x
, pos1
.x
= pos1
.x
, pos2
.x
752 if pos1
.y
> pos2
.y
then
753 pos2
.y
, pos1
.y
= pos1
.y
, pos2
.y
755 if pos1
.z
> pos2
.z
then
756 pos2
.z
, pos1
.z
= pos1
.z
, pos2
.z
761 -- [function] Prepare size
762 function schemedit
.size(pos
)
763 local pos1
= vector
.new(pos
)
764 local meta
= minetest
.get_meta(pos
)
765 local node
= minetest
.get_node(pos
)
766 local param2
= node
.param2
768 x
= meta
:get_int("x_size"),
769 y
= math
.max(meta
:get_int("y_size") - 1, 0),
770 z
= meta
:get_int("z_size"),
774 local new_pos
= vector
.add({x
= size
.z
, y
= size
.y
, z
= -size
.x
}, pos
)
776 new_pos
.z
= new_pos
.z
+ 1
778 elseif param2
== 2 then
779 local new_pos
= vector
.add({x
= -size
.x
, y
= size
.y
, z
= -size
.z
}, pos
)
781 new_pos
.x
= new_pos
.x
+ 1
783 elseif param2
== 3 then
784 local new_pos
= vector
.add({x
= -size
.z
, y
= size
.y
, z
= size
.x
}, pos
)
786 new_pos
.z
= new_pos
.z
- 1
789 local new_pos
= vector
.add(size
, pos
)
791 new_pos
.x
= new_pos
.x
- 1
796 -- [function] Mark region
797 function schemedit
.mark(pos
)
798 schemedit
.unmark(pos
)
800 local id
= minetest
.hash_node_position(pos
)
801 local owner
= minetest
.get_meta(pos
):get_string("owner")
802 local pos1
, pos2
= schemedit
.size(pos
)
803 pos1
, pos2
= schemedit
.sort_pos(pos1
, pos2
)
805 local thickness
= 0.2
806 local sizex
, sizey
, sizez
= (1 + pos2
.x
- pos1
.x
) / 2, (1 + pos2
.y
- pos1
.y
) / 2, (1 + pos2
.z
- pos1
.z
) / 2
812 for _
, z
in ipairs({pos1
.z
- 0.5, pos2
.z
+ 0.5}) do
818 local marker
= minetest
.add_entity({x
= pos1
.x
+ sizex
- 0.5, y
= pos1
.y
+ sizey
- 0.5, z
= z
+ offset
}, "schemedit:display")
819 if marker
~= nil then
820 marker
:set_properties({
821 visual_size
={x
=(sizex
+0.01) * 2, y
=(sizey
+0.01) * 2},
823 marker
:get_luaentity().id
= id
824 marker
:get_luaentity().owner
= owner
825 table.insert(m
, marker
)
832 for _
, x
in ipairs({pos1
.x
- 0.5, pos2
.x
+ 0.5}) do
839 local marker
= minetest
.add_entity({x
= x
+ offset
, y
= pos1
.y
+ sizey
- 0.5, z
= pos1
.z
+ sizez
- 0.5}, "schemedit:display")
840 if marker
~= nil then
841 marker
:set_properties({
842 visual_size
={x
=(sizez
+0.01) * 2, y
=(sizey
+0.01) * 2},
844 marker
:set_rotation({x
=0, y
=math
.pi
/ 2, z
=0})
845 marker
:get_luaentity().id
= id
846 marker
:get_luaentity().owner
= owner
847 table.insert(m
, marker
)
854 for _
, y
in ipairs({pos1
.y
- 0.5, pos2
.y
+ 0.5}) do
861 local marker
= minetest
.add_entity({x
= pos1
.x
+ sizex
- 0.5, y
= y
+ offset
, z
= pos1
.z
+ sizez
- 0.5}, "schemedit:display")
862 if marker
~= nil then
863 marker
:set_properties({
864 visual_size
={x
=(sizex
+0.01) * 2, y
=(sizez
+0.01) * 2},
866 marker
:set_rotation({x
=math
.pi
/2, y
=0, z
=0})
867 marker
:get_luaentity().id
= id
868 marker
:get_luaentity().owner
= owner
869 table.insert(m
, marker
)
876 schemedit
.markers
[id
] = m
880 -- [function] Unmark region
881 function schemedit
.unmark(pos
)
882 local id
= minetest
.hash_node_position(pos
)
883 if schemedit
.markers
[id
] then
885 for _
, entity
in ipairs(schemedit
.markers
[id
]) do
894 --- Mark node probability values near player
897 -- Show probability and force_place status of a particular position for player in HUD.
898 -- Probability is shown as a number followed by “[F]” if the node is force-placed.
899 -- The distance to the node is also displayed below that. This can't be avoided and is
900 -- and artifact of the waypoint HUD element.
901 function schemedit
.display_node_prob(player
, pos
, prob
, force_place
)
903 if prob
and force_place
== true then
904 wpstring
= string.format("%s [F]", prob
)
905 elseif prob
and type(tonumber(prob
)) == "number" then
907 elseif force_place
== true then
911 return player
:hud_add({
912 hud_elem_type
= "waypoint",
915 text
= "m", -- For the distance artifact
916 number = text_color_number
,
922 -- Display the node probabilities and force_place status of the nodes in a region.
923 -- By default, this is done for nodes near the player (distance: 5).
924 -- But the boundaries can optionally be set explicitly with pos1 and pos2.
925 function schemedit
.display_node_probs_region(player
, pos1
, pos2
)
926 local playername
= player
:get_player_name()
927 local pos
= vector
.round(player
:get_pos())
930 -- Default: 5 nodes away from player in any direction
932 pos1
= vector
.subtract(pos
, dist
)
935 pos2
= vector
.add(pos
, dist
)
937 for x
=pos1
.x
, pos2
.x
do
938 for y
=pos1
.y
, pos2
.y
do
939 for z
=pos1
.z
, pos2
.z
do
940 local checkpos
= {x
=x
, y
=y
, z
=z
}
941 local nodehash
= minetest
.hash_node_position(checkpos
)
943 -- If node is already displayed, remove it so it can re replaced later
944 if displayed_waypoints
[playername
][nodehash
] then
945 player
:hud_remove(displayed_waypoints
[playername
][nodehash
])
946 displayed_waypoints
[playername
][nodehash
] = nil
949 local prob
, force_place
950 local meta
= minetest
.get_meta(checkpos
)
951 prob
= meta
:get_string("schemedit_prob")
952 force_place
= meta
:get_string("schemedit_force_place") == "true"
953 local hud_id
= schemedit
.display_node_prob(player
, checkpos
, prob
, force_place
)
955 displayed_waypoints
[playername
][nodehash
] = hud_id
956 displayed_waypoints
[playername
].display_active
= true
963 -- Remove all active displayed node statuses.
964 function schemedit
.clear_displayed_node_probs(player
)
965 local playername
= player
:get_player_name()
966 for nodehash
, hud_id
in pairs(displayed_waypoints
[playername
]) do
967 player
:hud_remove(hud_id
)
968 displayed_waypoints
[playername
][nodehash
] = nil
969 displayed_waypoints
[playername
].display_active
= false
973 minetest
.register_on_joinplayer(function(player
)
974 displayed_waypoints
[player
:get_player_name()] = {
975 display_active
= false -- If true, there *might* be at least one active node prob HUD display
976 -- If false, no node probabilities are displayed for sure.
980 minetest
.register_on_leaveplayer(function(player
)
981 displayed_waypoints
[player
:get_player_name()] = nil
984 -- Regularily clear the displayed node probabilities and force_place
985 -- for all players who do not wield the probtool.
986 -- This makes sure the screen is not spammed with information when it
989 minetest
.register_globalstep(function(dtime
)
990 cleartimer
= cleartimer
+ dtime
991 if cleartimer
> 2 then
992 local players
= minetest
.get_connected_players()
993 for p
= 1, #players
do
994 local player
= players
[p
]
995 local pname
= player
:get_player_name()
996 if displayed_waypoints
[pname
].display_active
then
997 local item
= player
:get_wielded_item()
998 if item
:get_name() ~= "schemedit:probtool" then
999 schemedit
.clear_displayed_node_probs(player
)
1011 -- [priv] schematic_override
1012 minetest
.register_privilege("schematic_override", {
1013 description
= S("Allows you to access schemedit nodes not owned by you"),
1014 give_to_singleplayer
= false,
1017 local help_import
= ""
1019 help_import
= S("Importing a schematic will load a schematic from the world directory, place it in front of the schematic creator and sets probability and force-place data accordingly.").."\n"
1022 -- [node] Schematic creator
1023 minetest
.register_node("schemedit:creator", {
1024 description
= S("Schematic Creator"),
1025 _doc_items_longdesc
= S("The schematic creator is used to save a region of the world into a schematic file (.mts)."),
1026 _doc_items_usagehelp
= S("To get started, place the block facing directly in front of any bottom left corner of the structure you want to save. This block can only be accessed by the placer or by anyone with the “schematic_override” privilege.").."\n"..
1027 S("To save a region, use the block, enter the size and a schematic name and hit “Export schematic”. The file will always be saved in the world directory. Note you can use this name in the /placeschem command to place the schematic again.").."\n\n"..
1029 S("The other features of the schematic creator are optional and are used to allow to add randomness and fine-tuning.").."\n\n"..
1030 S("Y slices are used to remove entire slices based on chance. For each slice of the schematic region along the Y axis, you can specify that it occurs only with a certain chance. In the Y slice tab, you have to specify the Y slice height (0 = bottom) and a probability from 0 to 255 (255 is for 100%). By default, all Y slices occur always.").."\n\n"..
1031 S("With a schematic node probability tool, you can set a probability for each node and enable them to overwrite all nodes when placed as schematic. This tool must be used prior to the file export."),
1032 tiles
= {"schemedit_creator_top.png", "schemedit_creator_bottom.png",
1033 "schemedit_creator_sides.png"},
1034 groups
= { dig_immediate
= 2},
1035 paramtype2
= "facedir",
1036 is_ground_content
= false,
1038 after_place_node
= function(pos
, player
)
1039 local name
= player
:get_player_name()
1040 local meta
= minetest
.get_meta(pos
)
1042 meta
:set_string("owner", name
)
1043 meta
:set_string("infotext", S("Schematic Creator").."\n"..S("(owned by @1)", name
))
1044 meta
:set_string("prob_list", minetest
.serialize({}))
1045 meta
:set_string("slices", minetest
.serialize({}))
1047 local node
= minetest
.get_node(pos
)
1048 local dir
= minetest
.facedir_to_dir(node
.param2
)
1050 meta
:set_int("x_size", 1)
1051 meta
:set_int("y_size", 1)
1052 meta
:set_int("z_size", 1)
1054 -- Don't take item from itemstack
1057 can_dig
= function(pos
, player
)
1058 local name
= player
:get_player_name()
1059 local meta
= minetest
.get_meta(pos
)
1060 if meta
:get_string("owner") == name
or
1061 minetest
.check_player_privs(player
, "schematic_override") == true then
1067 on_rightclick
= function(pos
, node
, player
)
1068 local meta
= minetest
.get_meta(pos
)
1069 local name
= player
:get_player_name()
1070 if meta
:get_string("owner") == name
or
1071 minetest
.check_player_privs(player
, "schematic_override") == true then
1072 -- Get player attribute
1073 local pmeta
= player
:get_meta()
1074 local tab
= pmeta
:get_string("schemedit:tab")
1075 if not forms
[tab
] or not tab
then
1079 schemedit
.show_formspec(pos
, player
, tab
, true)
1082 after_destruct
= function(pos
)
1083 schemedit
.unmark(pos
)
1086 -- No support for Minetest Game's screwdriver
1090 minetest
.register_tool("schemedit:probtool", {
1091 description
= S("Schematic Node Probability Tool"),
1092 _doc_items_longdesc
=
1093 S("This is an advanced tool which only makes sense when used together with a schematic creator. It is used to finetune the way how nodes from a schematic are placed.").."\n"..
1094 S("It allows you to set two things:").."\n"..
1095 S("1) Set probability: Chance for any particular node to be actually placed (default: always placed)").."\n"..
1096 S("2) Enable force placement: These nodes replace node other than air and ignore when placed in a schematic (default: off)"),
1097 _doc_items_usagehelp
= "\n"..
1098 S("BASIC USAGE:").."\n"..
1099 S("Punch to configure the tool. Select a probability (0-255; 255 is for 100%) and enable or disable force placement. Now place the tool on any node to apply these values to the node. This information is preserved in the node until it is destroyed or changed by the tool again. This tool has no effect on schematic voids.").."\n"..
1100 S("Now you can use a schematic creator to save a region as usual, the nodes will now be saved with the special node settings applied.").."\n\n"..
1101 S("NODE HUD:").."\n"..
1102 S("To help you remember the node values, the nodes with special values are labelled in the HUD. The first line shows probability and force placement (with “[F]”). The second line is the current distance to the node. Nodes with default settings and schematic voids are not labelled.").."\n"..
1103 S("To disable the node HUD, unselect the tool or hit “place” while not pointing anything.").."\n\n"..
1104 S("UPDATING THE NODE HUD:").."\n"..
1105 S("The node HUD is not updated automatically and may be outdated. The node HUD only updates the HUD for nodes close to you whenever you place the tool or press the punch and sneak keys simutanously. If you sneak-punch a schematic creator, then the node HUD is updated for all nodes within the schematic creator's region, even if this region is very big."),
1106 wield_image
= "schemedit_probtool.png",
1107 inventory_image
= "schemedit_probtool.png",
1108 liquids_pointable
= true,
1109 groups
= { disable_repair
= 1 },
1110 on_use
= function(itemstack
, user
, pointed_thing
)
1111 local uname
= user
:get_player_name()
1112 if uname
and not check_priv(uname
) then
1116 local ctrl
= user
:get_player_control()
1118 if not ctrl
.sneak
then
1119 -- Open dialog to change the probability to apply to nodes
1120 schemedit
.show_formspec(user
:get_pos(), user
, "probtool", true)
1124 -- Display the probability and force_place values for nodes.
1126 -- If a schematic creator was punched, only enable display for all nodes
1127 -- within the creator's region.
1128 local use_creator_region
= false
1129 if pointed_thing
and pointed_thing
.type == "node" and pointed_thing
.under
then
1130 local punchpos
= pointed_thing
.under
1131 local node
= minetest
.get_node(punchpos
)
1132 if node
.name
== "schemedit:creator" then
1133 local pos1
, pos2
= schemedit
.size(punchpos
)
1134 pos1
, pos2
= schemedit
.sort_pos(pos1
, pos2
)
1135 schemedit
.display_node_probs_region(user
, pos1
, pos2
)
1140 -- Otherwise, just display the region close to the player
1141 schemedit
.display_node_probs_region(user
)
1144 on_secondary_use
= function(itemstack
, user
, pointed_thing
)
1145 local uname
= user
:get_player_name()
1146 if uname
and not check_priv(uname
) then
1150 schemedit
.clear_displayed_node_probs(user
)
1152 -- Set note probability and force_place and enable node probability display
1153 on_place
= function(itemstack
, placer
, pointed_thing
)
1154 local pname
= placer
:get_player_name()
1155 if pname
and not check_priv(pname
) then
1159 -- Use pointed node's on_rightclick function first, if present
1160 local node
= minetest
.get_node(pointed_thing
.under
)
1161 if placer
and not placer
:get_player_control().sneak
then
1162 if minetest
.registered_nodes
[node
.name
] and minetest
.registered_nodes
[node
.name
].on_rightclick
then
1163 return minetest
.registered_nodes
[node
.name
].on_rightclick(pointed_thing
.under
, node
, placer
, itemstack
) or itemstack
1167 -- This sets the node probability of pointed node to the
1168 -- currently used probability stored in the tool.
1169 local pos
= pointed_thing
.under
1170 local node
= minetest
.get_node(pos
)
1171 -- Schematic void are ignored, they always have probability 0
1172 if node
.name
== "schemedit:void" then
1175 local nmeta
= minetest
.get_meta(pos
)
1176 local imeta
= itemstack
:get_meta()
1177 local prob
= tonumber(imeta
:get_string("schemedit_prob"))
1178 local force_place
= imeta
:get_string("schemedit_force_place")
1180 if not prob
or prob
== 255 then
1181 nmeta
:set_string("schemedit_prob", nil)
1183 nmeta
:set_string("schemedit_prob", prob
)
1185 if force_place
== "true" then
1186 nmeta
:set_string("schemedit_force_place", "true")
1188 nmeta
:set_string("schemedit_force_place", nil)
1191 -- Enable node probablity display
1192 schemedit
.display_node_probs_region(placer
)
1198 minetest
.register_node("schemedit:void", {
1199 description
= S("Schematic Void"),
1200 _doc_items_longdesc
= S("This is an utility block used in the creation of schematic files. It should be used together with a schematic creator. When saving a schematic, all nodes with a schematic void will be left unchanged when the schematic is placed again. Technically, this is equivalent to a block with the node probability set to 0."),
1201 _doc_items_usagehelp
= S("Just place the schematic void like any other block and use the schematic creator to save a portion of the world."),
1202 tiles
= { "schemedit_void.png" },
1203 use_texture_alpha
= "clip",
1204 drawtype
= "nodebox",
1205 is_ground_content
= false,
1206 paramtype
= "light",
1208 sunlight_propagates
= true,
1212 { -4/16, -4/16, -4/16, 4/16, 4/16, 4/16 },
1215 groups
= { dig_immediate
= 3},
1218 -- [entity] Visible schematic border
1219 minetest
.register_entity("schemedit:display", {
1220 visual
= "upright_sprite",
1221 textures
= {"schemedit_border.png"},
1222 visual_size
= {x
=10, y
=10},
1225 static_save
= false,
1226 glow
= minetest
.LIGHT_MAX
,
1228 on_step
= function(self
, dtime
)
1230 self
.object
:remove()
1231 elseif not schemedit
.markers
[self
.id
] then
1232 self
.object
:remove()
1235 on_activate
= function(self
)
1236 self
.object
:set_armor_groups({immortal
= 1})
1240 minetest
.register_lbm({
1241 label
= "Reset schematic creator border entities",
1242 name
= "schemedit:reset_border",
1243 nodenames
= "schemedit:creator",
1244 run_at_every_load
= true,
1245 action
= function(pos
, node
)
1246 local meta
= minetest
.get_meta(pos
)
1247 meta
:set_string("schem_border", "false")
1251 local function add_suffix(schem
)
1252 -- Automatically add file name suffix if omitted
1253 local schem_full
, schem_lua
1254 if string.sub(schem
, string.len(schem
)-3, string.len(schem
)) == ".mts" then
1256 schem_lua
= string.sub(schem
, 1, -5) .. ".lua"
1258 schem_full
= schem
.. ".mts"
1259 schem_lua
= schem
.. ".lua"
1261 return schem_full
, schem_lua
1264 -- [chatcommand] Place schematic
1265 minetest
.register_chatcommand("placeschem", {
1266 description
= S("Place schematic at the position specified or the current player position (loaded from @1)", export_path_trunc
),
1267 privs
= {server
= true},
1268 params
= S("<schematic name>[.mts] [<x> <y> <z>]"),
1269 func
= function(name
, param
)
1270 local schem
, p
= string.match(param
, "^([^ ]+) *(.*)$")
1271 local pos
= minetest
.string_to_pos(p
)
1274 return false, S("No schematic file specified.")
1278 pos
= minetest
.get_player_by_name(name
):get_pos()
1281 local schem_full
, schem_lua
= add_suffix(schem
)
1282 local success
= false
1283 local schem_path
= export_path_full
.. DIR_DELIM
.. schem_full
1284 if minetest
.read_schematic
then
1285 -- We don't call minetest.place_schematic with the path name directly because
1286 -- this would trigger the caching and we wouldn't get any updates to the schematic
1287 -- files when we reload. minetest.read_schematic circumvents that.
1288 local schematic
= minetest
.read_schematic(schem_path
, {})
1290 success
= minetest
.place_schematic(pos
, schematic
, "random", nil, false)
1293 -- Legacy support for Minetest versions that do not have minetest.read_schematic
1294 success
= minetest
.place_schematic(schem_path
, schematic
, "random", nil, false)
1297 if success
== nil then
1298 return false, S("Schematic file could not be loaded!")
1306 -- [chatcommand] Convert MTS schematic file to .lua file
1307 minetest
.register_chatcommand("mts2lua", {
1308 description
= S("Convert .mts schematic file to .lua file (loaded from @1)", export_path_trunc
),
1309 privs
= {server
= true},
1310 params
= S("<schematic name>[.mts] [comments]"),
1311 func
= function(name
, param
)
1312 local schem
, comments_str
= string.match(param
, "^([^ ]+) *(.*)$")
1315 return false, S("No schematic file specified.")
1318 local comments
= comments_str
== "comments"
1320 -- Automatically add file name suffix if omitted
1321 local schem_full
, schem_lua
= add_suffix(schem
)
1322 local schem_path
= export_path_full
.. DIR_DELIM
.. schem_full
1323 local schematic
= minetest
.read_schematic(schem_path
, {})
1326 local str
= minetest
.serialize_schematic(schematic
, "lua", {lua_use_comments
=comments
})
1327 local lua_path
= export_path_full
.. DIR_DELIM
.. schem_lua
1328 local file
= io
.open(lua_path
, "w")
1329 if file
and str
then
1333 return true, S("Exported schematic to @1", lua_path
)
1335 return false, S("Failed!")