1 -- This mod provides the visible text on signs library used by Home Decor
2 -- and perhaps other mods at some point in the future. Forked from thexyz's/
3 -- PilzAdam's original text-on-signs mod and rewritten by Vanessa Ezekowitz
7 -- { delta = {entity position for 0° yaw}, exact yaw expression }
8 -- { delta = {entity position for 180° yaw}, exact yaw expression }
9 -- { delta = {entity position for 270° yaw}, exact yaw expression }
10 -- { delta = {entity position for 90° yaw}, exact yaw expression }
12 -- Made colored metal signs optionals
13 local enable_colored_metal_signs = true
15 -- CWz's keyword interact mod uses this setting.
16 local current_keyword = minetest.settings:get("interact_keyword") or "iaccept"
19 signs_lib.path = minetest.get_modpath(minetest.get_current_modname())
20 screwdriver = screwdriver or {}
22 -- Load support for intllib.
23 local S, NS = dofile(signs_lib.path .. "/intllib.lua")
27 dofile(signs_lib.path .. "/encoding.lua");
29 -- Initialize character texture cache
33 local wall_dir_change = {
43 signs_lib.wallmounted_rotate = function(pos, node, user, mode)
44 if mode ~= screwdriver.ROTATE_FACE then return false end
45 minetest.swap_node(pos, { name = node.name, param2 = wall_dir_change[node.param2 % 6] })
46 signs_lib.update_sign(pos,nil,nil,node)
50 signs_lib.facedir_rotate = function(pos, node, user, mode)
51 if mode ~= screwdriver.ROTATE_FACE then return false end
52 local newparam2 = (node.param2 %8) + 1
53 if newparam2 == 5 then
55 elseif newparam2 > 6 then
58 minetest.swap_node(pos, { name = node.name, param2 = newparam2 })
59 signs_lib.update_sign(pos,nil,nil,node)
63 signs_lib.facedir_rotate_simple = function(pos, node, user, mode)
64 if mode ~= screwdriver.ROTATE_FACE then return false end
65 local newparam2 = (node.param2 %8) + 1
66 if newparam2 > 3 then newparam2 = 0 end
67 minetest.swap_node(pos, { name = node.name, param2 = newparam2 })
68 signs_lib.update_sign(pos,nil,nil,node)
73 signs_lib.modpath = minetest.get_modpath("signs_lib")
75 local DEFAULT_TEXT_SCALE = {x=0.8, y=0.5}
77 signs_lib.regular_wall_sign_model = {
80 wall_side = { -0.5, -0.25, -0.4375, -0.4375, 0.375, 0.4375 },
81 wall_bottom = { -0.4375, -0.5, -0.25, 0.4375, -0.4375, 0.375 },
82 wall_top = { -0.4375, 0.4375, -0.375, 0.4375, 0.5, 0.25 }
87 {delta = { x = 0.41, y = 0.07, z = 0 }, yaw = math.pi / -2},
88 {delta = { x = -0.41, y = 0.07, z = 0 }, yaw = math.pi / 2},
89 {delta = { x = 0, y = 0.07, z = 0.41 }, yaw = 0},
90 {delta = { x = 0, y = 0.07, z = -0.41 }, yaw = math.pi},
94 signs_lib.metal_wall_sign_model = {
97 fixed = {-0.4375, -0.25, 0.4375, 0.4375, 0.375, 0.5}
100 {delta = { x = 0, y = 0.07, z = 0.41 }, yaw = 0},
101 {delta = { x = 0.41, y = 0.07, z = 0 }, yaw = math.pi / -2},
102 {delta = { x = 0, y = 0.07, z = -0.41 }, yaw = math.pi},
103 {delta = { x = -0.41, y = 0.07, z = 0 }, yaw = math.pi / 2},
107 signs_lib.yard_sign_model = {
111 {-0.4375, -0.25, -0.0625, 0.4375, 0.375, 0},
112 {-0.0625, -0.5, -0.0625, 0.0625, -0.1875, 0},
116 {delta = { x = 0, y = 0.07, z = -0.08 }, yaw = 0},
117 {delta = { x = -0.08, y = 0.07, z = 0 }, yaw = math.pi / -2},
118 {delta = { x = 0, y = 0.07, z = 0.08 }, yaw = math.pi},
119 {delta = { x = 0.08, y = 0.07, z = 0 }, yaw = math.pi / 2},
123 signs_lib.hanging_sign_model = {
127 {-0.4375, -0.3125, -0.0625, 0.4375, 0.3125, 0},
128 {-0.4375, 0.25, -0.03125, 0.4375, 0.5, -0.03125},
132 {delta = { x = 0, y = -0.02, z = -0.08 }, yaw = 0},
133 {delta = { x = -0.08, y = -0.02, z = 0 }, yaw = math.pi / -2},
134 {delta = { x = 0, y = -0.02, z = 0.08 }, yaw = math.pi},
135 {delta = { x = 0.08, y = -0.02, z = 0 }, yaw = math.pi / 2},
139 signs_lib.sign_post_model = {
143 {-0.4375, -0.25, -0.1875, 0.4375, 0.375, -0.125},
144 {-0.125, -0.5, -0.125, 0.125, 0.5, 0.125},
148 {delta = { x = 0, y = 0.07, z = -0.2 }, yaw = 0},
149 {delta = { x = -0.2, y = 0.07, z = 0 }, yaw = math.pi / -2},
150 {delta = { x = 0, y = 0.07, z = 0.2 }, yaw = math.pi},
151 {delta = { x = 0.2, y = 0.07, z = 0 }, yaw = math.pi / 2},
155 -- the list of standard sign nodes
157 signs_lib.sign_node_list = {
158 "default:sign_wall_wood",
159 "default:sign_wall_steel",
161 "signs:sign_hanging",
162 "signs:sign_wall_green",
163 "signs:sign_wall_yellow",
164 "signs:sign_wall_red",
165 "signs:sign_wall_white_red",
166 "signs:sign_wall_white_black",
167 "signs:sign_wall_orange",
168 "signs:sign_wall_blue",
169 "signs:sign_wall_brown",
170 "locked_sign:sign_wall_locked"
173 local default_sign, default_sign_image
175 -- Default sign was renamed in 0.4.14. Support both & old versions.
176 if minetest.registered_nodes["default:sign_wall_wood"] then
177 default_sign = "default:sign_wall_wood"
178 default_sign_image = "default_sign_wood.png"
180 default_sign = "default:sign_wall"
181 default_sign_image = "default_sign_wall.png"
184 default_sign_metal = "default:sign_wall_steel"
185 default_sign_metal_image = "default_sign_steel.png"
189 function signs_lib.table_copy(t)
191 for k, v in pairs(t) do
192 if type(v) == "table" then
193 nt[k] = signs_lib.table_copy(v)
203 if not minetest.settings:get_bool("creative_mode") then
204 signs_lib.expect_infinite_stacks = false
206 signs_lib.expect_infinite_stacks = true
211 -- Path to the textures.
212 local TP = signs_lib.path .. "/textures"
213 -- Font file formatter
214 local CHAR_FILE = "%s_%02x.png"
216 local CHAR_PATH = TP .. "/" .. CHAR_FILE
219 local font_name = "hdf"
221 -- Lots of overkill here. KISS advocates, go away, shoo! ;) -- kaeza
223 local PNG_HDR = string.char(0x89, 0x50, 0x4E, 0x47, 0x0D, 0x0A, 0x1A, 0x0A)
225 -- check if a file does exist
226 -- to avoid reopening file after checking again
227 -- pass TRUE as second argument
228 function file_exists(name, return_handle, mode)
230 local f = io.open(name, mode)
232 if (return_handle) then
242 -- Read the image size from a PNG file.
243 -- Returns image_w, image_h.
244 -- Only the LSB is read from each field!
245 local function read_image_size(filename)
246 local f = file_exists(filename, true, "rb")
247 -- file might not exist (don't crash the game)
252 local hdr = f:read(string.len(PNG_HDR))
253 if hdr ~= PNG_HDR then
262 return ws:byte(), hs:byte()
265 -- Set by build_char_db()
268 local COLORBGW, COLORBGH
270 -- Size of the canvas, in characters.
271 -- Please note that CHARS_PER_LINE is multiplied by the average character
272 -- width to get the total width of the canvas, so for proportional fonts,
273 -- either more or fewer characters may fit on a line.
274 local CHARS_PER_LINE = 30
275 local NUMBER_OF_LINES = 6
277 -- 6 rows, max 80 chars per, plus a bit of fudge to
278 -- avoid excess trimming (e.g. due to color codes)
280 local MAX_INPUT_CHARS = 600
282 -- This holds the individual character widths.
283 -- Indexed by the actual character (e.g. charwidth["A"])
286 -- helper functions to trim sign text input/output
288 local function trim_input(text)
289 return text:sub(1, math.min(MAX_INPUT_CHARS, text:len()))
292 local function build_char_db()
296 -- To calculate average char width.
297 local total_width = 0
301 local w, h = read_image_size(CHAR_PATH:format(font_name, c))
303 local ch = string.char(c)
305 total_width = total_width + w
306 char_count = char_count + 1
310 COLORBGW, COLORBGH = read_image_size(TP.."/slc_n.png")
311 assert(COLORBGW and COLORBGH, "error reading bg dimensions")
312 LINE_HEIGHT = COLORBGH
314 -- XXX: Is there a better way to calc this?
315 SIGN_WIDTH = math.floor((total_width / char_count) * CHARS_PER_LINE)
319 local sign_groups = {choppy=2, dig_immediate=2}
321 local fences_with_sign = { }
323 -- some local helper functions
325 local function split_lines_and_words_old(text)
328 if not text then return end
329 for word in text:gmatch("%S+") do
331 table.insert(lines, line)
332 if #lines >= NUMBER_OF_LINES then break end
334 elseif word == "\\|" then
335 table.insert(line, "|")
337 table.insert(line, word)
340 table.insert(lines, line)
344 local function split_lines_and_words(text)
345 if not text then return end
346 text = string.gsub(text, "@KEYWORD", current_keyword)
348 for _, line in ipairs(text:split("\n")) do
349 table.insert(lines, line:split(" "))
354 local math_max = math.max
356 local function fill_line(x, y, w, c)
359 for xx = 0, math.max(0, w), COLORBGW do
360 table.insert(tex, (":%d,%d=slc_%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)
389 local n = minetest.registered_nodes[minetest.get_node(pos).name]
390 local default_color = n.default_color or 0
392 local cur_color = tonumber(default_color, 16)
394 -- We check which chars are available here.
395 for word_i, word in ipairs(line) do
398 word = string.gsub(word, "%^[12345678abcdefgh]", {
399 ["^1"] = string.char(0x81),
400 ["^2"] = string.char(0x82),
401 ["^3"] = string.char(0x83),
402 ["^4"] = string.char(0x84),
403 ["^5"] = string.char(0x85),
404 ["^6"] = string.char(0x86),
405 ["^7"] = string.char(0x87),
406 ["^8"] = string.char(0x88),
407 ["^a"] = string.char(0x8a),
408 ["^b"] = string.char(0x8b),
409 ["^c"] = string.char(0x8c),
410 ["^d"] = string.char(0x8d),
411 ["^e"] = string.char(0x8e),
412 ["^f"] = string.char(0x8f),
413 ["^g"] = string.char(0x90),
414 ["^h"] = string.char(0x91)
419 local c = word:sub(i, i)
421 local cc = tonumber(word:sub(i+1, i+1), 16)
427 local w = charwidth[c]
429 width = width + w + 1
430 if width >= (SIGN_WIDTH - charwidth[" "]) then
433 maxw = math_max(width, maxw)
435 if #chars < MAX_INPUT_CHARS then
436 table.insert(chars, {
438 tex = char_tex(font_name, c),
439 col = ("%X"):format(cur_color),
442 ch_offs = ch_offs + w
447 width = width + charwidth[" "] + 1
448 maxw = math_max(width, maxw)
449 table.insert(words, { chars=chars, w=ch_offs })
452 -- Okay, we actually build the "line texture" here.
456 local start_xpos = math.floor((SIGN_WIDTH - maxw) / 2)
458 local xpos = start_xpos
459 local ypos = (LINE_HEIGHT * lineno)
463 for word_i, word in ipairs(words) do
464 local xoffs = (xpos - start_xpos)
465 if (xoffs > 0) and ((xoffs + word.w) > maxw) then
466 table.insert(texture, fill_line(xpos, ypos, maxw, "n"))
468 ypos = ypos + LINE_HEIGHT
470 if lineno >= NUMBER_OF_LINES then break end
471 table.insert(texture, fill_line(xpos, ypos, maxw, cur_color))
473 for ch_i, ch in ipairs(word.chars) do
474 if ch.col ~= cur_color then
476 table.insert(texture, fill_line(xpos + ch.off, ypos, maxw, cur_color))
478 table.insert(texture, (":%d,%d=%s"):format(xpos + ch.off, ypos, ch.tex))
482 (":%d,%d="):format(xpos + word.w, ypos) .. char_tex(font_name, " ")
484 xpos = xpos + word.w + charwidth[" "]
485 if xpos >= (SIGN_WIDTH + charwidth[" "]) then break end
488 table.insert(texture, fill_line(xpos, ypos, maxw, "n"))
489 table.insert(texture, fill_line(start_xpos, ypos + LINE_HEIGHT, maxw, "n"))
491 return table.concat(texture), lineno
494 local function make_sign_texture(lines, pos)
495 local texture = { ("[combine:%dx%d"):format(SIGN_WIDTH, LINE_HEIGHT * NUMBER_OF_LINES) }
498 if lineno >= NUMBER_OF_LINES then break end
499 local linetex, ln = make_line_texture(lines[i], lineno, pos)
500 table.insert(texture, linetex)
503 table.insert(texture, "^[makealpha:0,0,0")
504 return table.concat(texture, "")
507 local function set_obj_text(obj, text, new, pos)
508 local split = new and split_lines_and_words or split_lines_and_words_old
509 local text_ansi = Utf8ToAnsi(text)
510 local n = minetest.registered_nodes[minetest.get_node(pos).name]
511 local text_scale = (n and n.text_scale) or DEFAULT_TEXT_SCALE
513 textures={make_sign_texture(split(text_ansi), pos)},
514 visual_size = text_scale,
518 signs_lib.construct_sign = function(pos, locked)
519 local meta = minetest.get_meta(pos)
523 "textarea[0,-0.3;6.5,3;text;;${text}]"..
524 "button_exit[2,3.4;2,1;ok;"..S("Write").."]"..
525 "background[-0.5,-0.5;7,5;bg_signs_lib.jpg]")
526 meta:set_string("infotext", "")
529 signs_lib.destruct_sign = function(pos)
530 local objects = minetest.get_objects_inside_radius(pos, 0.5)
531 for _, v in ipairs(objects) do
532 local e = v:get_luaentity()
533 if e and e.name == "signs:text" then
539 local function make_infotext(text)
540 text = trim_input(text)
541 local lines = split_lines_and_words(text) or {}
543 for _, line in ipairs(lines) do
544 table.insert(lines2, (table.concat(line, " "):gsub("#[0-9a-fA-F]", ""):gsub("##", "#")))
546 return table.concat(lines2, "\n")
549 signs_lib.update_sign = function(pos, fields, owner, node)
551 -- First, check if the interact keyword from CWz's mod is being set,
552 -- or has been changed since the last restart...
554 local meta = minetest.get_meta(pos)
555 local stored_text = meta:get_string("text") or ""
556 current_keyword = rawget(_G, "mki_interact_keyword") or current_keyword
558 if fields then -- ...we're editing the sign.
559 if fields.text and string.find(dump(fields.text), "@KEYWORD") then
560 meta:set_string("keyword", current_keyword)
562 meta:set_string("keyword", nil)
564 elseif string.find(dump(stored_text), "@KEYWORD") then -- we need to check if the password is being set/changed
566 local stored_keyword = meta:get_string("keyword")
567 if stored_keyword and stored_keyword ~= "" and stored_keyword ~= current_keyword then
568 signs_lib.destruct_sign(pos)
569 meta:set_string("keyword", current_keyword)
571 if owner then ownstr = S("Locked sign, owned by @1\n", owner) end
572 meta:set_string("infotext", ownstr..string.gsub(make_infotext(stored_text), "@KEYWORD", current_keyword).." ")
580 fields.text = trim_input(fields.text)
583 if owner then ownstr = S("Locked sign, owned by @1\n", owner) end
585 meta:set_string("infotext", ownstr..string.gsub(make_infotext(fields.text), "@KEYWORD", current_keyword).." ")
586 meta:set_string("text", fields.text)
588 meta:set_int("__signslib_new_format", 1)
591 new = (meta:get_int("__signslib_new_format") ~= 0)
593 signs_lib.destruct_sign(pos)
594 local text = meta:get_string("text")
595 if text == nil or text == "" then return end
597 local signnode = node or minetest.get_node(pos)
598 local signname = signnode.name
599 local textpos = minetest.registered_nodes[signname].textpos
601 sign_info = textpos[minetest.get_node(pos).param2 + 1]
602 elseif signnode.name == "signs:sign_yard" then
603 sign_info = signs_lib.yard_sign_model.textpos[minetest.get_node(pos).param2 + 1]
604 elseif signnode.name == "signs:sign_hanging" then
605 sign_info = signs_lib.hanging_sign_model.textpos[minetest.get_node(pos).param2 + 1]
606 elseif string.find(signnode.name, "sign_wall") then
607 if signnode.name == default_sign
608 or signnode.name == default_sign_metal
609 or signnode.name == "locked_sign:sign_wall_locked" then
610 sign_info = signs_lib.regular_wall_sign_model.textpos[minetest.get_node(pos).param2 + 1]
612 sign_info = signs_lib.metal_wall_sign_model.textpos[minetest.get_node(pos).param2 + 1]
614 else -- ...it must be a sign on a fence post.
615 sign_info = signs_lib.sign_post_model.textpos[minetest.get_node(pos).param2 + 1]
617 if sign_info == nil then
620 local text = minetest.add_entity({x = pos.x + sign_info.delta.x,
621 y = pos.y + sign_info.delta.y,
622 z = pos.z + sign_info.delta.z}, "signs:text")
623 text:setyaw(sign_info.yaw)
626 -- What kind of sign do we need to place, anyway?
628 function signs_lib.determine_sign_type(itemstack, placer, pointed_thing, locked)
630 name = minetest.get_node(pointed_thing.under).name
631 if fences_with_sign[name] then
632 if minetest.is_protected(pointed_thing.under, placer:get_player_name()) then
633 minetest.record_protection_violation(pointed_thing.under,
634 placer:get_player_name())
638 name = minetest.get_node(pointed_thing.above).name
639 local def = minetest.registered_nodes[name]
640 if not def.buildable_to then
643 if minetest.is_protected(pointed_thing.above, placer:get_player_name()) then
644 minetest.record_protection_violation(pointed_thing.above,
645 placer:get_player_name())
650 local node=minetest.get_node(pointed_thing.under)
652 if minetest.registered_nodes[node.name] and
653 minetest.registered_nodes[node.name].on_rightclick and
654 not placer:get_player_control().sneak then
655 return minetest.registered_nodes[node.name].on_rightclick(pointed_thing.under, node, placer, itemstack, pointed_thing)
657 local above = pointed_thing.above
658 local under = pointed_thing.under
659 local dir = {x = under.x - above.x,
660 y = under.y - above.y,
661 z = under.z - above.z}
663 local wdir = minetest.dir_to_wallmounted(dir)
665 local placer_pos = placer:getpos()
668 x = above.x - placer_pos.x,
669 y = above.y - placer_pos.y,
670 z = above.z - placer_pos.z
674 local fdir = minetest.dir_to_facedir(dir)
675 local pt_name = minetest.get_node(under).name
676 local signname = itemstack:get_name()
678 if fences_with_sign[pt_name] and signname == default_sign then
679 minetest.add_node(under, {name = fences_with_sign[pt_name], param2 = fdir})
680 elseif wdir == 0 and signname == default_sign then
681 minetest.add_node(above, {name = "signs:sign_hanging", param2 = fdir})
682 elseif wdir == 1 and signname == default_sign then
683 minetest.add_node(above, {name = "signs:sign_yard", param2 = fdir})
684 elseif signname == default_sign_metal then
685 minetest.add_node(above, {name = signname, param2 = wdir })
686 elseif signname ~= default_sign
687 and signname ~= default_sign_metal
688 and signname ~= "locked_sign:sign_wall_locked" then -- it's a signs_lib colored metal wall sign.
689 minetest.add_node(above, {name = signname, param2 = fdir})
690 else -- it must be a default or locked wooden wall sign
691 minetest.add_node(above, {name = signname, param2 = wdir }) -- note it's wallmounted here!
693 local meta = minetest.get_meta(above)
694 local owner = placer:get_player_name()
695 meta:set_string("owner", owner)
699 if not signs_lib.expect_infinite_stacks then
700 itemstack:take_item()
706 function signs_lib.receive_fields(pos, formname, fields, sender, lock)
707 if minetest.is_protected(pos, sender:get_player_name()) then
708 minetest.record_protection_violation(pos,
709 sender:get_player_name())
712 local lockstr = lock and S("locked ") or ""
713 if fields and fields.text and fields.ok then
714 minetest.log("action", S("@1 wrote \"@2\" to @3sign at @4",
715 (sender:get_player_name() or ""),
716 fields.text:gsub('\\', '\\\\'):gsub("\n", "\\n"),
718 minetest.pos_to_string(pos)
721 signs_lib.update_sign(pos, fields, sender:get_player_name())
723 signs_lib.update_sign(pos, fields)
728 minetest.register_node(":"..default_sign, {
729 description = S("Sign"),
730 inventory_image = default_sign_image,
731 wield_image = default_sign_image,
732 node_placement_prediction = "",
733 sunlight_propagates = true,
735 paramtype2 = "wallmounted",
736 drawtype = "nodebox",
737 node_box = signs_lib.regular_wall_sign_model.nodebox,
738 tiles = {"signs_wall_sign.png"},
739 groups = sign_groups,
741 on_place = function(itemstack, placer, pointed_thing)
742 return signs_lib.determine_sign_type(itemstack, placer, pointed_thing)
744 on_construct = function(pos)
745 signs_lib.construct_sign(pos)
747 on_destruct = function(pos)
748 signs_lib.destruct_sign(pos)
750 on_receive_fields = function(pos, formname, fields, sender)
751 signs_lib.receive_fields(pos, formname, fields, sender)
753 on_punch = function(pos, node, puncher)
754 signs_lib.update_sign(pos,nil,nil,node)
756 on_rotate = signs_lib.wallmounted_rotate
759 minetest.register_node(":signs:sign_yard", {
761 sunlight_propagates = true,
762 paramtype2 = "facedir",
763 drawtype = "nodebox",
764 node_box = signs_lib.yard_sign_model.nodebox,
767 fixed = {-0.4375, -0.5, -0.0625, 0.4375, 0.375, 0}
769 tiles = {"signs_top.png", "signs_bottom.png", "signs_side.png", "signs_side.png", "signs_back.png", "signs_front.png"},
770 groups = {choppy=2, dig_immediate=2},
773 on_construct = function(pos)
774 signs_lib.construct_sign(pos)
776 on_destruct = function(pos)
777 signs_lib.destruct_sign(pos)
779 on_receive_fields = function(pos, formname, fields, sender)
780 signs_lib.receive_fields(pos, formname, fields, sender)
782 on_punch = function(pos, node, puncher)
783 signs_lib.update_sign(pos,nil,nil,node)
785 on_rotate = signs_lib.facedir_rotate_simple
789 minetest.register_node(":signs:sign_hanging", {
791 sunlight_propagates = true,
792 paramtype2 = "facedir",
793 drawtype = "nodebox",
794 node_box = signs_lib.hanging_sign_model.nodebox,
797 fixed = {-0.45, -0.275, -0.049, 0.45, 0.5, 0.049}
800 "signs_hanging_top.png",
801 "signs_hanging_bottom.png",
802 "signs_hanging_side.png",
803 "signs_hanging_side.png",
804 "signs_hanging_back.png",
805 "signs_hanging_front.png"
807 groups = {choppy=2, dig_immediate=2},
810 on_construct = function(pos)
811 signs_lib.construct_sign(pos)
813 on_destruct = function(pos)
814 signs_lib.destruct_sign(pos)
816 on_receive_fields = function(pos, formname, fields, sender)
817 signs_lib.receive_fields(pos, formname, fields, sender)
819 on_punch = function(pos, node, puncher)
820 signs_lib.update_sign(pos,nil,nil,node)
822 on_rotate = signs_lib.facedir_rotate_simple
825 minetest.register_node(":signs:sign_post", {
827 sunlight_propagates = true,
828 paramtype2 = "facedir",
829 drawtype = "nodebox",
830 node_box = signs_lib.sign_post_model.nodebox,
832 "signs_post_top.png",
833 "signs_post_bottom.png",
834 "signs_post_side.png",
835 "signs_post_side.png",
836 "signs_post_back.png",
837 "signs_post_front.png",
839 groups = {choppy=2, dig_immediate=2},
843 { items = { default_sign }},
844 { items = { "default:fence_wood" }},
847 on_rotate = signs_lib.facedir_rotate_simple
852 minetest.register_privilege("sign_editor", S("Can edit all locked signs"))
854 minetest.register_node(":locked_sign:sign_wall_locked", {
855 description = S("Locked Sign"),
856 inventory_image = "signs_locked_inv.png",
857 wield_image = "signs_locked_inv.png",
858 node_placement_prediction = "",
859 sunlight_propagates = true,
861 paramtype2 = "wallmounted",
862 drawtype = "nodebox",
863 node_box = signs_lib.regular_wall_sign_model.nodebox,
864 tiles = { "signs_wall_sign_locked.png" },
865 groups = sign_groups,
866 on_place = function(itemstack, placer, pointed_thing)
867 return signs_lib.determine_sign_type(itemstack, placer, pointed_thing, true)
869 on_construct = function(pos)
870 signs_lib.construct_sign(pos, true)
872 on_destruct = function(pos)
873 signs_lib.destruct_sign(pos)
875 on_receive_fields = function(pos, formname, fields, sender)
876 local meta = minetest.get_meta(pos)
877 local owner = meta:get_string("owner")
878 local pname = sender:get_player_name() or ""
879 if pname ~= owner and pname ~= minetest.settings:get("name")
880 and not minetest.check_player_privs(pname, {sign_editor=true}) then
883 signs_lib.receive_fields(pos, formname, fields, sender, true)
885 on_punch = function(pos, node, puncher)
886 signs_lib.update_sign(pos,nil,nil,node)
888 can_dig = function(pos, player)
889 local meta = minetest.get_meta(pos)
890 local owner = meta:get_string("owner")
891 local pname = player:get_player_name()
892 return pname == owner or pname == minetest.settings:get("name")
893 or minetest.check_player_privs(pname, {sign_editor=true})
895 on_rotate = signs_lib.wallmounted_rotate
898 -- default metal sign, if defined
900 if minetest.registered_nodes["default:sign_wall_steel"] then
901 minetest.register_node(":"..default_sign_metal, {
902 description = S("Sign"),
903 inventory_image = default_sign_metal_image,
904 wield_image = default_sign_metal_image,
905 node_placement_prediction = "",
906 sunlight_propagates = true,
908 paramtype2 = "wallmounted",
909 drawtype = "nodebox",
910 node_box = signs_lib.regular_wall_sign_model.nodebox,
911 tiles = {"signs_wall_sign_metal.png"},
912 groups = sign_groups,
914 on_place = function(itemstack, placer, pointed_thing)
915 return signs_lib.determine_sign_type(itemstack, placer, pointed_thing)
917 on_construct = function(pos)
918 signs_lib.construct_sign(pos)
920 on_destruct = function(pos)
921 signs_lib.destruct_sign(pos)
923 on_receive_fields = function(pos, formname, fields, sender)
924 signs_lib.receive_fields(pos, formname, fields, sender)
926 on_punch = function(pos, node, puncher)
927 signs_lib.update_sign(pos,nil,nil,node)
929 on_rotate = signs_lib.wallmounted_rotate
933 -- metal, colored signs
934 if enable_colored_metal_signs then
935 -- array : color, translated color, default text color
936 local sign_colors = {
937 {"green", S("green"), "f"},
938 {"yellow", S("yellow"), "0"},
939 {"red", S("red"), "f"},
940 {"white_red", S("white_red"), "4"},
941 {"white_black", S("white_black"), "0"},
942 {"orange", S("orange"), "0"},
943 {"blue", S("blue"), "f"},
944 {"brown", S("brown"), "f"},
947 for i, color in ipairs(sign_colors) do
948 minetest.register_node(":signs:sign_wall_"..color[1], {
949 description = S("Sign (@1, metal)", color[2]),
950 inventory_image = "signs_"..color[1].."_inv.png",
951 wield_image = "signs_"..color[1].."_inv.png",
952 node_placement_prediction = "",
954 sunlight_propagates = true,
955 paramtype2 = "facedir",
956 drawtype = "nodebox",
957 node_box = signs_lib.metal_wall_sign_model.nodebox,
959 "signs_metal_tb.png",
960 "signs_metal_tb.png",
961 "signs_metal_sides.png",
962 "signs_metal_sides.png",
963 "signs_metal_back.png",
964 "signs_"..color[1].."_front.png"
966 default_color = color[3],
967 groups = sign_groups,
968 on_place = function(itemstack, placer, pointed_thing)
969 return signs_lib.determine_sign_type(itemstack, placer, pointed_thing)
971 on_construct = function(pos)
972 signs_lib.construct_sign(pos)
974 on_destruct = function(pos)
975 signs_lib.destruct_sign(pos)
977 on_receive_fields = function(pos, formname, fields, sender)
978 signs_lib.receive_fields(pos, formname, fields, sender)
980 on_punch = function(pos, node, puncher)
981 signs_lib.update_sign(pos,nil,nil,node)
983 on_rotate = signs_lib.facedir_rotate
988 local signs_text_on_activate
990 signs_text_on_activate = function(self)
991 local pos = self.object:getpos()
992 local meta = minetest.get_meta(pos)
993 local text = meta:get_string("text")
994 local new = (meta:get_int("__signslib_new_format") ~= 0)
995 if text and minetest.registered_nodes[minetest.get_node(pos).name] then
996 text = trim_input(text)
997 set_obj_text(self.object, text, new, pos)
1001 minetest.register_entity(":signs:text", {
1002 collisionbox = { 0, 0, 0, 0, 0, 0 },
1003 visual = "upright_sprite",
1006 on_activate = signs_text_on_activate,
1009 -- And the good stuff here! :-)
1011 function signs_lib.register_fence_with_sign(fencename, fencewithsignname)
1012 local def = minetest.registered_nodes[fencename]
1013 local def_sign = minetest.registered_nodes[fencewithsignname]
1014 if not (def and def_sign) then
1015 minetest.log("warning", "[signs_lib] "..S("Attempt to register unknown node as fence"))
1018 def = signs_lib.table_copy(def)
1019 def_sign = signs_lib.table_copy(def_sign)
1020 fences_with_sign[fencename] = fencewithsignname
1022 def_sign.on_place = function(itemstack, placer, pointed_thing, ...)
1023 local node_above = minetest.get_node_or_nil(pointed_thing.above)
1024 local node_under = minetest.get_node_or_nil(pointed_thing.under)
1025 local def_above = node_above and minetest.registered_nodes[node_above.name]
1026 local def_under = node_under and minetest.registered_nodes[node_under.name]
1027 local fdir = minetest.dir_to_facedir(placer:get_look_dir())
1028 local playername = placer:get_player_name()
1030 if minetest.is_protected(pointed_thing.under, playername) then
1031 minetest.record_protection_violation(pointed_thing.under, playername)
1035 if minetest.is_protected(pointed_thing.above, playername) then
1036 minetest.record_protection_violation(pointed_thing.above, playername)
1040 if def_under and def_under.on_rightclick then
1041 return def_under.on_rightclick(pointed_thing.under, node_under, placer, itemstack, pointed_thing) or itemstack
1042 elseif def_under and def_under.buildable_to then
1043 minetest.add_node(pointed_thing.under, {name = fencename, param2 = fdir})
1044 if not signs_lib.expect_infinite_stacks then
1045 itemstack:take_item()
1047 placer:set_wielded_item(itemstack)
1048 elseif def_above and def_above.buildable_to then
1049 minetest.add_node(pointed_thing.above, {name = fencename, param2 = fdir})
1050 if not signs_lib.expect_infinite_stacks then
1051 itemstack:take_item()
1053 placer:set_wielded_item(itemstack)
1057 def_sign.on_construct = function(pos, ...)
1058 signs_lib.construct_sign(pos)
1060 def_sign.on_destruct = function(pos, ...)
1061 signs_lib.destruct_sign(pos)
1063 def_sign.on_receive_fields = function(pos, formname, fields, sender)
1064 signs_lib.receive_fields(pos, formname, fields, sender)
1066 def_sign.on_punch = function(pos, node, puncher, ...)
1067 signs_lib.update_sign(pos,nil,nil,node)
1069 local fencename = fencename
1070 def_sign.after_dig_node = function(pos, node, ...)
1071 node.name = fencename
1072 minetest.add_node(pos, node)
1074 def_sign.on_rotate = signs_lib.facedir_rotate_simple
1076 def_sign.drop = default_sign
1077 minetest.register_node(":"..fencename, def)
1078 minetest.register_node(":"..fencewithsignname, def_sign)
1079 table.insert(signs_lib.sign_node_list, fencewithsignname)
1080 minetest.log("verbose", S("Registered @1 and @2", fencename, fencewithsignname))
1085 minetest.register_alias("homedecor:fence_wood_with_sign", "signs:sign_post")
1086 minetest.register_alias("sign_wall_locked", "locked_sign:sign_wall_locked")
1088 signs_lib.register_fence_with_sign("default:fence_wood", "signs:sign_post")
1090 -- restore signs' text after /clearobjects and the like, the next time
1091 -- a block is reloaded by the server.
1093 minetest.register_lbm({
1094 nodenames = signs_lib.sign_node_list,
1095 name = "signs_lib:restore_sign_text",
1096 label = "Restore sign text",
1097 run_at_every_load = true,
1098 action = function(pos, node)
1099 signs_lib.update_sign(pos,nil,nil,node)
1105 minetest.register_craft({
1106 output = "locked_sign:sign_wall_locked",
1109 {"basic_materials:padlock"},
1113 -- craft recipes for the metal signs
1114 if enable_colored_metal_signs then
1116 minetest.register_craft( {
1117 output = "signs:sign_wall_green",
1119 { "dye:dark_green", "dye:white", "dye:dark_green" },
1120 { "", default_sign_metal, "" }
1124 minetest.register_craft( {
1125 output = "signs:sign_wall_green 2",
1127 { "dye:dark_green", "dye:white", "dye:dark_green" },
1128 { "steel:sheet_metal", "steel:sheet_metal", "steel:sheet_metal" }
1132 minetest.register_craft( {
1133 output = "signs:sign_wall_yellow",
1135 { "dye:yellow", "dye:black", "dye:yellow" },
1136 { "", default_sign_metal, "" }
1140 minetest.register_craft( {
1141 output = "signs:sign_wall_yellow 2",
1143 { "dye:yellow", "dye:black", "dye:yellow" },
1144 { "steel:sheet_metal", "steel:sheet_metal", "steel:sheet_metal" }
1148 minetest.register_craft( {
1149 output = "signs:sign_wall_red",
1151 { "dye:red", "dye:white", "dye:red" },
1152 { "", default_sign_metal, "" }
1156 minetest.register_craft( {
1157 output = "signs:sign_wall_red 2",
1159 { "dye:red", "dye:white", "dye:red" },
1160 { "steel:sheet_metal", "steel:sheet_metal", "steel:sheet_metal" }
1164 minetest.register_craft( {
1165 output = "signs:sign_wall_white_red",
1167 { "dye:white", "dye:red", "dye:white" },
1168 { "", default_sign_metal, "" }
1172 minetest.register_craft( {
1173 output = "signs:sign_wall_white_red 2",
1175 { "dye:white", "dye:red", "dye:white" },
1176 { "steel:sheet_metal", "steel:sheet_metal", "steel:sheet_metal" }
1180 minetest.register_craft( {
1181 output = "signs:sign_wall_white_black",
1183 { "dye:white", "dye:black", "dye:white" },
1184 { "", default_sign_metal, "" }
1188 minetest.register_craft( {
1189 output = "signs:sign_wall_white_black 2",
1191 { "dye:white", "dye:black", "dye:white" },
1192 { "steel:sheet_metal", "steel:sheet_metal", "steel:sheet_metal" }
1196 minetest.register_craft( {
1197 output = "signs:sign_wall_orange",
1199 { "dye:orange", "dye:black", "dye:orange" },
1200 { "", default_sign_metal, "" }
1204 minetest.register_craft( {
1205 output = "signs:sign_wall_orange 2",
1207 { "dye:orange", "dye:black", "dye:orange" },
1208 { "steel:sheet_metal", "steel:sheet_metal", "steel:sheet_metal" }
1212 minetest.register_craft( {
1213 output = "signs:sign_wall_blue",
1215 { "dye:blue", "dye:white", "dye:blue" },
1216 { "", default_sign_metal, "" }
1220 minetest.register_craft( {
1221 output = "signs:sign_wall_blue 2",
1223 { "dye:blue", "dye:white", "dye:blue" },
1224 { "steel:sheet_metal", "steel:sheet_metal", "steel:sheet_metal" }
1228 minetest.register_craft( {
1229 output = "signs:sign_wall_brown",
1231 { "dye:brown", "dye:white", "dye:brown" },
1232 { "", default_sign_metal, "" }
1236 minetest.register_craft( {
1237 output = "signs:sign_wall_brown 2",
1239 { "dye:brown", "dye:white", "dye:brown" },
1240 { "steel:sheet_metal", "steel:sheet_metal", "steel:sheet_metal" }
1245 if minetest.settings:get("log_mods") then
1246 minetest.log("action", S("[MOD] signs loaded"))