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.standard_yaw = {
39 signs_lib.wallmounted_yaw = {
48 signs_lib.fdir_to_back = {
55 signs_lib.wall_fdir_to_back = {
64 signs_lib.rotate_facedir = {
74 signs_lib.rotate_walldir = {
83 -- Initialize character texture cache
86 signs_lib.wallmounted_rotate = function(pos, node, user, mode)
87 if not signs_lib.can_modify(pos, user) then return false end
89 if mode ~= screwdriver.ROTATE_FACE or string.match(node.name, "_onpole") then
93 local newparam2 = signs_lib.rotate_walldir[node.param2] or 0
95 minetest.swap_node(pos, { name = node.name, param2 = newparam2 })
96 for _, v in ipairs(minetest.get_objects_inside_radius(pos, 0.5)) do
97 local e = v:get_luaentity()
98 if e and e.name == "signs_lib:text" then
102 signs_lib.update_sign(pos)
106 signs_lib.facedir_rotate = function(pos, node, user, mode)
107 if not signs_lib.can_modify(pos, user) then return false end
109 if mode ~= screwdriver.ROTATE_FACE or string.match(node.name, "_onpole") then
113 local newparam2 = signs_lib.rotate_facedir[node.param2] or 0
115 minetest.swap_node(pos, { name = node.name, param2 = newparam2 })
116 for _, v in ipairs(minetest.get_objects_inside_radius(pos, 0.5)) do
117 local e = v:get_luaentity()
118 if e and e.name == "signs_lib:text" then
122 signs_lib.update_sign(pos)
126 local DEFAULT_TEXT_SCALE = {x=10, y=10}
130 if not minetest.settings:get_bool("creative_mode") then
131 signs_lib.expect_infinite_stacks = false
133 signs_lib.expect_infinite_stacks = true
138 -- Path to the textures.
139 local TP = signs_lib.path .. "/textures"
140 -- Font file formatter
141 local CHAR_FILE = "%s_%02x.png"
143 local CHAR_PATH = TP .. "/" .. CHAR_FILE
145 -- Lots of overkill here. KISS advocates, go away, shoo! ;) -- kaeza
147 local PNG_HDR = string.char(0x89, 0x50, 0x4E, 0x47, 0x0D, 0x0A, 0x1A, 0x0A)
149 -- check if a file does exist
150 -- to avoid reopening file after checking again
151 -- pass TRUE as second argument
152 local function file_exists(name, return_handle, mode)
154 local f = io.open(name, mode)
156 if (return_handle) then
166 -- Read the image size from a PNG file.
167 -- Returns image_w, image_h.
168 -- Only the LSB is read from each field!
169 function signs_lib.read_image_size(filename)
170 local f = file_exists(filename, true, "rb")
171 -- file might not exist (don't crash the game)
176 local hdr = f:read(string.len(PNG_HDR))
177 if hdr ~= PNG_HDR then
186 return ws:byte(), hs:byte()
189 -- 4 rows, max 80 chars per, plus a bit of fudge to
190 -- avoid excess trimming (e.g. due to color codes)
192 local MAX_INPUT_CHARS = 400
194 -- helper functions to trim sign text input/output
196 local function trim_input(text)
197 return text:sub(1, math.min(MAX_INPUT_CHARS, text:len()))
200 local function build_char_db(font_size)
204 -- To calculate average char width.
205 local total_width = 0
209 local w, h = signs_lib.read_image_size(CHAR_PATH:format("signs_lib_font_"..font_size.."px", c))
211 local ch = string.char(c)
213 total_width = total_width + w
214 char_count = char_count + 1
218 local cbw, cbh = signs_lib.read_image_size(TP.."/signs_lib_color_"..font_size.."px_n.png")
219 assert(cbw and cbh, "error reading bg dimensions")
220 return cw, cbw, cbh, (total_width / char_count)
223 signs_lib.charwidth15,
224 signs_lib.colorbgw15,
225 signs_lib.lineheight15,
226 signs_lib.avgwidth15 = build_char_db(15)
228 signs_lib.charwidth31,
229 signs_lib.colorbgw31,
230 signs_lib.lineheight31,
231 signs_lib.avgwidth31 = build_char_db(31)
233 local sign_groups = {choppy=2, dig_immediate=2}
234 local fences_with_sign = { }
236 -- some local helper functions
238 local function split_lines_and_words(text)
239 if not text then return end
241 for _, line in ipairs(text:split("\n")) do
242 table.insert(lines, line:split(" "))
247 local math_max = math.max
249 local function fill_line(x, y, w, c, font_size, colorbgw)
252 for xx = 0, math.max(0, w), colorbgw do
253 table.insert(tex, (":%d,%d=signs_lib_color_"..font_size.."px_%s.png"):format(x + xx, y, c))
255 return table.concat(tex)
258 -- make char texture file name
259 -- if texture file does not exist use fallback texture instead
260 local function char_tex(font_name, ch)
261 if ctexcache[font_name..ch] then
262 return ctexcache[font_name..ch], true
265 local exists, tex = file_exists(CHAR_PATH:format(font_name, c))
266 if exists and c ~= 14 then
267 tex = CHAR_FILE:format(font_name, c)
269 tex = CHAR_FILE:format(font_name, 0x0)
271 ctexcache[font_name..ch] = tex
276 local function make_line_texture(line, lineno, pos, line_width, line_height, cwidth_tab, font_size, colorbgw)
279 local font_name = "signs_lib_font_"..font_size.."px"
282 local node = minetest.get_node(pos)
283 local def = minetest.registered_items[node.name]
284 local default_color = def.default_color or 0
286 local cur_color = tonumber(default_color, 16)
288 -- We check which chars are available here.
289 for word_i, word in ipairs(line) do
292 word = string.gsub(word, "%^[12345678abcdefgh]", {
293 ["^1"] = string.char(0x81),
294 ["^2"] = string.char(0x82),
295 ["^3"] = string.char(0x83),
296 ["^4"] = string.char(0x84),
297 ["^5"] = string.char(0x85),
298 ["^6"] = string.char(0x86),
299 ["^7"] = string.char(0x87),
300 ["^8"] = string.char(0x88),
301 ["^a"] = string.char(0x8a),
302 ["^b"] = string.char(0x8b),
303 ["^c"] = string.char(0x8c),
304 ["^d"] = string.char(0x8d),
305 ["^e"] = string.char(0x8e),
306 ["^f"] = string.char(0x8f),
307 ["^g"] = string.char(0x90),
308 ["^h"] = string.char(0x91)
313 local c = word:sub(i, i)
315 local cc = tonumber(word:sub(i+1, i+1), 16)
321 local w = cwidth_tab[c]
323 width = width + w + 1
324 if width >= (line_width - cwidth_tab[" "]) then
327 maxw = math_max(width, maxw)
329 if #chars < MAX_INPUT_CHARS then
330 table.insert(chars, {
332 tex = char_tex(font_name, c),
333 col = ("%X"):format(cur_color),
336 ch_offs = ch_offs + w
341 width = width + cwidth_tab[" "] + 1
342 maxw = math_max(width, maxw)
343 table.insert(words, { chars=chars, w=ch_offs })
346 -- Okay, we actually build the "line texture" here.
350 local start_xpos = math.floor((line_width - maxw) / 2) + def.x_offset
352 local xpos = start_xpos
353 local ypos = (line_height + def.line_spacing)* lineno + def.y_offset
357 for word_i, word in ipairs(words) do
358 local xoffs = (xpos - start_xpos)
359 if (xoffs > 0) and ((xoffs + word.w) > maxw) then
360 table.insert(texture, fill_line(xpos, ypos, maxw, "n", font_size, colorbgw))
362 ypos = ypos + line_height + def.line_spacing
364 if lineno >= def.number_of_lines then break end
365 table.insert(texture, fill_line(xpos, ypos, maxw, cur_color, font_size, colorbgw))
367 for ch_i, ch in ipairs(word.chars) do
368 if ch.col ~= cur_color then
370 table.insert(texture, fill_line(xpos + ch.off, ypos, maxw, cur_color, font_size, colorbgw))
372 table.insert(texture, (":%d,%d=%s"):format(xpos + ch.off, ypos, ch.tex))
376 (":%d,%d="):format(xpos + word.w, ypos) .. char_tex(font_name, " ")
378 xpos = xpos + word.w + cwidth_tab[" "]
379 if xpos >= (line_width + cwidth_tab[" "]) then break end
382 table.insert(texture, fill_line(xpos, ypos, maxw, "n", font_size, colorbgw))
383 table.insert(texture, fill_line(start_xpos, ypos + line_height, maxw, "n", font_size, colorbgw))
385 return table.concat(texture), lineno
388 local function make_sign_texture(lines, pos)
389 local node = minetest.get_node(pos)
390 local def = minetest.registered_items[node.name]
398 if def.font_size and def.font_size == 31 then
400 line_width = math.floor(signs_lib.avgwidth31 * def.chars_per_line) * def.horiz_scaling
401 line_height = signs_lib.lineheight31
402 char_width = signs_lib.charwidth31
403 colorbgw = signs_lib.colorbgw31
406 line_width = math.floor(signs_lib.avgwidth15 * def.chars_per_line) * def.horiz_scaling
407 line_height = signs_lib.lineheight15
408 char_width = signs_lib.charwidth15
409 colorbgw = signs_lib.colorbgw15
412 local texture = { ("[combine:%dx%d"):format(line_width, (line_height + def.line_spacing) * def.number_of_lines * def.vert_scaling) }
416 if lineno >= def.number_of_lines then break end
417 local linetex, ln = make_line_texture(lines[i], lineno, pos, line_width, line_height, char_width, font_size, colorbgw)
418 table.insert(texture, linetex)
421 table.insert(texture, "^[makealpha:0,0,0")
422 return table.concat(texture, "")
425 local function set_obj_text(obj, text, x, pos)
426 local split = split_lines_and_words
427 local text_ansi = Utf8ToAnsi(text)
428 local n = minetest.registered_nodes[minetest.get_node(pos).name]
429 local text_scale = (n and n.text_scale) or DEFAULT_TEXT_SCALE
430 local texture = make_sign_texture(split(text_ansi), pos)
433 visual_size = text_scale,
437 local function make_widefont_nodename(name)
438 if string.find(name, "_widefont") then return name end
439 if string.find(name, "_onpole") then
440 return string.gsub(name, "_onpole", "_widefont_onpole")
441 elseif string.find(name, "_hanging") then
442 return string.gsub(name, "_hanging", "_widefont_hanging")
444 return name.."_widefont"
448 function signs_lib.construct_sign(pos)
449 local form = "size[6,4]"..
450 "textarea[0,-0.3;6.5,3;text;;${text}]"..
451 "background[-0.5,-0.5;7,5;signs_lib_sign_bg.jpg]"
452 local node = minetest.get_node(pos)
453 local wname = make_widefont_nodename(node.name)
455 if minetest.registered_items[wname] then
457 if string.find(node.name, "widefont") then state = "on" end
458 form = form.."label[1,3.4;Use wide font]"..
459 "image_button[1.1,3.7;1,0.6;signs_lib_switch_"..
461 state..";;;false;signs_lib_switch_interm.png]"..
462 "button_exit[3,3.4;2,1;ok;"..S("Write").."]"
464 form = form.."button_exit[2,3.4;2,1;ok;"..S("Write").."]"
467 local meta = minetest.get_meta(pos)
468 meta:set_string("formspec", form)
469 local i = meta:get_string("infotext")
470 if i == "" then -- it wasn't even set, so set it.
471 meta:set_string("infotext", "")
475 function signs_lib.destruct_sign(pos)
476 local objects = minetest.get_objects_inside_radius(pos, 0.5)
477 for _, v in ipairs(objects) do
478 local e = v:get_luaentity()
479 if e and e.name == "signs_lib:text" then
485 local function make_infotext(text)
486 text = trim_input(text)
487 local lines = split_lines_and_words(text) or {}
489 for _, line in ipairs(lines) do
490 table.insert(lines2, (table.concat(line, " "):gsub("#[0-9a-fA-F]", ""):gsub("##", "#")))
492 return table.concat(lines2, "\n")
495 function signs_lib.update_sign(pos, fields)
496 local meta = minetest.get_meta(pos)
498 local text = fields and fields.text or meta:get_string("text")
499 text = trim_input(text)
501 local owner = meta:get_string("owner")
503 if owner ~= "" then ownstr = S("Locked sign, owned by @1\n", owner) end
505 meta:set_string("text", text)
506 meta:set_string("infotext", ownstr..make_infotext(text).." ")
508 local objects = minetest.get_objects_inside_radius(pos, 0.5)
510 for _, v in ipairs(objects) do
511 local e = v:get_luaentity()
512 if e and e.name == "signs_lib:text" then
516 set_obj_text(v, text, nil, pos)
525 -- if there is no entity
526 local signnode = minetest.get_node(pos)
527 local signname = signnode.name
528 local def = minetest.registered_items[signname]
529 if not def.entity_info or not def.entity_info.yaw[signnode.param2 + 1] then return end
530 local obj = minetest.add_entity(pos, "signs_lib:text")
532 obj:setyaw(def.entity_info.yaw[signnode.param2 + 1])
534 mesh = def.entity_info.mesh,
538 function signs_lib.receive_fields(pos, formname, fields, sender)
540 if not fields or not signs_lib.can_modify(pos, sender) then return end
542 if fields.text and fields.ok then
543 minetest.log("action", S("@1 wrote \"@2\" to sign at @3",
544 (sender:get_player_name() or ""),
545 fields.text:gsub('\\', '\\\\'):gsub("\n", "\\n"),
546 minetest.pos_to_string(pos)
548 signs_lib.update_sign(pos, fields)
549 elseif fields.on or fields.off then
550 local node = minetest.get_node(pos)
553 if fields.on and string.find(node.name, "widefont") then
554 newname = string.gsub(node.name, "_widefont", "")
555 elseif fields.off and not string.find(node.name, "widefont") then
556 newname = make_widefont_nodename(node.name)
559 minetest.log("action", S("@1 flipped the wide-font switch to \"@2\" at @3",
560 (sender:get_player_name() or ""),
561 (fields.on and "off" or "on"),
562 minetest.pos_to_string(pos)
565 minetest.swap_node(pos, {name = newname, param2 = node.param2})
566 signs_lib.construct_sign(pos)
567 signs_lib.update_sign(pos, fields)
572 function signs_lib.can_modify(pos, player)
573 local meta = minetest.get_meta(pos)
574 local owner = meta:get_string("owner")
575 local playername = player:get_player_name()
577 if minetest.is_protected(pos, playername) then
578 minetest.record_protection_violation(pos, playername)
583 or playername == owner
584 or (minetest.check_player_privs(playername, {sign_editor=true}))
585 or (playername == minetest.settings:get("name")) then
588 minetest.record_protection_violation(pos, playername)
592 local signs_text_on_activate = function(self)
593 local pos = self.object:getpos()
594 local meta = minetest.get_meta(pos)
595 local signnode = minetest.get_node(pos)
596 local signname = signnode.name
597 local def = minetest.registered_items[signname]
598 local text = meta:get_string("text")
599 if text and def and def.entity_info then
600 text = trim_input(text)
601 set_obj_text(self.object, text, nil, pos)
602 self.object:set_properties({
603 mesh = def.entity_info.mesh,
608 minetest.register_entity("signs_lib:text", {
609 collisionbox = { 0, 0, 0, 0, 0, 0 },
611 mesh = "signs_lib_standard_wall_sign_entity.obj",
613 on_activate = signs_text_on_activate,
616 -- make selection boxes
617 -- sizex/sizey specified in inches because that's what MUTCD uses.
619 function signs_lib.make_selection_boxes(sizex, sizey, foo, xoffs, yoffs, zoffs, is_facedir)
621 local tx = (sizex * 0.0254 ) / 2
622 local ty = (sizey * 0.0254 ) / 2
623 local xo = xoffs and xoffs * 0.0254 or 0
624 local yo = yoffs and yoffs * 0.0254 or 0
625 local zo = zoffs and zoffs * 0.0254 or 0
627 if not is_facedir then
629 type = "wallmounted",
630 wall_side = { -0.5 + zo, -ty + yo, -tx + xo, -0.4375 + zo, ty + yo, tx + xo },
631 wall_top = { -tx - xo, 0.5 + zo, -ty + yo, tx - xo, 0.4375 + zo, ty + yo},
632 wall_bottom = { -tx - xo, -0.5 + zo, -ty + yo, tx - xo, -0.4375 + zo, ty + yo }
637 fixed = { -tx + xo, -ty + yo, 0.5 + zo, tx + xo, ty + yo, 0.4375 + zo}
642 function signs_lib.check_for_pole(pos, pointed_thing)
643 local ppos = minetest.get_pointed_thing_position(pointed_thing)
644 local pnode = minetest.get_node(ppos)
645 local pdef = minetest.registered_items[pnode.name]
647 if (signs_lib.allowed_poles[pnode.name]
648 or (pdef and pdef.drawtype == "fencelike")
649 or string.find(pnode.name, "default:fence_")
650 or string.find(pnode.name, "_post")
651 or string.find(pnode.name, "fencepost")
652 or (pnode.name == "streets:bigpole" and pnode.param2 < 4)
653 or (pnode.name == "streets:bigpole" and pnode.param2 > 19 and pnode.param2 < 24)
656 (pos.x ~= ppos.x or pos.z ~= ppos.z) then
661 function signs_lib.check_for_ceiling(pointed_thing)
662 if pointed_thing.above.x == pointed_thing.under.x
663 and pointed_thing.above.z == pointed_thing.under.z
664 and pointed_thing.above.y < pointed_thing.under.y then
669 function signs_lib.after_place_node(pos, placer, itemstack, pointed_thing, locked)
670 local playername = placer:get_player_name()
671 local def = minetest.registered_items[itemstack:get_name()]
673 local ppos = minetest.get_pointed_thing_position(pointed_thing)
674 local pnode = minetest.get_node(ppos)
675 local pdef = minetest.registered_items[pnode.name]
677 if (def.allow_onpole ~= false) and signs_lib.check_for_pole(pos, pointed_thing) then
678 local node = minetest.get_node(pos)
679 minetest.swap_node(pos, {name = itemstack:get_name().."_onpole", param2 = node.param2})
680 elseif def.allow_hanging and signs_lib.check_for_ceiling(pointed_thing) then
681 local newparam2 = minetest.dir_to_facedir(placer:get_look_dir())
682 local node = minetest.get_node(pos)
683 minetest.swap_node(pos, {name = itemstack:get_name().."_hanging", param2 = newparam2})
686 local meta = minetest.get_meta(pos)
687 meta:set_string("owner", playername)
688 meta:set_string("infotext", S("Locked sign, owned by @1\n", playername))
692 function signs_lib.register_fence_with_sign()
693 minetest.log("warning", "[signs_lib] ".."Attempt to call no longer used function signs_lib.register_fence_with_sign()")
696 local function register_sign(name, rdef)
697 local def = table.copy(rdef)
699 if rdef.entity_info == "standard" then
701 mesh = "signs_lib_standard_wall_sign_entity.obj",
702 yaw = signs_lib.wallmounted_yaw
704 elseif rdef.entity_info then
705 def.entity_info = rdef.entity_info
708 if rdef.entity_info then
709 def.on_rightclick = rdef.on_rightclick or signs_lib.construct_sign
710 def.on_construct = rdef.on_construct or signs_lib.construct_sign
711 def.on_destruct = rdef.on_destruct or signs_lib.destruct_sign
712 def.on_receive_fields = rdef.on_receive_fields or signs_lib.receive_fields
713 def.on_punch = rdef.on_punch or signs_lib.update_sign
714 def.number_of_lines = rdef.number_of_lines or signs_lib.standard_lines
715 def.horiz_scaling = rdef.horiz_scaling or signs_lib.standard_hscale
716 def.vert_scaling = rdef.vert_scaling or signs_lib.standard_vscale
717 def.line_spacing = rdef.line_spacing or signs_lib.standard_lspace
718 def.font_size = rdef.font_size or signs_lib.standard_fsize
719 def.x_offset = rdef.x_offset or signs_lib.standard_xoffs
720 def.y_offset = rdef.y_offset or signs_lib.standard_yoffs
721 def.chars_per_line = rdef.chars_per_line or signs_lib.standard_cpl
722 def.default_color = rdef.default_color or "0"
723 if rdef.locked and not rdef.after_place_node then
724 def.after_place_node = function(pos, placer, itemstack, pointed_thing)
725 signs_lib.after_place_node(pos, placer, itemstack, pointed_thing, true)
728 def.after_place_node = rdef.after_place_node or signs_lib.after_place_node
732 def.paramtype = rdef.paramtype or "light"
733 def.drawtype = rdef.drawtype or "mesh"
734 def.mesh = rdef.mesh or "signs_lib_standard_wall_sign.obj"
735 def.wield_image = rdef.wield_image or def.inventory_image
736 def.drop = rdef.drop or name
737 def.sounds = rdef.sounds or signs_lib.standard_wood_sign_sounds
738 def.on_rotate = rdef.on_rotate or signs_lib.wallmounted_rotate
739 def.paramtype2 = rdef.paramtype2 or "wallmounted"
741 if rdef.on_rotate then
742 def.on_rotate = rdef.on_rotate
743 elseif rdef.drawtype == "wallmounted" then
744 def.on_rotate = signs_lib.wallmounted_rotate
746 def.on_rotate = signs_lib.facedir_rotate
750 def.groups = rdef.groups
752 def.groups = signs_lib.standard_wood_groups
755 local cbox = signs_lib.make_selection_boxes(35, 25, allow_onpole)
757 def.selection_box = rdef.selection_box or cbox
758 def.node_box = table.copy(rdef.node_box or rdef.selection_box or cbox)
760 if def.sunlight_propagates ~= false then
761 def.sunlight_propagates = true
764 minetest.register_node(":"..name, def)
765 table.insert(signs_lib.lbm_restore_nodes, name)
767 if rdef.allow_onpole ~= false then
769 local opdef = table.copy(def)
771 local offset = 0.3125
772 if opdef.uses_slim_pole_mount then
776 opdef.selection_box = rdef.onpole_selection_box or opdef.selection_box
777 opdef.node_box = rdef.onpole_node_box or opdef.selection_box
779 if opdef.paramtype2 == "wallmounted" then
780 opdef.node_box.wall_side[1] = def.node_box.wall_side[1] - offset
781 opdef.node_box.wall_side[4] = def.node_box.wall_side[4] - offset
783 opdef.selection_box.wall_side[1] = def.selection_box.wall_side[1] - offset
784 opdef.selection_box.wall_side[4] = def.selection_box.wall_side[4] - offset
786 opdef.node_box.fixed[3] = def.node_box.fixed[3] + offset
787 opdef.node_box.fixed[6] = def.node_box.fixed[6] + offset
789 opdef.selection_box.fixed[3] = def.selection_box.fixed[3] + offset
790 opdef.selection_box.fixed[6] = def.selection_box.fixed[6] + offset
793 opdef.groups.not_in_creative_inventory = 1
794 opdef.tiles[3] = "signs_lib_pole_mount.png"
795 opdef.mesh = string.gsub(opdef.mesh, ".obj$", "_onpole.obj")
796 opdef.on_rotate = nil
799 if opdef.entity_info then
800 opdef.entity_info.mesh = string.gsub(opdef.entity_info.mesh, ".obj$", "_onpole.obj")
802 minetest.register_node(":"..name.."_onpole", opdef)
803 table.insert(signs_lib.lbm_restore_nodes, name.."_onpole")
806 if rdef.allow_hanging then
808 local hdef = table.copy(def)
809 hdef.paramtype2 = "facedir"
811 local hcbox = signs_lib.make_selection_boxes(35, 32, false, 0, 3, -18.5, true)
813 hdef.selection_box = rdef.hanging_selection_box or hcbox
814 hdef.node_box = rdef.hanging_node_box or rdef.hanging_selection_box or hcbox
816 hdef.groups.not_in_creative_inventory = 1
817 hdef.tiles[3] = "signs_lib_hangers.png"
818 hdef.mesh = string.gsub(string.gsub(hdef.mesh, "_facedir.obj", ".obj"), ".obj$", "_hanging.obj")
821 if hdef.entity_info then
822 hdef.entity_info.mesh = string.gsub(string.gsub(hdef.entity_info.mesh, "_facedir.obj", ".obj"), ".obj$", "_hanging.obj")
823 hdef.entity_info.yaw = signs_lib.standard_yaw
826 minetest.register_node(":"..name.."_hanging", hdef)
827 table.insert(signs_lib.lbm_restore_nodes, name.."_hanging")
832 The main sign registration function
833 ===================================
835 Example minimal recommended def for writable signs:
837 signs_lib.register_sign("foo:my_cool_sign", {
838 description = "Wooden cool sign",
839 inventory_image = "signs_lib_sign_cool_inv.png",
841 "signs_lib_sign_cool.png",
842 "signs_lib_sign_cool_edges.png"
852 entity_info = "standard"
855 * default def assumes a wallmounted sign with on-pole being allowed.
857 *For signs that can't support onpole, include in the def:
858 allow_onpole = false,
860 * "standard" entity info implies the standard wood/steel sign model, in
861 wallmounted mode. For facedir signs using the standard model, use:
864 mesh = "signs_lib_standard_wall_sign_entity.obj",
865 yaw = signs_lib.standard_yaw
870 function signs_lib.register_sign(name, rdef)
871 register_sign(name, rdef)
873 if rdef.allow_widefont then
875 wdef = table.copy(minetest.registered_items[name])
876 wdef.groups.not_in_creative_inventory = 1
877 wdef.horiz_scaling = wdef.horiz_scaling / 2
879 register_sign(name.."_widefont", wdef)
883 -- restore signs' text after /clearobjects and the like, the next time
884 -- a block is reloaded by the server.
886 minetest.register_lbm({
887 nodenames = signs_lib.lbm_restore_nodes,
888 name = "signs_lib:restore_sign_text",
889 label = "Restore sign text",
890 run_at_every_load = true,
891 action = function(pos, node)
892 signs_lib.update_sign(pos,nil,nil,node)
896 -- Convert old signs on fenceposts into signs on.. um.. fence posts :P
898 minetest.register_lbm({
899 nodenames = signs_lib.old_fenceposts_with_signs,
900 name = "signs_lib:fix_fencepost_signs",
901 label = "Change single-node signs on fences into normal",
902 run_at_every_load = true,
903 action = function(pos, node)
905 local fdir = node.param2 % 8
907 x = pos.x + signs_lib.fdir_to_back[fdir+1][1],
909 z = pos.z + signs_lib.fdir_to_back[fdir+1][2]
912 if minetest.get_node(signpos).name == "air" then
913 local new_wmdir = minetest.dir_to_wallmounted(minetest.facedir_to_dir(fdir))
914 local oldfence = signs_lib.old_fenceposts[node.name]
915 local newsign = signs_lib.old_fenceposts_replacement_signs[node.name]
917 for _, v in ipairs(minetest.get_objects_inside_radius(pos, 0.5)) do
918 local e = v:get_luaentity()
919 if e and e.name == "signs_lib:text" then
924 local oldmeta = minetest.get_meta(pos):to_table()
925 minetest.set_node(pos, {name = oldfence})
926 minetest.set_node(signpos, { name = newsign, param2 = new_wmdir })
927 local newmeta = minetest.get_meta(signpos)
928 newmeta:from_table(oldmeta)
929 signs_lib.update_sign(signpos)
934 signs_lib.block_list = {}
935 signs_lib.totalblocks = 0
937 -- Maintain a list of currently-loaded blocks
938 minetest.register_lbm({
939 nodenames = {"group:sign"},
940 name = "signs_lib:update_block_list",
941 label = "Update list of loaded blocks, log only those with signs",
942 run_at_every_load = true,
943 action = function(pos, node)
944 -- yeah, yeah... I know I'm hashing a block pos, but it's still just a set of coords
945 local hash = minetest.hash_node_position(vector.floor(vector.divide(pos, core.MAP_BLOCKSIZE)))
946 if not signs_lib.block_list[hash] then
947 signs_lib.block_list[hash] = true
948 signs_lib.totalblocks = signs_lib.totalblocks + 1
953 minetest.register_chatcommand("regen_signs", {
955 privs = {server = true},
956 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.",
957 func = function(player_name, params)
960 for b in pairs(signs_lib.block_list) do
961 local blockpos = minetest.get_position_from_hash(b)
962 local pos1 = vector.multiply(blockpos, core.MAP_BLOCKSIZE)
963 local pos2 = vector.add(pos1, core.MAP_BLOCKSIZE - 1)
964 if minetest.get_node_or_nil(vector.add(pos1, core.MAP_BLOCKSIZE/2)) then
965 local signs_in_block = minetest.find_nodes_in_area(pos1, pos2, {"group:sign"})
966 allsigns[#allsigns + 1] = signs_in_block
967 totalsigns = totalsigns + #signs_in_block
969 signs_lib.block_list[b] = nil -- if the block is no longer loaded, remove it from the table
970 signs_lib.totalblocks = signs_lib.totalblocks - 1
973 if signs_lib.totalblocks < 0 then signs_lib.totalblocks = 0 end
974 if totalsigns == 0 then
975 minetest.chat_send_player(player_name, "There are no signs in the currently-loaded terrain.")
976 signs_lib.block_list = {}
980 minetest.chat_send_player(player_name, "Found a total of "..totalsigns.." sign nodes across "..signs_lib.totalblocks.." blocks.")
981 minetest.chat_send_player(player_name, "Regenerating sign entities...")
983 for _, b in pairs(allsigns) do
984 for _, pos in ipairs(b) do
985 local objects = minetest.get_objects_inside_radius(pos, 0.5)
987 for _, v in ipairs(objects) do
991 local node = minetest.get_node(pos)
992 local def = minetest.registered_items[node.name]
993 if def and def.entity_info then
994 signs_lib.update_sign(pos)
998 minetest.chat_send_player(player_name, "Finished.")