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_to_back_left = {
73 signs_lib.wall_fdir_to_back_left = {
80 signs_lib.rotate_walldir = {
89 signs_lib.rotate_walldir_simple = {
98 signs_lib.rotate_facedir = {
108 signs_lib.rotate_facedir_simple = {
117 -- Initialize character texture cache
122 minetest.register_entity("signs_lib:text", {
123 collisionbox = { 0, 0, 0, 0, 0, 0 },
125 mesh = "signs_lib_standard_wall_sign_entity.obj",
130 function signs_lib.delete_objects(pos)
131 local objects = minetest.get_objects_inside_radius(pos, 0.5)
132 for _, v in ipairs(objects) do
137 function signs_lib.spawn_entity(pos, texture)
138 local node = minetest.get_node(pos)
139 local def = minetest.registered_items[node.name]
140 if not def or not def.entity_info then return end
142 local text_scale = (node and node.text_scale) or signs_lib.default_text_scale
143 local objects = minetest.get_objects_inside_radius(pos, 0.5)
149 obj = minetest.add_entity(pos, "signs_lib:text")
152 local yaw = def.entity_info.yaw[node.param2 + 1]
155 if not string.find(node.name, "onpole") and not string.find(node.name, "hanging") then
156 local rot90 = math.pi/2
158 if def.paramtype2 == "wallmounted" then
159 if node.param2 == 1 then -- on floor
162 elseif node.param2 == 0 then -- on ceiling
166 elseif def.paramtype2 == "facedir" then
167 if node.param2 == 4 then
170 elseif node.param2 == 6 then
178 obj:set_rotation({x = pitch, y = yaw, z=0})
182 mesh = def.entity_info.mesh,
183 visual_size = text_scale,
187 mesh = def.entity_info.mesh,
188 visual_size = text_scale,
197 function signs_lib.handle_rotation(pos, node, user, mode)
198 if not signs_lib.can_modify(pos, user)
199 or mode ~= screwdriver.ROTATE_FACE then
204 local def = minetest.registered_items[node.name]
206 if string.match(node.name, "_onpole") then
207 local newparam2 = signs_lib.rotate_walldir_simple[node.param2] or 4
208 local t = signs_lib.wall_fdir_to_back_left
210 if def.paramtype2 ~= "wallmounted" then
211 newparam2 = signs_lib.rotate_facedir_simple[node.param2] or 0
212 t = signs_lib.fdir_to_back_left
216 x = pos.x + t[node.param2][1],
218 z = pos.z + t[node.param2][2]
221 local node2 = minetest.get_node(tpos)
222 local def2 = minetest.registered_items[node2.name]
223 if not def2 or not def2.buildable_to then return true end -- undefined, or not buildable_to.
226 minetest.set_node(tpos, {name = node.name, param2 = newparam2})
227 minetest.get_meta(tpos):from_table(minetest.get_meta(pos):to_table())
228 minetest.remove_node(pos)
229 signs_lib.delete_objects(pos)
231 elseif string.match(node.name, "_hanging") or string.match(node.name, "yard") then
232 minetest.swap_node(tpos, { name = node.name, param2 = signs_lib.rotate_facedir_simple[node.param2] or 0 })
233 elseif minetest.registered_items[node.name].paramtype2 == "wallmounted" then
234 minetest.swap_node(tpos, { name = node.name, param2 = signs_lib.rotate_walldir[node.param2] or 0 })
236 minetest.swap_node(tpos, { name = node.name, param2 = signs_lib.rotate_facedir[node.param2] or 0 })
239 signs_lib.delete_objects(tpos)
240 signs_lib.update_sign(tpos)
246 if not minetest.settings:get_bool("creative_mode") then
247 signs_lib.expect_infinite_stacks = false
249 signs_lib.expect_infinite_stacks = true
254 -- Path to the textures.
255 local TP = signs_lib.path .. "/textures"
256 -- Font file formatter
257 local CHAR_FILE = "%s_%02x.png"
259 local CHAR_PATH = TP .. "/" .. CHAR_FILE
261 -- Lots of overkill here. KISS advocates, go away, shoo! ;) -- kaeza
263 local PNG_HDR = string.char(0x89, 0x50, 0x4E, 0x47, 0x0D, 0x0A, 0x1A, 0x0A)
265 -- check if a file does exist
266 -- to avoid reopening file after checking again
267 -- pass TRUE as second argument
268 local function file_exists(name, return_handle, mode)
270 local f = io.open(name, mode)
272 if (return_handle) then
282 -- Read the image size from a PNG file.
283 -- Returns image_w, image_h.
284 -- Only the LSB is read from each field!
285 function signs_lib.read_image_size(filename)
286 local f = file_exists(filename, true, "rb")
287 -- file might not exist (don't crash the game)
292 local hdr = f:read(string.len(PNG_HDR))
293 if hdr ~= PNG_HDR then
302 return ws:byte(), hs:byte()
305 -- 4 rows, max 80 chars per, plus a bit of fudge to
306 -- avoid excess trimming (e.g. due to color codes)
308 local MAX_INPUT_CHARS = 400
310 -- helper functions to trim sign text input/output
312 local function trim_input(text)
313 return text:sub(1, math.min(MAX_INPUT_CHARS, text:len()))
316 local function build_char_db(font_size)
320 -- To calculate average char width.
321 local total_width = 0
325 local w, h = signs_lib.read_image_size(CHAR_PATH:format("signs_lib_font_"..font_size.."px", c))
327 local ch = string.char(c)
329 total_width = total_width + w
330 char_count = char_count + 1
334 local cbw, cbh = signs_lib.read_image_size(TP.."/signs_lib_color_"..font_size.."px_n.png")
335 assert(cbw and cbh, "error reading bg dimensions")
336 return cw, cbw, cbh, (total_width / char_count)
339 signs_lib.charwidth15,
340 signs_lib.colorbgw15,
341 signs_lib.lineheight15,
342 signs_lib.avgwidth15 = build_char_db(15)
344 signs_lib.charwidth31,
345 signs_lib.colorbgw31,
346 signs_lib.lineheight31,
347 signs_lib.avgwidth31 = build_char_db(31)
349 local sign_groups = {choppy=2, dig_immediate=2}
350 local fences_with_sign = { }
352 -- some local helper functions
354 local math_max = math.max
356 local function fill_line(x, y, w, c, font_size, colorbgw)
359 for xx = 0, math.max(0, w), colorbgw do
360 table.insert(tex, (":%d,%d=signs_lib_color_"..font_size.."px_%s.png"):format(x + xx, y, c))
362 return table.concat(tex)
365 -- make char texture file name
366 -- if texture file does not exist use fallback texture instead
367 local function char_tex(font_name, ch)
368 if ctexcache[font_name..ch] then
369 return ctexcache[font_name..ch], true
372 local exists, tex = file_exists(CHAR_PATH:format(font_name, c))
373 if exists and c ~= 14 then
374 tex = CHAR_FILE:format(font_name, c)
376 tex = CHAR_FILE:format(font_name, 0x0)
378 ctexcache[font_name..ch] = tex
383 local function make_line_texture(line, lineno, pos, line_width, line_height, cwidth_tab, font_size, colorbgw)
386 local font_name = "signs_lib_font_"..font_size.."px"
389 local node = minetest.get_node(pos)
390 local def = minetest.registered_items[node.name]
391 local default_color = def.default_color or 0
393 local cur_color = tonumber(default_color, 16)
395 -- We check which chars are available here.
396 for word_i, word in ipairs(line) do
399 word = string.gsub(word, "%^[12345678abcdefgh]", {
400 ["^1"] = string.char(0x81),
401 ["^2"] = string.char(0x82),
402 ["^3"] = string.char(0x83),
403 ["^4"] = string.char(0x84),
404 ["^5"] = string.char(0x85),
405 ["^6"] = string.char(0x86),
406 ["^7"] = string.char(0x87),
407 ["^8"] = string.char(0x88),
408 ["^a"] = string.char(0x8a),
409 ["^b"] = string.char(0x8b),
410 ["^c"] = string.char(0x8c),
411 ["^d"] = string.char(0x8d),
412 ["^e"] = string.char(0x8e),
413 ["^f"] = string.char(0x8f),
414 ["^g"] = string.char(0x90),
415 ["^h"] = string.char(0x91)
420 local c = word:sub(i, i)
422 local cc = tonumber(word:sub(i+1, i+1), 16)
428 local w = cwidth_tab[c]
430 width = width + w + 1
431 if width >= (line_width - cwidth_tab[" "]) then
434 maxw = math_max(width, maxw)
436 if #chars < MAX_INPUT_CHARS then
437 table.insert(chars, {
439 tex = char_tex(font_name, c),
440 col = ("%X"):format(cur_color),
443 ch_offs = ch_offs + w
448 width = width + cwidth_tab[" "] + 1
449 maxw = math_max(width, maxw)
450 table.insert(words, { chars=chars, w=ch_offs })
453 -- Okay, we actually build the "line texture" here.
457 local start_xpos = math.floor((line_width - maxw) / 2) + def.x_offset
459 local xpos = start_xpos
460 local ypos = (line_height + def.line_spacing)* lineno + def.y_offset
464 for word_i, word in ipairs(words) do
465 local xoffs = (xpos - start_xpos)
466 if (xoffs > 0) and ((xoffs + word.w) > maxw) then
467 table.insert(texture, fill_line(xpos, ypos, maxw, "n", font_size, colorbgw))
469 ypos = ypos + line_height + def.line_spacing
471 if lineno >= def.number_of_lines then break end
472 table.insert(texture, fill_line(xpos, ypos, maxw, cur_color, font_size, colorbgw))
474 for ch_i, ch in ipairs(word.chars) do
475 if ch.col ~= cur_color then
477 table.insert(texture, fill_line(xpos + ch.off, ypos, maxw, cur_color, font_size, colorbgw))
479 table.insert(texture, (":%d,%d=%s"):format(xpos + ch.off, ypos, ch.tex))
483 (":%d,%d="):format(xpos + word.w, ypos) .. char_tex(font_name, " ")
485 xpos = xpos + word.w + cwidth_tab[" "]
486 if xpos >= (line_width + cwidth_tab[" "]) then break end
489 table.insert(texture, fill_line(xpos, ypos, maxw, "n", font_size, colorbgw))
490 table.insert(texture, fill_line(start_xpos, ypos + line_height, maxw, "n", font_size, colorbgw))
492 return table.concat(texture), lineno
495 local function make_sign_texture(lines, pos)
496 local node = minetest.get_node(pos)
497 local def = minetest.registered_items[node.name]
498 if not def or not def.entity_info then return end
506 if def.font_size and def.font_size == 31 then
508 line_width = math.floor(signs_lib.avgwidth31 * def.chars_per_line) * def.horiz_scaling
509 line_height = signs_lib.lineheight31
510 char_width = signs_lib.charwidth31
511 colorbgw = signs_lib.colorbgw31
514 line_width = math.floor(signs_lib.avgwidth15 * def.chars_per_line) * def.horiz_scaling
515 line_height = signs_lib.lineheight15
516 char_width = signs_lib.charwidth15
517 colorbgw = signs_lib.colorbgw15
520 local texture = { ("[combine:%dx%d"):format(line_width, (line_height + def.line_spacing) * def.number_of_lines * def.vert_scaling) }
524 if lineno >= def.number_of_lines then break end
525 local linetex, ln = make_line_texture(lines[i], lineno, pos, line_width, line_height, char_width, font_size, colorbgw)
526 table.insert(texture, linetex)
529 table.insert(texture, "^[makealpha:0,0,0")
530 return table.concat(texture, "")
533 function signs_lib.split_lines_and_words(text)
534 if not text then return end
536 for _, line in ipairs(text:split("\n")) do
537 table.insert(lines, line:split(" "))
542 function signs_lib.set_obj_text(pos, text)
543 local split = signs_lib.split_lines_and_words
544 local text_ansi = Utf8ToAnsi(text)
545 local n = minetest.registered_nodes[minetest.get_node(pos).name]
546 signs_lib.delete_objects(pos)
547 signs_lib.spawn_entity(pos, make_sign_texture(split(text_ansi), pos))
550 local function make_widefont_nodename(name)
551 if string.find(name, "_widefont") then return name end
552 if string.find(name, "_onpole") then
553 return string.gsub(name, "_onpole", "_widefont_onpole")
554 elseif string.find(name, "_hanging") then
555 return string.gsub(name, "_hanging", "_widefont_hanging")
557 return name.."_widefont"
561 function signs_lib.construct_sign(pos)
562 local form = "size[6,4]"..
563 "textarea[0,-0.3;6.5,3;text;;${text}]"..
564 "background[-0.5,-0.5;7,5;signs_lib_sign_bg.jpg]"
565 local node = minetest.get_node(pos)
566 local wname = make_widefont_nodename(node.name)
568 if minetest.registered_items[wname] then
570 if string.find(node.name, "widefont") then state = "on" end
571 form = form.."label[1,3.4;Use wide font]"..
572 "image_button[1.1,3.7;1,0.6;signs_lib_switch_"..
574 state..";;;false;signs_lib_switch_interm.png]"..
575 "button_exit[3,3.4;2,1;ok;"..S("Write").."]"
577 form = form.."button_exit[2,3.4;2,1;ok;"..S("Write").."]"
580 local meta = minetest.get_meta(pos)
581 meta:set_string("formspec", form)
582 local i = meta:get_string("infotext")
583 if i == "" then -- it wasn't even set, so set it.
584 meta:set_string("infotext", "")
588 function signs_lib.destruct_sign(pos)
589 signs_lib.delete_objects(pos)
592 local function make_infotext(text)
593 text = trim_input(text)
594 local lines = signs_lib.split_lines_and_words(text) or {}
596 for _, line in ipairs(lines) do
597 table.insert(lines2, (table.concat(line, " "):gsub("#[0-9a-fA-F]", ""):gsub("##", "#")))
599 return table.concat(lines2, "\n")
602 function signs_lib.update_sign(pos, fields)
603 local meta = minetest.get_meta(pos)
605 local text = fields and fields.text or meta:get_string("text")
606 text = trim_input(text)
608 local owner = meta:get_string("owner")
610 if owner ~= "" then ownstr = S("Locked sign, owned by @1\n", owner) end
612 meta:set_string("text", text)
613 meta:set_string("infotext", ownstr..make_infotext(text).." ")
614 signs_lib.set_obj_text(pos, text)
617 function signs_lib.receive_fields(pos, formname, fields, sender)
619 if not fields or not signs_lib.can_modify(pos, sender) then return end
621 if fields.text and fields.ok then
622 minetest.log("action", S("@1 wrote \"@2\" to sign at @3",
623 (sender:get_player_name() or ""),
624 fields.text:gsub('\\', '\\\\'):gsub("\n", "\\n"),
625 minetest.pos_to_string(pos)
627 signs_lib.update_sign(pos, fields)
628 elseif fields.on or fields.off then
629 local node = minetest.get_node(pos)
632 if fields.on and string.find(node.name, "widefont") then
633 newname = string.gsub(node.name, "_widefont", "")
634 elseif fields.off and not string.find(node.name, "widefont") then
635 newname = make_widefont_nodename(node.name)
638 minetest.log("action", S("@1 flipped the wide-font switch to \"@2\" at @3",
639 (sender:get_player_name() or ""),
640 (fields.on and "off" or "on"),
641 minetest.pos_to_string(pos)
644 minetest.swap_node(pos, {name = newname, param2 = node.param2})
645 signs_lib.construct_sign(pos)
646 signs_lib.update_sign(pos, fields)
651 function signs_lib.can_modify(pos, player)
652 local meta = minetest.get_meta(pos)
653 local owner = meta:get_string("owner")
654 local playername = player:get_player_name()
656 if minetest.is_protected(pos, playername) then
657 minetest.record_protection_violation(pos, playername)
662 or playername == owner
663 or (minetest.check_player_privs(playername, {sign_editor=true}))
664 or (playername == minetest.settings:get("name")) then
667 minetest.record_protection_violation(pos, playername)
671 -- make selection boxes
672 -- sizex/sizey specified in inches because that's what MUTCD uses.
674 function signs_lib.make_selection_boxes(sizex, sizey, foo, xoffs, yoffs, zoffs, is_facedir)
676 local tx = (sizex * 0.0254 ) / 2
677 local ty = (sizey * 0.0254 ) / 2
678 local xo = xoffs and xoffs * 0.0254 or 0
679 local yo = yoffs and yoffs * 0.0254 or 0
680 local zo = zoffs and zoffs * 0.0254 or 0
682 if not is_facedir then
684 type = "wallmounted",
685 wall_side = { -0.5 + zo, -ty + yo, -tx + xo, -0.4375 + zo, ty + yo, tx + xo },
686 wall_top = { -tx - xo, 0.5 + zo, -ty + yo, tx - xo, 0.4375 + zo, ty + yo},
687 wall_bottom = { -tx - xo, -0.5 + zo, -ty + yo, tx - xo, -0.4375 + zo, ty + yo }
692 fixed = { -tx + xo, -ty + yo, 0.5 + zo, tx + xo, ty + yo, 0.4375 + zo}
697 function signs_lib.check_for_pole(pos, pointed_thing)
698 local ppos = minetest.get_pointed_thing_position(pointed_thing)
699 local pnode = minetest.get_node(ppos)
700 local pdef = minetest.registered_items[pnode.name]
702 if (signs_lib.allowed_poles[pnode.name]
703 or (pdef and pdef.drawtype == "fencelike")
704 or string.find(pnode.name, "default:fence_")
705 or string.find(pnode.name, "_post")
706 or string.find(pnode.name, "fencepost")
707 or string.find(pnode.name, "streets:streetlamp_basic_top")
708 or (pnode.name == "streets:bigpole" and pnode.param2 < 4)
709 or (pnode.name == "streets:bigpole" and pnode.param2 > 19 and pnode.param2 < 24)
712 (pos.x ~= ppos.x or pos.z ~= ppos.z) then
717 function signs_lib.check_for_ceiling(pointed_thing)
718 if pointed_thing.above.x == pointed_thing.under.x
719 and pointed_thing.above.z == pointed_thing.under.z
720 and pointed_thing.above.y < pointed_thing.under.y then
725 function signs_lib.check_for_floor(pointed_thing)
726 if pointed_thing.above.x == pointed_thing.under.x
727 and pointed_thing.above.z == pointed_thing.under.z
728 and pointed_thing.above.y > pointed_thing.under.y then
733 function signs_lib.after_place_node(pos, placer, itemstack, pointed_thing, locked)
734 local playername = placer:get_player_name()
735 local def = minetest.registered_items[itemstack:get_name()]
737 local ppos = minetest.get_pointed_thing_position(pointed_thing)
738 local pnode = minetest.get_node(ppos)
739 local pdef = minetest.registered_items[pnode.name]
741 if (def.allow_onpole ~= false) and signs_lib.check_for_pole(pos, pointed_thing) then
742 local node = minetest.get_node(pos)
743 minetest.swap_node(pos, {name = itemstack:get_name().."_onpole", param2 = node.param2})
744 elseif def.allow_hanging and signs_lib.check_for_ceiling(pointed_thing) then
745 local newparam2 = minetest.dir_to_facedir(placer:get_look_dir())
746 local node = minetest.get_node(pos)
747 minetest.swap_node(pos, {name = itemstack:get_name().."_hanging", param2 = newparam2})
748 elseif def.paramtype2 == "facedir" and signs_lib.check_for_ceiling(pointed_thing) then
749 minetest.swap_node(pos, {name = itemstack:get_name(), param2 = 6})
750 elseif def.paramtype2 == "facedir" and signs_lib.check_for_floor(pointed_thing) then
751 minetest.swap_node(pos, {name = itemstack:get_name(), param2 = 4})
754 local meta = minetest.get_meta(pos)
755 meta:set_string("owner", playername)
756 meta:set_string("infotext", S("Locked sign, owned by @1\n", playername))
760 function signs_lib.register_fence_with_sign()
761 minetest.log("warning", "[signs_lib] ".."Attempt to call no longer used function signs_lib.register_fence_with_sign()")
764 local function register_sign(name, rdef)
765 local def = table.copy(rdef)
767 if rdef.entity_info == "standard" then
769 mesh = "signs_lib_standard_wall_sign_entity.obj",
770 yaw = signs_lib.wallmounted_yaw
772 elseif rdef.entity_info then
773 def.entity_info = rdef.entity_info
776 def.after_place_node = rdef.after_place_node or signs_lib.after_place_node
778 if rdef.entity_info then
779 def.on_rightclick = rdef.on_rightclick or signs_lib.construct_sign
780 def.on_construct = rdef.on_construct or signs_lib.construct_sign
781 def.on_destruct = rdef.on_destruct or signs_lib.destruct_sign
782 def.on_receive_fields = rdef.on_receive_fields or signs_lib.receive_fields
783 def.on_punch = rdef.on_punch or signs_lib.update_sign
784 def.number_of_lines = rdef.number_of_lines or signs_lib.standard_lines
785 def.horiz_scaling = rdef.horiz_scaling or signs_lib.standard_hscale
786 def.vert_scaling = rdef.vert_scaling or signs_lib.standard_vscale
787 def.line_spacing = rdef.line_spacing or signs_lib.standard_lspace
788 def.font_size = rdef.font_size or signs_lib.standard_fsize
789 def.x_offset = rdef.x_offset or signs_lib.standard_xoffs
790 def.y_offset = rdef.y_offset or signs_lib.standard_yoffs
791 def.chars_per_line = rdef.chars_per_line or signs_lib.standard_cpl
792 def.default_color = rdef.default_color or "0"
793 if rdef.locked and not rdef.after_place_node then
794 def.after_place_node = function(pos, placer, itemstack, pointed_thing)
795 signs_lib.after_place_node(pos, placer, itemstack, pointed_thing, true)
800 def.paramtype = rdef.paramtype or "light"
801 def.drawtype = rdef.drawtype or "mesh"
802 def.mesh = rdef.mesh or "signs_lib_standard_wall_sign.obj"
803 def.wield_image = rdef.wield_image or def.inventory_image
804 def.drop = rdef.drop or name
805 def.sounds = rdef.sounds or signs_lib.standard_wood_sign_sounds
806 def.paramtype2 = rdef.paramtype2 or "wallmounted"
807 def.on_rotate = rdef.on_rotate or signs_lib.handle_rotation
810 def.groups = rdef.groups
812 def.groups = signs_lib.standard_wood_groups
815 local cbox = signs_lib.make_selection_boxes(35, 25)
817 def.selection_box = rdef.selection_box or cbox
818 def.node_box = table.copy(rdef.node_box or rdef.selection_box or cbox)
820 if def.sunlight_propagates ~= false then
821 def.sunlight_propagates = true
824 minetest.register_node(":"..name, def)
825 table.insert(signs_lib.lbm_restore_nodes, name)
827 if rdef.allow_onpole ~= false then
829 local opdef = table.copy(def)
831 local offset = 0.3125
832 if opdef.uses_slim_pole_mount then
836 opdef.selection_box = rdef.onpole_selection_box or opdef.selection_box
837 opdef.node_box = rdef.onpole_node_box or opdef.selection_box
839 if opdef.paramtype2 == "wallmounted" then
840 opdef.node_box.wall_side[1] = def.node_box.wall_side[1] - offset
841 opdef.node_box.wall_side[4] = def.node_box.wall_side[4] - offset
843 opdef.selection_box.wall_side[1] = def.selection_box.wall_side[1] - offset
844 opdef.selection_box.wall_side[4] = def.selection_box.wall_side[4] - offset
846 opdef.node_box.fixed[3] = def.node_box.fixed[3] + offset
847 opdef.node_box.fixed[6] = def.node_box.fixed[6] + offset
849 opdef.selection_box.fixed[3] = def.selection_box.fixed[3] + offset
850 opdef.selection_box.fixed[6] = def.selection_box.fixed[6] + offset
853 opdef.groups.not_in_creative_inventory = 1
854 opdef.tiles[3] = "signs_lib_pole_mount.png"
855 opdef.mesh = string.gsub(opdef.mesh, ".obj$", "_onpole.obj")
857 if opdef.entity_info then
858 opdef.entity_info.mesh = string.gsub(opdef.entity_info.mesh, ".obj$", "_onpole.obj")
860 minetest.register_node(":"..name.."_onpole", opdef)
861 table.insert(signs_lib.lbm_restore_nodes, name.."_onpole")
864 if rdef.allow_hanging then
866 local hdef = table.copy(def)
867 hdef.paramtype2 = "facedir"
869 local hcbox = signs_lib.make_selection_boxes(35, 32, nil, 0, 3, -18.5, true)
871 hdef.selection_box = rdef.hanging_selection_box or hcbox
872 hdef.node_box = rdef.hanging_node_box or rdef.hanging_selection_box or hcbox
874 hdef.groups.not_in_creative_inventory = 1
875 hdef.tiles[3] = "signs_lib_hangers.png"
876 hdef.mesh = string.gsub(string.gsub(hdef.mesh, "_facedir.obj", ".obj"), ".obj$", "_hanging.obj")
878 if hdef.entity_info then
879 hdef.entity_info.mesh = string.gsub(string.gsub(hdef.entity_info.mesh, "_facedir.obj", ".obj"), ".obj$", "_hanging.obj")
880 hdef.entity_info.yaw = signs_lib.standard_yaw
883 minetest.register_node(":"..name.."_hanging", hdef)
884 table.insert(signs_lib.lbm_restore_nodes, name.."_hanging")
889 The main sign registration function
890 ===================================
892 Example minimal recommended def for writable signs:
894 signs_lib.register_sign("foo:my_cool_sign", {
895 description = "Wooden cool sign",
896 inventory_image = "signs_lib_sign_cool_inv.png",
898 "signs_lib_sign_cool.png",
899 "signs_lib_sign_cool_edges.png"
909 entity_info = "standard"
912 * default def assumes a wallmounted sign with on-pole being allowed.
914 *For signs that can't support onpole, include in the def:
915 allow_onpole = false,
917 * "standard" entity info implies the standard wood/steel sign model, in
918 wallmounted mode. For facedir signs using the standard model, use:
921 mesh = "signs_lib_standard_wall_sign_entity.obj",
922 yaw = signs_lib.standard_yaw
927 function signs_lib.register_sign(name, rdef)
928 register_sign(name, rdef)
930 if rdef.allow_widefont then
932 local wdef = table.copy(minetest.registered_items[name])
933 wdef.groups.not_in_creative_inventory = 1
934 wdef.horiz_scaling = wdef.horiz_scaling / 2
936 register_sign(name.."_widefont", wdef)
940 -- restore signs' text after /clearobjects and the like, the next time
941 -- a block is reloaded by the server.
943 minetest.register_lbm({
944 nodenames = signs_lib.lbm_restore_nodes,
945 name = "signs_lib:restore_sign_text",
946 label = "Restore sign text",
947 run_at_every_load = true,
948 action = function(pos, node)
949 signs_lib.update_sign(pos,nil,nil,node)
953 -- Convert old signs on fenceposts into signs on.. um.. fence posts :P
955 minetest.register_lbm({
956 nodenames = signs_lib.old_fenceposts_with_signs,
957 name = "signs_lib:fix_fencepost_signs",
958 label = "Change single-node signs on fences into normal",
959 run_at_every_load = true,
960 action = function(pos, node)
962 local fdir = node.param2 % 8
964 x = pos.x + signs_lib.fdir_to_back[fdir+1][1],
966 z = pos.z + signs_lib.fdir_to_back[fdir+1][2]
969 if minetest.get_node(signpos).name == "air" then
970 local new_wmdir = minetest.dir_to_wallmounted(minetest.facedir_to_dir(fdir))
971 local oldfence = signs_lib.old_fenceposts[node.name]
972 local newsign = signs_lib.old_fenceposts_replacement_signs[node.name]
974 signs_lib.delete_objects(pos)
976 local oldmeta = minetest.get_meta(pos):to_table()
977 minetest.set_node(pos, {name = oldfence})
978 minetest.set_node(signpos, { name = newsign, param2 = new_wmdir })
979 local newmeta = minetest.get_meta(signpos)
980 newmeta:from_table(oldmeta)
981 signs_lib.update_sign(signpos)
986 signs_lib.block_list = {}
987 signs_lib.totalblocks = 0
989 -- Maintain a list of currently-loaded blocks
990 minetest.register_lbm({
991 nodenames = {"group:sign"},
992 name = "signs_lib:update_block_list",
993 label = "Update list of loaded blocks, log only those with signs",
994 run_at_every_load = true,
995 action = function(pos, node)
996 -- yeah, yeah... I know I'm hashing a block pos, but it's still just a set of coords
997 local hash = minetest.hash_node_position(vector.floor(vector.divide(pos, core.MAP_BLOCKSIZE)))
998 if not signs_lib.block_list[hash] then
999 signs_lib.block_list[hash] = true
1000 signs_lib.totalblocks = signs_lib.totalblocks + 1
1005 minetest.register_chatcommand("regen_signs", {
1007 privs = {server = true},
1008 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.",
1009 func = function(player_name, params)
1011 local totalsigns = 0
1012 for b in pairs(signs_lib.block_list) do
1013 local blockpos = minetest.get_position_from_hash(b)
1014 local pos1 = vector.multiply(blockpos, core.MAP_BLOCKSIZE)
1015 local pos2 = vector.add(pos1, core.MAP_BLOCKSIZE - 1)
1016 if minetest.get_node_or_nil(vector.add(pos1, core.MAP_BLOCKSIZE/2)) then
1017 local signs_in_block = minetest.find_nodes_in_area(pos1, pos2, {"group:sign"})
1018 allsigns[#allsigns + 1] = signs_in_block
1019 totalsigns = totalsigns + #signs_in_block
1021 signs_lib.block_list[b] = nil -- if the block is no longer loaded, remove it from the table
1022 signs_lib.totalblocks = signs_lib.totalblocks - 1
1025 if signs_lib.totalblocks < 0 then signs_lib.totalblocks = 0 end
1026 if totalsigns == 0 then
1027 minetest.chat_send_player(player_name, "There are no signs in the currently-loaded terrain.")
1028 signs_lib.block_list = {}
1032 minetest.chat_send_player(player_name, "Found a total of "..totalsigns.." sign nodes across "..signs_lib.totalblocks.." blocks.")
1033 minetest.chat_send_player(player_name, "Regenerating sign entities...")
1035 for _, b in pairs(allsigns) do
1036 for _, pos in ipairs(b) do
1037 signs_lib.delete_objects(pos)
1038 local node = minetest.get_node(pos)
1039 local def = minetest.registered_items[node.name]
1040 if def and def.entity_info then
1041 signs_lib.update_sign(pos)
1045 minetest.chat_send_player(player_name, "Finished.")