1 -- signs_lib api, backported from street_signs
3 local S = signs_lib.gettext
5 signs_lib.lbm_restore_nodes = {}
6 signs_lib.old_fenceposts = {}
7 signs_lib.old_fenceposts_replacement_signs = {}
8 signs_lib.old_fenceposts_with_signs = {}
9 signs_lib.allowed_poles = {}
11 -- Settings used for a standard wood or steel wall sign
12 signs_lib.standard_lines = 6
13 signs_lib.standard_hscale = 1
14 signs_lib.standard_vscale = 1
15 signs_lib.standard_lspace = 1
16 signs_lib.standard_fsize = 15
17 signs_lib.standard_xoffs = 4
18 signs_lib.standard_yoffs = 0
19 signs_lib.standard_cpl = 35
21 signs_lib.standard_wood_groups = table.copy(minetest.registered_items["default:sign_wall_wood"].groups)
22 signs_lib.standard_wood_groups.sign = 1
23 signs_lib.standard_wood_groups.attached_node = nil
25 signs_lib.standard_steel_groups = table.copy(minetest.registered_items["default:sign_wall_steel"].groups)
26 signs_lib.standard_steel_groups.sign = 1
27 signs_lib.standard_steel_groups.attached_node = nil
29 signs_lib.standard_wood_sign_sounds = table.copy(minetest.registered_items["default:sign_wall_wood"].sounds)
30 signs_lib.standard_steel_sign_sounds = table.copy(minetest.registered_items["default:sign_wall_steel"].sounds)
32 signs_lib.default_text_scale = {x=10, y=10}
34 signs_lib.standard_yaw = {
41 signs_lib.wallmounted_yaw = {
50 signs_lib.fdir_to_back = {
57 signs_lib.wall_fdir_to_back = {
66 signs_lib.fdir_flip_to_back = {
73 signs_lib.wall_fdir_flip_to_back = {
80 signs_lib.fdir_to_back_left = {
87 signs_lib.wall_fdir_to_back_left = {
94 signs_lib.rotate_walldir = {
103 signs_lib.rotate_walldir_simple = {
112 signs_lib.rotate_facedir = {
122 signs_lib.rotate_facedir_simple = {
131 signs_lib.flip_facedir = {
141 signs_lib.flip_walldir = {
222 -- Initialize character texture cache
227 minetest.register_entity("signs_lib:text", {
228 collisionbox = { 0, 0, 0, 0, 0, 0 },
230 mesh = "signs_lib_standard_wall_sign_entity.obj",
233 backface_culling = false
236 function signs_lib.delete_objects(pos)
237 local objects = minetest.get_objects_inside_radius(pos, 0.5)
238 for _, v in ipairs(objects) do
243 function signs_lib.spawn_entity(pos, texture)
244 local node = minetest.get_node(pos)
245 local def = minetest.registered_items[node.name]
246 if not def or not def.entity_info then return end
248 local text_scale = (node and node.text_scale) or signs_lib.default_text_scale
249 local objects = minetest.get_objects_inside_radius(pos, 0.5)
255 obj = minetest.add_entity(pos, "signs_lib:text")
258 local yaw = def.entity_info.yaw[node.param2 + 1]
261 if not string.find(node.name, "onpole") and not string.find(node.name, "hanging") then
262 local rot90 = math.pi/2
264 if def.paramtype2 == "wallmounted" then
265 if node.param2 == 1 then -- on floor
268 elseif node.param2 == 0 then -- on ceiling
272 elseif def.paramtype2 == "facedir" then
273 if node.param2 == 4 then
276 elseif node.param2 == 6 then
284 obj:set_rotation({x = pitch, y = yaw, z=0})
288 mesh = def.entity_info.mesh,
289 visual_size = text_scale,
293 mesh = def.entity_info.mesh,
294 visual_size = text_scale,
303 function signs_lib.handle_rotation(pos, node, user, mode)
304 if not signs_lib.can_modify(pos, user)
305 or mode ~= screwdriver.ROTATE_FACE then
310 local def = minetest.registered_items[node.name]
312 if string.match(node.name, "_onpole") then
313 if not string.match(node.name, "_horiz") then
314 newparam2 = signs_lib.rotate_walldir_simple[node.param2] or 4
315 local t = signs_lib.wall_fdir_to_back_left
317 if def.paramtype2 ~= "wallmounted" then
318 newparam2 = signs_lib.rotate_facedir_simple[node.param2] or 0
319 t = signs_lib.fdir_to_back_left
323 x = pos.x + t[node.param2][1],
325 z = pos.z + t[node.param2][2]
328 -- flip the sign to the other side of the horizontal pole
329 newparam2 = signs_lib.flip_walldir[node.param2] or 4
330 local t = signs_lib.wall_fdir_flip_to_back
332 if def.paramtype2 ~= "wallmounted" then
333 newparam2 = signs_lib.flip_facedir[node.param2] or 0
334 t = signs_lib.fdir_flip_to_back
338 x = pos.x + t[node.param2][1],
340 z = pos.z + t[node.param2][2]
343 local node2 = minetest.get_node(tpos)
344 local def2 = minetest.registered_items[node2.name]
345 if not def2 or not def2.buildable_to then return true end -- undefined, or not buildable_to.
347 minetest.set_node(tpos, {name = node.name, param2 = newparam2})
348 minetest.get_meta(tpos):from_table(minetest.get_meta(pos):to_table())
349 minetest.remove_node(pos)
350 signs_lib.delete_objects(pos)
351 elseif string.match(node.name, "_hanging") or string.match(node.name, "yard") then
352 minetest.swap_node(tpos, { name = node.name, param2 = signs_lib.rotate_facedir_simple[node.param2] or 0 })
353 elseif minetest.registered_items[node.name].paramtype2 == "wallmounted" then
354 minetest.swap_node(tpos, { name = node.name, param2 = signs_lib.rotate_walldir[node.param2] or 0 })
356 minetest.swap_node(tpos, { name = node.name, param2 = signs_lib.rotate_facedir[node.param2] or 0 })
359 signs_lib.delete_objects(tpos)
360 signs_lib.update_sign(tpos)
366 if not minetest.settings:get_bool("creative_mode") then
367 signs_lib.expect_infinite_stacks = false
369 signs_lib.expect_infinite_stacks = true
374 -- Path to the textures.
375 local TP = signs_lib.path .. "/textures"
376 -- Font file formatter
377 local CHAR_FILE = "%s_%02x.png"
379 local CHAR_PATH = TP .. "/" .. CHAR_FILE
381 -- Lots of overkill here. KISS advocates, go away, shoo! ;) -- kaeza
383 local PNG_HDR = string.char(0x89, 0x50, 0x4E, 0x47, 0x0D, 0x0A, 0x1A, 0x0A)
385 -- check if a file does exist
386 -- to avoid reopening file after checking again
387 -- pass TRUE as second argument
388 local function file_exists(name, return_handle, mode)
390 local f = io.open(name, mode)
392 if (return_handle) then
402 -- Read the image size from a PNG file.
403 -- Returns image_w, image_h.
404 -- Only the LSB is read from each field!
405 function signs_lib.read_image_size(filename)
406 local f = file_exists(filename, true, "rb")
407 -- file might not exist (don't crash the game)
412 local hdr = f:read(string.len(PNG_HDR))
413 if hdr ~= PNG_HDR then
422 return ws:byte(), hs:byte()
425 -- 4 rows, max 80 chars per, plus a bit of fudge to
426 -- avoid excess trimming (e.g. due to color codes)
428 local MAX_INPUT_CHARS = 400
430 -- helper functions to trim sign text input/output
432 local function trim_input(text)
433 return text:sub(1, math.min(MAX_INPUT_CHARS, text:len()))
436 local function build_char_db(font_size)
440 -- To calculate average char width.
441 local total_width = 0
445 local w, h = signs_lib.read_image_size(CHAR_PATH:format("signs_lib_font_"..font_size.."px", c))
447 local ch = string.char(c)
449 total_width = total_width + w
450 char_count = char_count + 1
454 local cbw, cbh = signs_lib.read_image_size(TP.."/signs_lib_color_"..font_size.."px_n.png")
455 assert(cbw and cbh, "error reading bg dimensions")
456 return cw, cbw, cbh, (total_width / char_count)
459 signs_lib.charwidth15,
460 signs_lib.colorbgw15,
461 signs_lib.lineheight15,
462 signs_lib.avgwidth15 = build_char_db(15)
464 signs_lib.charwidth31,
465 signs_lib.colorbgw31,
466 signs_lib.lineheight31,
467 signs_lib.avgwidth31 = build_char_db(31)
469 local sign_groups = {choppy=2, dig_immediate=2}
470 local fences_with_sign = { }
472 -- some local helper functions
474 local math_max = math.max
476 local function fill_line(x, y, w, c, font_size, colorbgw)
479 for xx = 0, math.max(0, w), colorbgw do
480 table.insert(tex, (":%d,%d=signs_lib_color_"..font_size.."px_%s.png"):format(x + xx, y, c))
482 return table.concat(tex)
485 -- make char texture file name
486 -- if texture file does not exist use fallback texture instead
487 local function char_tex(font_name, ch)
488 if ctexcache[font_name..ch] then
489 return ctexcache[font_name..ch], true
492 local exists, tex = file_exists(CHAR_PATH:format(font_name, c))
493 if exists and c ~= 14 then
494 tex = CHAR_FILE:format(font_name, c)
496 tex = CHAR_FILE:format(font_name, 0x0)
498 ctexcache[font_name..ch] = tex
503 local function make_line_texture(line, lineno, pos, line_width, line_height, cwidth_tab, font_size, colorbgw)
506 local font_name = "signs_lib_font_"..font_size.."px"
509 local node = minetest.get_node(pos)
510 local def = minetest.registered_items[node.name]
511 local default_color = def.default_color or 0
513 local cur_color = tonumber(default_color, 16)
515 -- We check which chars are available here.
516 for word_i, word in ipairs(line) do
519 word = string.gsub(word, "%^[12345678abcdefgh]", {
520 ["^1"] = string.char(0x81),
521 ["^2"] = string.char(0x82),
522 ["^3"] = string.char(0x83),
523 ["^4"] = string.char(0x84),
524 ["^5"] = string.char(0x85),
525 ["^6"] = string.char(0x86),
526 ["^7"] = string.char(0x87),
527 ["^8"] = string.char(0x88),
528 ["^a"] = string.char(0x8a),
529 ["^b"] = string.char(0x8b),
530 ["^c"] = string.char(0x8c),
531 ["^d"] = string.char(0x8d),
532 ["^e"] = string.char(0x8e),
533 ["^f"] = string.char(0x8f),
534 ["^g"] = string.char(0x90),
535 ["^h"] = string.char(0x91)
540 local c = word:sub(i, i)
542 local cc = tonumber(word:sub(i+1, i+1), 16)
548 local w = cwidth_tab[c]
550 width = width + w + 1
551 if width >= (line_width - cwidth_tab[" "]) then
554 maxw = math_max(width, maxw)
556 if #chars < MAX_INPUT_CHARS then
557 table.insert(chars, {
559 tex = char_tex(font_name, c),
560 col = ("%X"):format(cur_color),
563 ch_offs = ch_offs + w
568 width = width + cwidth_tab[" "] + 1
569 maxw = math_max(width, maxw)
570 table.insert(words, { chars=chars, w=ch_offs })
573 -- Okay, we actually build the "line texture" here.
577 local start_xpos = math.floor((line_width - maxw) / 2) + def.x_offset
579 local xpos = start_xpos
580 local ypos = (line_height + def.line_spacing)* lineno + def.y_offset
584 for word_i, word in ipairs(words) do
585 local xoffs = (xpos - start_xpos)
586 if (xoffs > 0) and ((xoffs + word.w) > maxw) then
587 table.insert(texture, fill_line(xpos, ypos, maxw, "n", font_size, colorbgw))
589 ypos = ypos + line_height + def.line_spacing
591 if lineno >= def.number_of_lines then break end
592 table.insert(texture, fill_line(xpos, ypos, maxw, cur_color, font_size, colorbgw))
594 for ch_i, ch in ipairs(word.chars) do
595 if ch.col ~= cur_color then
597 table.insert(texture, fill_line(xpos + ch.off, ypos, maxw, cur_color, font_size, colorbgw))
599 table.insert(texture, (":%d,%d=%s"):format(xpos + ch.off, ypos, ch.tex))
603 (":%d,%d="):format(xpos + word.w, ypos) .. char_tex(font_name, " ")
605 xpos = xpos + word.w + cwidth_tab[" "]
606 if xpos >= (line_width + cwidth_tab[" "]) then break end
609 table.insert(texture, fill_line(xpos, ypos, maxw, "n", font_size, colorbgw))
610 table.insert(texture, fill_line(start_xpos, ypos + line_height, maxw, "n", font_size, colorbgw))
612 return table.concat(texture), lineno
615 local function make_sign_texture(lines, pos)
616 local node = minetest.get_node(pos)
617 local def = minetest.registered_items[node.name]
618 if not def or not def.entity_info then return end
626 if def.font_size and def.font_size == 31 then
628 line_width = math.floor(signs_lib.avgwidth31 * def.chars_per_line) * def.horiz_scaling
629 line_height = signs_lib.lineheight31
630 char_width = signs_lib.charwidth31
631 colorbgw = signs_lib.colorbgw31
634 line_width = math.floor(signs_lib.avgwidth15 * def.chars_per_line) * def.horiz_scaling
635 line_height = signs_lib.lineheight15
636 char_width = signs_lib.charwidth15
637 colorbgw = signs_lib.colorbgw15
640 local texture = { ("[combine:%dx%d"):format(line_width, (line_height + def.line_spacing) * def.number_of_lines * def.vert_scaling) }
644 if lineno >= def.number_of_lines then break end
645 local linetex, ln = make_line_texture(lines[i], lineno, pos, line_width, line_height, char_width, font_size, colorbgw)
646 table.insert(texture, linetex)
649 table.insert(texture, "^[makealpha:0,0,0")
650 return table.concat(texture, "")
653 function signs_lib.split_lines_and_words(text)
654 if not text then return end
656 for _, line in ipairs(text:split("\n")) do
657 table.insert(lines, line:split(" "))
662 function signs_lib.set_obj_text(pos, text)
663 local split = signs_lib.split_lines_and_words
664 local text_ansi = Utf8ToAnsi(text)
665 local n = minetest.registered_nodes[minetest.get_node(pos).name]
666 signs_lib.delete_objects(pos)
667 signs_lib.spawn_entity(pos, make_sign_texture(split(text_ansi), pos))
670 local function make_widefont_nodename(name)
671 if string.find(name, "_widefont") then return name end
672 if string.find(name, "_onpole") then
673 if string.find(name, "_horiz") then
674 return string.gsub(name, "_onpole_horiz", "_widefont_onpole_horiz")
676 return string.gsub(name, "_onpole", "_widefont_onpole")
678 elseif string.find(name, "_hanging") then
679 return string.gsub(name, "_hanging", "_widefont_hanging")
681 return name.."_widefont"
685 function signs_lib.construct_sign(pos)
686 local form = "size[6,4]"..
687 "textarea[0,-0.3;6.5,3;text;;${text}]"..
688 "background[-0.5,-0.5;7,5;signs_lib_sign_bg.jpg]"
689 local node = minetest.get_node(pos)
690 local wname = make_widefont_nodename(node.name)
692 if minetest.registered_items[wname] then
694 if string.find(node.name, "widefont") then state = "on" end
695 form = form.."label[1,3.4;Use wide font]"..
696 "image_button[1.1,3.7;1,0.6;signs_lib_switch_"..
698 state..";;;false;signs_lib_switch_interm.png]"..
699 "button_exit[3,3.4;2,1;ok;"..S("Write").."]"
701 form = form.."button_exit[2,3.4;2,1;ok;"..S("Write").."]"
704 local meta = minetest.get_meta(pos)
705 meta:set_string("formspec", form)
706 local i = meta:get_string("infotext")
707 if i == "" then -- it wasn't even set, so set it.
708 meta:set_string("infotext", "")
712 function signs_lib.destruct_sign(pos)
713 signs_lib.delete_objects(pos)
716 local function make_infotext(text)
717 text = trim_input(text)
718 local lines = signs_lib.split_lines_and_words(text) or {}
720 for _, line in ipairs(lines) do
721 table.insert(lines2, (table.concat(line, " "):gsub("#[0-9a-fA-F]", ""):gsub("##", "#")))
723 return table.concat(lines2, "\n")
726 function signs_lib.update_sign(pos, fields)
727 local meta = minetest.get_meta(pos)
729 local text = fields and fields.text or meta:get_string("text")
730 text = trim_input(text)
732 local owner = meta:get_string("owner")
734 if owner ~= "" then ownstr = S("Locked sign, owned by @1\n", owner) end
736 meta:set_string("text", text)
737 meta:set_string("infotext", ownstr..make_infotext(text).." ")
738 signs_lib.set_obj_text(pos, text)
741 function signs_lib.receive_fields(pos, formname, fields, sender)
743 if not fields or not signs_lib.can_modify(pos, sender) then return end
745 if fields.text and fields.ok then
746 minetest.log("action", S("@1 wrote \"@2\" to sign at @3",
747 (sender:get_player_name() or ""),
748 fields.text:gsub('\\', '\\\\'):gsub("\n", "\\n"),
749 minetest.pos_to_string(pos)
751 signs_lib.update_sign(pos, fields)
752 elseif fields.on or fields.off then
753 local node = minetest.get_node(pos)
756 if fields.on and string.find(node.name, "widefont") then
757 newname = string.gsub(node.name, "_widefont", "")
758 elseif fields.off and not string.find(node.name, "widefont") then
759 newname = make_widefont_nodename(node.name)
762 minetest.log("action", S("@1 flipped the wide-font switch to \"@2\" at @3",
763 (sender:get_player_name() or ""),
764 (fields.on and "off" or "on"),
765 minetest.pos_to_string(pos)
768 minetest.swap_node(pos, {name = newname, param2 = node.param2})
769 signs_lib.construct_sign(pos)
770 signs_lib.update_sign(pos, fields)
775 function signs_lib.can_modify(pos, player)
776 local meta = minetest.get_meta(pos)
777 local owner = meta:get_string("owner")
778 local playername = player:get_player_name()
780 if minetest.is_protected(pos, playername) then
781 minetest.record_protection_violation(pos, playername)
786 or playername == owner
787 or (minetest.check_player_privs(playername, {sign_editor=true}))
788 or (playername == minetest.settings:get("name")) then
791 minetest.record_protection_violation(pos, playername)
795 -- make selection boxes
796 -- sizex/sizey specified in inches because that's what MUTCD uses.
798 function signs_lib.make_selection_boxes(sizex, sizey, foo, xoffs, yoffs, zoffs, is_facedir)
800 local tx = (sizex * 0.0254 ) / 2
801 local ty = (sizey * 0.0254 ) / 2
802 local xo = xoffs and xoffs * 0.0254 or 0
803 local yo = yoffs and yoffs * 0.0254 or 0
804 local zo = zoffs and zoffs * 0.0254 or 0
806 if not is_facedir then
808 type = "wallmounted",
809 wall_side = { -0.5 + zo, -ty + yo, -tx + xo, -0.4375 + zo, ty + yo, tx + xo },
810 wall_top = { -tx - xo, 0.5 + zo, -ty + yo, tx - xo, 0.4375 + zo, ty + yo},
811 wall_bottom = { -tx - xo, -0.5 + zo, -ty + yo, tx - xo, -0.4375 + zo, ty + yo }
816 fixed = { -tx + xo, -ty + yo, 0.5 + zo, tx + xo, ty + yo, 0.4375 + zo}
821 function signs_lib.check_for_pole(pos, pointed_thing)
822 local node = minetest.get_node(pos)
823 local def = minetest.registered_items[node.name]
825 local ppos = minetest.get_pointed_thing_position(pointed_thing)
826 local pnode = minetest.get_node(ppos)
827 local pdef = minetest.registered_items[pnode.name]
829 if (signs_lib.allowed_poles[pnode.name]
830 or (pdef and pdef.drawtype == "fencelike")
831 or string.find(pnode.name, "default:fence_")
832 or string.find(pnode.name, "_post")
833 or string.find(pnode.name, "fencepost")
834 or string.find(pnode.name, "streets:streetlamp_basic_top")
835 or (pnode.name == "streets:bigpole" and pnode.param2 < 4)
836 or (pnode.name == "streets:bigpole" and pnode.param2 > 19 and pnode.param2 < 24) )
837 and (pos.x ~= ppos.x or pos.z ~= ppos.z) then
839 elseif pnode.name == "streets:bigpole_tjunction" then
840 if def.paramtype2 == "wallmounted" then
841 if (node.param2 == 4 and vtj_north[pnode.param2])
842 or (node.param2 == 2 and vtj_east[pnode.param2])
843 or (node.param2 == 5 and vtj_south[pnode.param2])
844 or (node.param2 == 3 and vtj_west[pnode.param2]) then
848 if (node.param2 == 0 and vtj_north[pnode.param2])
849 or (node.param2 == 1 and vtj_east[pnode.param2])
850 or (node.param2 == 2 and vtj_south[pnode.param2])
851 or (node.param2 == 3 and vtj_west[pnode.param2]) then
858 function signs_lib.check_for_horizontal_pole(pos, pointed_thing)
859 local node = minetest.get_node(pos)
860 local def = minetest.registered_items[node.name]
861 local ppos = minetest.get_pointed_thing_position(pointed_thing)
862 local pnode = minetest.get_node(ppos)
863 if pnode.name == "streets:bigpole" and pnode.param2 > 3 and pnode.param2 < 12 then
864 if def.paramtype2 == "wallmounted" then
865 if node.param2 == 2 or node.param2 == 3 -- E/W
869 if node.param2 == 1 or node.param2 == 3 -- E/W
873 elseif pnode.name == "streets:bigpole" and pnode.param2 > 11 and pnode.param2 < 20 then
874 if def.paramtype2 == "wallmounted" then
875 if node.param2 == 4 or node.param2 == 5 then
879 if node.param2 == 0 or node.param2 == 2 then
883 elseif pnode.name == "streets:bigpole_tjunction" then
884 if def.paramtype2 == "wallmounted" then
885 if (node.param2 == 4 and htj_north[pnode.param2])
886 or (node.param2 == 2 and htj_east[pnode.param2])
887 or (node.param2 == 5 and htj_south[pnode.param2])
888 or (node.param2 == 3 and htj_west[pnode.param2]) then
892 if (node.param2 == 0 and htj_north[pnode.param2])
893 or (node.param2 == 1 and htj_east[pnode.param2])
894 or (node.param2 == 2 and htj_south[pnode.param2])
895 or (node.param2 == 3 and htj_west[pnode.param2]) then
902 function signs_lib.check_for_ceiling(pointed_thing)
903 if pointed_thing.above.x == pointed_thing.under.x
904 and pointed_thing.above.z == pointed_thing.under.z
905 and pointed_thing.above.y < pointed_thing.under.y then
910 function signs_lib.check_for_floor(pointed_thing)
911 if pointed_thing.above.x == pointed_thing.under.x
912 and pointed_thing.above.z == pointed_thing.under.z
913 and pointed_thing.above.y > pointed_thing.under.y then
918 function signs_lib.after_place_node(pos, placer, itemstack, pointed_thing, locked)
919 local playername = placer:get_player_name()
920 local def = minetest.registered_items[itemstack:get_name()]
922 local ppos = minetest.get_pointed_thing_position(pointed_thing)
923 local pnode = minetest.get_node(ppos)
924 local pdef = minetest.registered_items[pnode.name]
925 if def.allow_onpole and signs_lib.check_for_pole(pos, pointed_thing) then
927 local lookdir = minetest.yaw_to_dir(placer:get_look_horizontal())
928 if def.paramtype2 == "wallmounted" then
929 newparam2 = minetest.dir_to_wallmounted(lookdir)
931 newparam2 = minetest.dir_to_facedir(lookdir)
933 local node = minetest.get_node(pos)
934 minetest.swap_node(pos, {name = itemstack:get_name().."_onpole", param2 = newparam2})
935 elseif def.allow_onpole_horizontal and signs_lib.check_for_horizontal_pole(pos, pointed_thing) then
937 local lookdir = minetest.yaw_to_dir(placer:get_look_horizontal())
938 if def.paramtype2 == "wallmounted" then
939 newparam2 = minetest.dir_to_wallmounted(lookdir)
941 newparam2 = minetest.dir_to_facedir(lookdir)
943 local node = minetest.get_node(pos)
944 minetest.swap_node(pos, {name = itemstack:get_name().."_onpole_horiz", param2 = newparam2})
945 elseif def.allow_hanging and signs_lib.check_for_ceiling(pointed_thing) then
946 local newparam2 = minetest.dir_to_facedir(placer:get_look_dir())
947 local node = minetest.get_node(pos)
948 minetest.swap_node(pos, {name = itemstack:get_name().."_hanging", param2 = newparam2})
949 elseif def.paramtype2 == "facedir" and signs_lib.check_for_ceiling(pointed_thing) then
950 minetest.swap_node(pos, {name = itemstack:get_name(), param2 = 6})
951 elseif def.paramtype2 == "facedir" and signs_lib.check_for_floor(pointed_thing) then
952 minetest.swap_node(pos, {name = itemstack:get_name(), param2 = 4})
955 local meta = minetest.get_meta(pos)
956 meta:set_string("owner", playername)
957 meta:set_string("infotext", S("Locked sign, owned by @1\n", playername))
961 function signs_lib.register_fence_with_sign()
962 minetest.log("warning", "[signs_lib] ".."Attempt to call no longer used function signs_lib.register_fence_with_sign()")
965 local function register_sign(name, rdef)
966 local def = table.copy(rdef)
968 if rdef.entity_info == "standard" then
970 mesh = "signs_lib_standard_wall_sign_entity.obj",
971 yaw = signs_lib.wallmounted_yaw
973 elseif rdef.entity_info then
974 def.entity_info = rdef.entity_info
977 def.after_place_node = rdef.after_place_node or signs_lib.after_place_node
979 if rdef.entity_info then
980 def.on_rightclick = rdef.on_rightclick or signs_lib.construct_sign
981 def.on_construct = rdef.on_construct or signs_lib.construct_sign
982 def.on_destruct = rdef.on_destruct or signs_lib.destruct_sign
983 def.on_receive_fields = rdef.on_receive_fields or signs_lib.receive_fields
984 def.on_punch = rdef.on_punch or signs_lib.update_sign
985 def.number_of_lines = rdef.number_of_lines or signs_lib.standard_lines
986 def.horiz_scaling = rdef.horiz_scaling or signs_lib.standard_hscale
987 def.vert_scaling = rdef.vert_scaling or signs_lib.standard_vscale
988 def.line_spacing = rdef.line_spacing or signs_lib.standard_lspace
989 def.font_size = rdef.font_size or signs_lib.standard_fsize
990 def.x_offset = rdef.x_offset or signs_lib.standard_xoffs
991 def.y_offset = rdef.y_offset or signs_lib.standard_yoffs
992 def.chars_per_line = rdef.chars_per_line or signs_lib.standard_cpl
993 def.default_color = rdef.default_color or "0"
994 if rdef.locked and not rdef.after_place_node then
995 def.after_place_node = function(pos, placer, itemstack, pointed_thing)
996 signs_lib.after_place_node(pos, placer, itemstack, pointed_thing, true)
1001 def.paramtype = rdef.paramtype or "light"
1002 def.drawtype = rdef.drawtype or "mesh"
1003 def.mesh = rdef.mesh or "signs_lib_standard_wall_sign.obj"
1004 def.wield_image = rdef.wield_image or def.inventory_image
1005 def.drop = rdef.drop or name
1006 def.sounds = rdef.sounds or signs_lib.standard_wood_sign_sounds
1007 def.paramtype2 = rdef.paramtype2 or "wallmounted"
1008 def.on_rotate = rdef.on_rotate or signs_lib.handle_rotation
1011 def.groups = rdef.groups
1013 def.groups = signs_lib.standard_wood_groups
1016 local cbox = signs_lib.make_selection_boxes(35, 25)
1018 def.selection_box = rdef.selection_box or cbox
1019 def.node_box = table.copy(rdef.node_box or rdef.selection_box or cbox)
1021 if def.sunlight_propagates ~= false then
1022 def.sunlight_propagates = true
1025 minetest.register_node(":"..name, def)
1026 table.insert(signs_lib.lbm_restore_nodes, name)
1028 local opdef = table.copy(def)
1030 if rdef.allow_onpole or rdef.allow_onpole_horizontal then
1032 local offset = 0.3125
1033 if opdef.uses_slim_pole_mount then
1037 opdef.selection_box = rdef.onpole_selection_box or opdef.selection_box
1038 opdef.node_box = rdef.onpole_node_box or opdef.selection_box
1040 if opdef.paramtype2 == "wallmounted" then
1041 opdef.node_box.wall_side[1] = def.node_box.wall_side[1] - offset
1042 opdef.node_box.wall_side[4] = def.node_box.wall_side[4] - offset
1044 opdef.selection_box.wall_side[1] = def.selection_box.wall_side[1] - offset
1045 opdef.selection_box.wall_side[4] = def.selection_box.wall_side[4] - offset
1047 opdef.node_box.fixed[3] = def.node_box.fixed[3] + offset
1048 opdef.node_box.fixed[6] = def.node_box.fixed[6] + offset
1050 opdef.selection_box.fixed[3] = def.selection_box.fixed[3] + offset
1051 opdef.selection_box.fixed[6] = def.selection_box.fixed[6] + offset
1054 opdef.groups.not_in_creative_inventory = 1
1055 opdef.mesh = string.gsub(opdef.mesh, ".obj$", "_onpole.obj")
1057 if opdef.entity_info then
1058 opdef.entity_info.mesh = string.gsub(opdef.entity_info.mesh, ".obj$", "_onpole.obj")
1062 -- setting one of item 3 or 4 to a texture and leaving the other "blank",
1063 -- reveals either the vertical or horizontal pole mount part of the model
1065 if rdef.allow_onpole then
1066 opdef.tiles[3] = "signs_lib_pole_mount.png"
1067 opdef.tiles[4] = "signs_lib_blank.png"
1068 minetest.register_node(":"..name.."_onpole", opdef)
1069 table.insert(signs_lib.lbm_restore_nodes, name.."_onpole")
1072 local ophdef = table.copy(opdef)
1074 if rdef.allow_onpole_horizontal then
1075 ophdef.tiles[3] = "signs_lib_blank.png"
1076 ophdef.tiles[4] = "signs_lib_pole_mount.png"
1077 minetest.register_node(":"..name.."_onpole_horiz", ophdef)
1078 table.insert(signs_lib.lbm_restore_nodes, name.."_onpole_horiz")
1081 if rdef.allow_hanging then
1083 local hdef = table.copy(def)
1084 hdef.paramtype2 = "facedir"
1086 local hcbox = signs_lib.make_selection_boxes(35, 32, nil, 0, 3, -18.5, true)
1088 hdef.selection_box = rdef.hanging_selection_box or hcbox
1089 hdef.node_box = rdef.hanging_node_box or rdef.hanging_selection_box or hcbox
1091 hdef.groups.not_in_creative_inventory = 1
1092 hdef.tiles[3] = "signs_lib_hangers.png"
1093 hdef.mesh = string.gsub(string.gsub(hdef.mesh, "_facedir.obj", ".obj"), ".obj$", "_hanging.obj")
1095 if hdef.entity_info then
1096 hdef.entity_info.mesh = string.gsub(string.gsub(hdef.entity_info.mesh, "_facedir.obj", ".obj"), ".obj$", "_hanging.obj")
1097 hdef.entity_info.yaw = signs_lib.standard_yaw
1100 minetest.register_node(":"..name.."_hanging", hdef)
1101 table.insert(signs_lib.lbm_restore_nodes, name.."_hanging")
1106 The main sign registration function
1107 ===================================
1109 Example minimal recommended def for writable signs:
1111 signs_lib.register_sign("foo:my_cool_sign", {
1112 description = "Wooden cool sign",
1113 inventory_image = "signs_lib_sign_cool_inv.png",
1115 "signs_lib_sign_cool.png",
1116 "signs_lib_sign_cool_edges.png"
1118 number_of_lines = 2,
1119 horiz_scaling = 0.8,
1125 chars_per_line = 40,
1126 entity_info = "standard"
1129 * default def assumes a wallmounted sign with on-pole being allowed.
1131 *For signs that can support being on a pole, include in the def:
1132 allow_onpole = true,
1133 (defaults to disabled)
1135 *For signs that can support being on a horizontal pole, include in the def:
1136 allow_onpole_horizontal = true,
1137 (defaults to disabled)
1139 * onpole/onpole_horizontal are independent; one may be allowed without the other
1141 * "standard" entity info implies the standard wood/steel sign model, in
1142 wallmounted mode. For facedir signs using the standard model, use:
1145 mesh = "signs_lib_standard_wall_sign_entity.obj",
1146 yaw = signs_lib.standard_yaw
1151 function signs_lib.register_sign(name, rdef)
1152 register_sign(name, rdef)
1154 if rdef.allow_widefont then
1156 local wdef = table.copy(minetest.registered_items[name])
1157 wdef.groups.not_in_creative_inventory = 1
1158 wdef.horiz_scaling = wdef.horiz_scaling / 2
1160 register_sign(name.."_widefont", wdef)
1164 -- restore signs' text after /clearobjects and the like, the next time
1165 -- a block is reloaded by the server.
1167 minetest.register_lbm({
1168 nodenames = signs_lib.lbm_restore_nodes,
1169 name = "signs_lib:restore_sign_text",
1170 label = "Restore sign text",
1171 run_at_every_load = true,
1172 action = function(pos, node)
1173 signs_lib.update_sign(pos,nil,nil,node)
1177 -- Convert old signs on fenceposts into signs on.. um.. fence posts :P
1179 minetest.register_lbm({
1180 nodenames = signs_lib.old_fenceposts_with_signs,
1181 name = "signs_lib:fix_fencepost_signs",
1182 label = "Change single-node signs on fences into normal",
1183 run_at_every_load = true,
1184 action = function(pos, node)
1186 local fdir = node.param2 % 8
1188 x = pos.x + signs_lib.fdir_to_back[fdir+1][1],
1190 z = pos.z + signs_lib.fdir_to_back[fdir+1][2]
1193 if minetest.get_node(signpos).name == "air" then
1194 local new_wmdir = minetest.dir_to_wallmounted(minetest.facedir_to_dir(fdir))
1195 local oldfence = signs_lib.old_fenceposts[node.name]
1196 local newsign = signs_lib.old_fenceposts_replacement_signs[node.name]
1198 signs_lib.delete_objects(pos)
1200 local oldmeta = minetest.get_meta(pos):to_table()
1201 minetest.set_node(pos, {name = oldfence})
1202 minetest.set_node(signpos, { name = newsign, param2 = new_wmdir })
1203 local newmeta = minetest.get_meta(signpos)
1204 newmeta:from_table(oldmeta)
1205 signs_lib.update_sign(signpos)
1210 signs_lib.block_list = {}
1211 signs_lib.totalblocks = 0
1213 -- Maintain a list of currently-loaded blocks
1214 minetest.register_lbm({
1215 nodenames = {"group:sign"},
1216 name = "signs_lib:update_block_list",
1217 label = "Update list of loaded blocks, log only those with signs",
1218 run_at_every_load = true,
1219 action = function(pos, node)
1220 -- yeah, yeah... I know I'm hashing a block pos, but it's still just a set of coords
1221 local hash = minetest.hash_node_position(vector.floor(vector.divide(pos, core.MAP_BLOCKSIZE)))
1222 if not signs_lib.block_list[hash] then
1223 signs_lib.block_list[hash] = true
1224 signs_lib.totalblocks = signs_lib.totalblocks + 1
1229 minetest.register_chatcommand("regen_signs", {
1231 privs = {server = true},
1232 description = "Skims through all currently-loaded sign-bearing mapblocks, clears away any entities within each sign's node space, and regenerates their text entities, if any.",
1233 func = function(player_name, params)
1235 local totalsigns = 0
1236 for b in pairs(signs_lib.block_list) do
1237 local blockpos = minetest.get_position_from_hash(b)
1238 local pos1 = vector.multiply(blockpos, core.MAP_BLOCKSIZE)
1239 local pos2 = vector.add(pos1, core.MAP_BLOCKSIZE - 1)
1240 if minetest.get_node_or_nil(vector.add(pos1, core.MAP_BLOCKSIZE/2)) then
1241 local signs_in_block = minetest.find_nodes_in_area(pos1, pos2, {"group:sign"})
1242 allsigns[#allsigns + 1] = signs_in_block
1243 totalsigns = totalsigns + #signs_in_block
1245 signs_lib.block_list[b] = nil -- if the block is no longer loaded, remove it from the table
1246 signs_lib.totalblocks = signs_lib.totalblocks - 1
1249 if signs_lib.totalblocks < 0 then signs_lib.totalblocks = 0 end
1250 if totalsigns == 0 then
1251 minetest.chat_send_player(player_name, "There are no signs in the currently-loaded terrain.")
1252 signs_lib.block_list = {}
1256 minetest.chat_send_player(player_name, "Found a total of "..totalsigns.." sign nodes across "..signs_lib.totalblocks.." blocks.")
1257 minetest.chat_send_player(player_name, "Regenerating sign entities...")
1259 for _, b in pairs(allsigns) do
1260 for _, pos in ipairs(b) do
1261 signs_lib.delete_objects(pos)
1262 local node = minetest.get_node(pos)
1263 local def = minetest.registered_items[node.name]
1264 if def and def.entity_info then
1265 signs_lib.update_sign(pos)
1269 minetest.chat_send_player(player_name, "Finished.")