api.lua

   1 -- signs_lib api, backported from street_signs
   2
   3 local S = signs_lib.gettext
   4
   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 = {}
  10
  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
  20
  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
  24
  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
  28
  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)
  31
  32 signs_lib.standard_yaw = {
  33         0,
  34         math.pi / -2,
  35         math.pi,
  36         math.pi / 2,
  37 }
  38
  39 signs_lib.wallmounted_yaw = {
  40         nil,
  41         nil,
  42         math.pi / -2,
  43         math.pi / 2,
  44         0,
  45         math.pi,
  46 }
  47
  48 signs_lib.fdir_to_back = {
  49         {  0, -1 },
  50         { -1,  0 },
  51         {  0,  1 },
  52         {  1,  0 },
  53 }
  54
  55 signs_lib.wall_fdir_to_back = {
  56         nil,
  57         nil,
  58         {  0,  1 },
  59         {  0, -1 },
  60         { -1,  0 },
  61         {  1,  0 },
  62 }
  63
  64 signs_lib.rotate_facedir = {
  65         [0] = 1,
  66         [1] = 6,
  67         [2] = 3,
  68         [3] = 0,
  69         [4] = 2,
  70         [5] = 6,
  71         [6] = 4
  72 }
  73
  74 signs_lib.rotate_walldir = {
  75         [0] = 1,
  76         [1] = 5,
  77         [2] = 0,
  78         [3] = 4,
  79         [4] = 2,
  80         [5] = 3
  81 }
  82
  83 -- Initialize character texture cache
  84 local ctexcache = {}
  85
  86 signs_lib.wallmounted_rotate = function(pos, node, user, mode)
  87         if not signs_lib.can_modify(pos, user) then return false end
  88
  89         if mode ~= screwdriver.ROTATE_FACE or string.match(node.name, "_onpole") then
  90                 return false
  91         end
  92
  93         local newparam2 = signs_lib.rotate_walldir[node.param2] or 0
  94
  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
  99                         v:remove()
 100                 end
 101         end
 102         signs_lib.update_sign(pos)
 103         return true
 104 end
 105
 106 signs_lib.facedir_rotate = function(pos, node, user, mode)
 107         if not signs_lib.can_modify(pos, user) then return false end
 108
 109         if mode ~= screwdriver.ROTATE_FACE or string.match(node.name, "_onpole") then
 110                 return false
 111         end
 112
 113         local newparam2 = signs_lib.rotate_facedir[node.param2] or 0
 114
 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
 119                         v:remove()
 120                 end
 121         end
 122         signs_lib.update_sign(pos)
 123         return true
 124 end
 125
 126 local DEFAULT_TEXT_SCALE = {x=10, y=10}
 127
 128 -- infinite stacks
 129
 130 if not minetest.settings:get_bool("creative_mode") then
 131         signs_lib.expect_infinite_stacks = false
 132 else
 133         signs_lib.expect_infinite_stacks = true
 134 end
 135
 136 -- CONSTANTS
 137
 138 -- Path to the textures.
 139 local TP = signs_lib.path .. "/textures"
 140 -- Font file formatter
 141 local CHAR_FILE = "%s_%02x.png"
 142 -- Fonts path
 143 local CHAR_PATH = TP .. "/" .. CHAR_FILE
 144
 145 -- Lots of overkill here. KISS advocates, go away, shoo! ;) -- kaeza
 146
 147 local PNG_HDR = string.char(0x89, 0x50, 0x4E, 0x47, 0x0D, 0x0A, 0x1A, 0x0A)
 148
 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)
 153         mode = mode or "r";
 154         local f = io.open(name, mode)
 155         if f ~= nil then
 156                 if (return_handle) then
 157                         return f
 158                 end
 159                 io.close(f)
 160                 return true
 161         else
 162                 return false
 163         end
 164 end
 165
 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)
 172         if (not f) then
 173                 return 0, 0
 174         end
 175         f:seek("set", 0x0)
 176         local hdr = f:read(string.len(PNG_HDR))
 177         if hdr ~= PNG_HDR then
 178                 f:close()
 179                 return
 180         end
 181         f:seek("set", 0x13)
 182         local ws = f:read(1)
 183         f:seek("set", 0x17)
 184         local hs = f:read(1)
 185         f:close()
 186         return ws:byte(), hs:byte()
 187 end
 188
 189 -- 4 rows, max 80 chars per, plus a bit of fudge to
 190 -- avoid excess trimming (e.g. due to color codes)
 191
 192 local MAX_INPUT_CHARS = 400
 193
 194 -- helper functions to trim sign text input/output
 195
 196 local function trim_input(text)
 197         return text:sub(1, math.min(MAX_INPUT_CHARS, text:len()))
 198 end
 199
 200 local function build_char_db(font_size)
 201
 202         local cw = {}
 203
 204         -- To calculate average char width.
 205         local total_width = 0
 206         local char_count = 0
 207
 208         for c = 32, 255 do
 209                 local w, h = signs_lib.read_image_size(CHAR_PATH:format("signs_lib_font_"..font_size.."px", c))
 210                 if w and h then
 211                         local ch = string.char(c)
 212                         cw[ch] = w
 213                         total_width = total_width + w
 214                         char_count = char_count + 1
 215                 end
 216         end
 217
 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)
 221 end
 222
 223 signs_lib.charwidth15,
 224 signs_lib.colorbgw15,
 225 signs_lib.lineheight15,
 226 signs_lib.avgwidth15 = build_char_db(15)
 227
 228 signs_lib.charwidth31,
 229 signs_lib.colorbgw31,
 230 signs_lib.lineheight31,
 231 signs_lib.avgwidth31 = build_char_db(31)
 232
 233 local sign_groups = {choppy=2, dig_immediate=2}
 234 local fences_with_sign = { }
 235
 236 -- some local helper functions
 237
 238 local function split_lines_and_words(text)
 239         if not text then return end
 240         local lines = { }
 241         for _, line in ipairs(text:split("\n")) do
 242                 table.insert(lines, line:split(" "))
 243         end
 244         return lines
 245 end
 246
 247 local math_max = math.max
 248
 249 local function fill_line(x, y, w, c, font_size, colorbgw)
 250         c = c or "0"
 251         local tex = { }
 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))
 254         end
 255         return table.concat(tex)
 256 end
 257
 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
 263         else
 264                 local c = ch:byte()
 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)
 268                 else
 269                         tex = CHAR_FILE:format(font_name, 0x0)
 270                 end
 271                 ctexcache[font_name..ch] = tex
 272                 return tex, exists
 273         end
 274 end
 275
 276 local function make_line_texture(line, lineno, pos, line_width, line_height, cwidth_tab, font_size, colorbgw)
 277         local width = 0
 278         local maxw = 0
 279         local font_name = "signs_lib_font_"..font_size.."px"
 280
 281         local words = { }
 282         local node = minetest.get_node(pos)
 283         local def = minetest.registered_items[node.name]
 284         local default_color = def.default_color or 0
 285
 286         local cur_color = tonumber(default_color, 16)
 287
 288         -- We check which chars are available here.
 289         for word_i, word in ipairs(line) do
 290                 local chars = { }
 291                 local ch_offs = 0
 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)
 309                 })
 310                 local word_l = #word
 311                 local i = 1
 312                 while i <= word_l  do
 313                         local c = word:sub(i, i)
 314                         if c == "#" then
 315                                 local cc = tonumber(word:sub(i+1, i+1), 16)
 316                                 if cc then
 317                                         i = i + 1
 318                                         cur_color = cc
 319                                 end
 320                         else
 321                                 local w = cwidth_tab[c]
 322                                 if w then
 323                                         width = width + w + 1
 324                                         if width >= (line_width - cwidth_tab[" "]) then
 325                                                 width = 0
 326                                         else
 327                                                 maxw = math_max(width, maxw)
 328                                         end
 329                                         if #chars < MAX_INPUT_CHARS then
 330                                                 table.insert(chars, {
 331                                                         off = ch_offs,
 332                                                         tex = char_tex(font_name, c),
 333                                                         col = ("%X"):format(cur_color),
 334                                                 })
 335                                         end
 336                                         ch_offs = ch_offs + w
 337                                 end
 338                         end
 339                         i = i + 1
 340                 end
 341                 width = width + cwidth_tab[" "] + 1
 342                 maxw = math_max(width, maxw)
 343                 table.insert(words, { chars=chars, w=ch_offs })
 344         end
 345
 346         -- Okay, we actually build the "line texture" here.
 347
 348         local texture = { }
 349
 350         local start_xpos = math.floor((line_width - maxw) / 2) + def.x_offset
 351
 352         local xpos = start_xpos
 353         local ypos = (line_height + def.line_spacing)* lineno + def.y_offset
 354
 355         cur_color = nil
 356
 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))
 361                         xpos = start_xpos
 362                         ypos = ypos + line_height + def.line_spacing
 363                         lineno = lineno + 1
 364                         if lineno >= def.number_of_lines then break end
 365                         table.insert(texture, fill_line(xpos, ypos, maxw, cur_color, font_size, colorbgw))
 366                 end
 367                 for ch_i, ch in ipairs(word.chars) do
 368                         if ch.col ~= cur_color then
 369                                 cur_color = ch.col
 370                                 table.insert(texture, fill_line(xpos + ch.off, ypos, maxw, cur_color, font_size, colorbgw))
 371                         end
 372                         table.insert(texture, (":%d,%d=%s"):format(xpos + ch.off, ypos, ch.tex))
 373                 end
 374                 table.insert(
 375                         texture,
 376                         (":%d,%d="):format(xpos + word.w, ypos) .. char_tex(font_name, " ")
 377                 )
 378                 xpos = xpos + word.w + cwidth_tab[" "]
 379                 if xpos >= (line_width + cwidth_tab[" "]) then break end
 380         end
 381
 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))
 384
 385         return table.concat(texture), lineno
 386 end
 387
 388 local function make_sign_texture(lines, pos)
 389         local node = minetest.get_node(pos)
 390         local def = minetest.registered_items[node.name]
 391
 392         local font_size
 393         local line_width
 394         local line_height
 395         local char_width
 396         local colorbgw
 397
 398         if def.font_size and def.font_size == 31 then
 399                 font_size = 31
 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
 404         else
 405                 font_size = 15
 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
 410         end
 411
 412         local texture = { ("[combine:%dx%d"):format(line_width, (line_height + def.line_spacing) * def.number_of_lines * def.vert_scaling) }
 413
 414         local lineno = 0
 415         for i = 1, #lines do
 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)
 419                 lineno = ln + 1
 420         end
 421         table.insert(texture, "^[makealpha:0,0,0")
 422         return table.concat(texture, "")
 423 end
 424
 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)
 431         obj:set_properties({
 432                 textures={texture},
 433                 visual_size = text_scale,
 434         })
 435 end
 436
 437 signs_lib.construct_sign = function(pos)
 438         local meta = minetest.get_meta(pos)
 439         meta:set_string(
 440                 "formspec",
 441                 "size[6,4]"..
 442                 "textarea[0,-0.3;6.5,3;text;;${text}]"..
 443                 "button_exit[2,3.4;2,1;ok;"..S("Write").."]"..
 444                 "background[-0.5,-0.5;7,5;signs_lib_sign_bg.jpg]")
 445         local i = meta:get_string("infotext")
 446         if i == "" then -- it wasn't even set, so set it.
 447                 meta:set_string("infotext", "")
 448         end
 449 end
 450
 451 function signs_lib.destruct_sign(pos)
 452         local objects = minetest.get_objects_inside_radius(pos, 0.5)
 453         for _, v in ipairs(objects) do
 454                 local e = v:get_luaentity()
 455                 if e and e.name == "signs_lib:text" then
 456                         v:remove()
 457                 end
 458         end
 459 end
 460
 461 local function make_infotext(text)
 462         text = trim_input(text)
 463         local lines = split_lines_and_words(text) or {}
 464         local lines2 = { }
 465         for _, line in ipairs(lines) do
 466                 table.insert(lines2, (table.concat(line, " "):gsub("#[0-9a-fA-F]", ""):gsub("##", "#")))
 467         end
 468         return table.concat(lines2, "\n")
 469 end
 470
 471 function signs_lib.update_sign(pos, fields)
 472         local meta = minetest.get_meta(pos)
 473
 474         local text = fields and fields.text or meta:get_string("text")
 475         text = trim_input(text)
 476
 477         local owner = meta:get_string("owner")
 478         ownstr = ""
 479         if owner ~= "" then ownstr = S("Locked sign, owned by @1\n", owner) end
 480
 481         meta:set_string("text", text)
 482         meta:set_string("infotext", ownstr..make_infotext(text).." ")
 483
 484         local objects = minetest.get_objects_inside_radius(pos, 0.5)
 485         local found
 486         for _, v in ipairs(objects) do
 487                 local e = v:get_luaentity()
 488                 if e and e.name == "signs_lib:text" then
 489                         if found then
 490                                 v:remove()
 491                         else
 492                                 set_obj_text(v, text, nil, pos)
 493                                 found = true
 494                         end
 495                 end
 496         end
 497         if found then
 498                 return
 499         end
 500
 501         -- if there is no entity
 502         local signnode = minetest.get_node(pos)
 503         local signname = signnode.name
 504         local def = minetest.registered_items[signname]
 505         if not def.entity_info or not def.entity_info.yaw[signnode.param2 + 1] then return end
 506         local obj = minetest.add_entity(pos, "signs_lib:text")
 507
 508         obj:setyaw(def.entity_info.yaw[signnode.param2 + 1])
 509         obj:set_properties({
 510                 mesh = def.entity_info.mesh,
 511         })
 512 end
 513
 514 function signs_lib.receive_fields(pos, formname, fields, sender)
 515         if fields and fields.text and fields.ok and signs_lib.can_modify(pos, sender) then
 516                 minetest.log("action", S("@1 wrote \"@2\" to sign at @3",
 517                         (sender:get_player_name() or ""),
 518                         fields.text:gsub('\\', '\\\\'):gsub("\n", "\\n"),
 519                         minetest.pos_to_string(pos)
 520                 ))
 521                 signs_lib.update_sign(pos, fields)
 522         end
 523 end
 524
 525 function signs_lib.can_modify(pos, player)
 526         local meta = minetest.get_meta(pos)
 527         local owner = meta:get_string("owner")
 528         local playername = player:get_player_name()
 529
 530         if minetest.is_protected(pos, playername) then
 531                 minetest.record_protection_violation(pos, playername)
 532                 return false
 533         end
 534
 535         if owner == ""
 536           or playername == owner
 537           or (minetest.check_player_privs(playername, {sign_editor=true}))
 538           or (playername == minetest.settings:get("name")) then
 539                 return true
 540         end
 541         minetest.record_protection_violation(pos, playername)
 542         return false
 543 end
 544
 545 local signs_text_on_activate = function(self)
 546         local pos = self.object:getpos()
 547         local meta = minetest.get_meta(pos)
 548         local signnode = minetest.get_node(pos)
 549         local signname = signnode.name
 550         local def = minetest.registered_items[signname]
 551         local text = meta:get_string("text")
 552         if text and def and def.entity_info then
 553                 text = trim_input(text)
 554                 set_obj_text(self.object, text, nil, pos)
 555                 self.object:set_properties({
 556                         mesh = def.entity_info.mesh,
 557                 })
 558         end
 559 end
 560
 561 minetest.register_entity("signs_lib:text", {
 562         collisionbox = { 0, 0, 0, 0, 0, 0 },
 563         visual = "mesh",
 564         mesh = "signs_lib_standard_wall_sign_entity.obj",
 565         textures = {},
 566         on_activate = signs_text_on_activate,
 567 })
 568
 569 -- make selection boxes
 570 -- sizex/sizey specified in inches because that's what MUTCD uses.
 571
 572 function signs_lib.make_selection_boxes(sizex, sizey, foo, xoffs, yoffs, zoffs, is_facedir)
 573
 574         local tx = (sizex * 0.0254 ) / 2
 575         local ty = (sizey * 0.0254 ) / 2
 576         local xo = xoffs and xoffs * 0.0254 or 0
 577         local yo = yoffs and yoffs * 0.0254 or 0
 578         local zo = zoffs and zoffs * 0.0254 or 0
 579
 580         if not is_facedir then
 581                 return {
 582                         type = "wallmounted",
 583                         wall_side =   { -0.5 + zo, -ty + yo, -tx + xo, -0.4375 + zo, ty + yo, tx + xo },
 584                         wall_top =    { -tx - xo, 0.5 + zo, -ty + yo, tx - xo, 0.4375 + zo, ty + yo},
 585                         wall_bottom = { -tx - xo, -0.5 + zo, -ty + yo, tx - xo, -0.4375 + zo, ty + yo }
 586                 }
 587         else
 588                 return {
 589                         type = "fixed",
 590                         fixed = { -tx + xo, -ty + yo, 0.5 + zo, tx + xo, ty + yo, 0.4375 + zo}
 591                 }
 592         end
 593 end
 594
 595 function signs_lib.check_for_pole(pos, pointed_thing)
 596         local ppos = minetest.get_pointed_thing_position(pointed_thing)
 597         local pnode = minetest.get_node(ppos)
 598         local pdef = minetest.registered_items[pnode.name]
 599
 600         if (signs_lib.allowed_poles[pnode.name]
 601                   or (pdef and pdef.drawtype == "fencelike")
 602                   or string.find(pnode.name, "default:fence_")
 603                   or string.find(pnode.name, "_post")
 604                   or string.find(pnode.name, "fencepost")
 605                   or (pnode.name == "streets:bigpole" and pnode.param2 < 4)
 606                   or (pnode.name == "streets:bigpole" and pnode.param2 > 19 and pnode.param2 < 24)
 607                 )
 608           and
 609                 (pos.x ~= ppos.x or pos.z ~= ppos.z) then
 610                 return true
 611         end
 612 end
 613
 614 function signs_lib.check_for_ceiling(pointed_thing)
 615         if pointed_thing.above.x == pointed_thing.under.x
 616           and pointed_thing.above.z == pointed_thing.under.z
 617           and pointed_thing.above.y < pointed_thing.under.y then
 618                 return true
 619         end
 620 end
 621
 622 function signs_lib.after_place_node(pos, placer, itemstack, pointed_thing, locked)
 623         local playername = placer:get_player_name()
 624         local def = minetest.registered_items[itemstack:get_name()]
 625
 626         local ppos = minetest.get_pointed_thing_position(pointed_thing)
 627         local pnode = minetest.get_node(ppos)
 628         local pdef = minetest.registered_items[pnode.name]
 629
 630         if (def.allow_onpole ~= false) and signs_lib.check_for_pole(pos, pointed_thing) then
 631                 local node = minetest.get_node(pos)
 632                 minetest.swap_node(pos, {name = itemstack:get_name().."_onpole", param2 = node.param2})
 633         elseif def.allow_hanging and signs_lib.check_for_ceiling(pointed_thing) then
 634                 local newparam2 = minetest.dir_to_facedir(placer:get_look_dir())
 635                 local node = minetest.get_node(pos)
 636                 minetest.swap_node(pos, {name = itemstack:get_name().."_hanging", param2 = newparam2})
 637         end
 638         if locked then
 639                 local meta = minetest.get_meta(pos)
 640                 meta:set_string("owner", playername)
 641                 meta:set_string("infotext", S("Locked sign, owned by @1\n", playername))
 642         end
 643 end
 644
 645 function signs_lib.register_fence_with_sign()
 646         minetest.log("warning", "[signs_lib] ".."Attempt to call no longer used function signs_lib.register_fence_with_sign()")
 647 end
 648
 649 --[[
 650 The main sign registration function
 651 ===================================
 652
 653 Example minimal recommended def for writable signs:
 654
 655 signs_lib.register_sign("foo:my_cool_sign", {
 656         description = "Wooden cool sign",
 657         inventory_image = "signs_lib_sign_cool_inv.png",
 658         tiles = {
 659                 "signs_lib_sign_cool.png",
 660                 "signs_lib_sign_cool_edges.png"
 661         },
 662         number_of_lines = 2,
 663         horiz_scaling = 0.8,
 664         vert_scaling = 1,
 665         line_spacing = 9,
 666         font_size = 31,
 667         x_offset = 7,
 668         y_offset = 4,
 669         chars_per_line = 40,
 670         entity_info = "standard"
 671 })
 672
 673 * default def assumes a wallmounted sign with on-pole being allowed.
 674
 675 *For signs that can't support onpole, include in the def:
 676         allow_onpole = false,
 677
 678 * "standard" entity info implies the standard wood/steel sign model, in
 679   wallmounted mode.  For facedir signs using the standard model, use:
 680
 681         entity_info = {
 682                 mesh = "signs_lib_standard_wall_sign_entity.obj",
 683                 yaw = signs_lib.standard_yaw
 684         },
 685
 686 ]]--
 687
 688 function signs_lib.register_sign(name, rdef)
 689
 690         local def = table.copy(rdef)
 691
 692         if rdef.entity_info == "standard" then
 693                 def.entity_info = {
 694                         mesh = "signs_lib_standard_wall_sign_entity.obj",
 695                         yaw = signs_lib.wallmounted_yaw
 696                 }
 697         elseif rdef.entity_info then
 698                 def.entity_info = rdef.entity_info
 699         end
 700
 701         if rdef.entity_info then
 702                 def.on_rightclick       = rdef.on_rightclick       or signs_lib.construct_sign
 703                 def.on_construct        = rdef.on_construct        or signs_lib.construct_sign
 704                 def.on_destruct         = rdef.on_destruct         or signs_lib.destruct_sign
 705                 def.on_receive_fields   = rdef.on_receive_fields   or signs_lib.receive_fields
 706                 def.on_punch            = rdef.on_punch            or signs_lib.update_sign
 707                 def.number_of_lines     = rdef.number_of_lines     or signs_lib.standard_lines
 708                 def.horiz_scaling       = rdef.horiz_scaling       or signs_lib.standard_hscale
 709                 def.vert_scaling        = rdef.vert_scaling        or signs_lib.standard_vscale
 710                 def.line_spacing        = rdef.line_spacing        or signs_lib.standard_lspace
 711                 def.font_size           = rdef.font_size           or signs_lib.standard_fsize
 712                 def.x_offset            = rdef.x_offset            or signs_lib.standard_xoffs
 713                 def.y_offset            = rdef.y_offset            or signs_lib.standard_yoffs
 714                 def.chars_per_line      = rdef.chars_per_line      or signs_lib.standard_cpl
 715                 def.default_color       = rdef.default_color       or "0"
 716                 if rdef.locked and not rdef.after_place_node then
 717                         def.after_place_node = function(pos, placer, itemstack, pointed_thing)
 718                                 signs_lib.after_place_node(pos, placer, itemstack, pointed_thing, true)
 719                         end
 720                 else
 721                         def.after_place_node = rdef.after_place_node or signs_lib.after_place_node
 722                 end
 723         end
 724
 725         def.paramtype           = rdef.paramtype           or "light"
 726         def.drawtype            = rdef.drawtype            or "mesh"
 727         def.mesh                = rdef.mesh                or "signs_lib_standard_wall_sign.obj"
 728         def.wield_image         = rdef.wield_image         or def.inventory_image
 729         def.drop                = rdef.drop                or name
 730         def.sounds              = rdef.sounds              or signs_lib.standard_wood_sign_sounds
 731         def.on_rotate           = rdef.on_rotate           or signs_lib.wallmounted_rotate
 732         def.paramtype2          = rdef.paramtype2          or "wallmounted"
 733
 734         if rdef.on_rotate then
 735                 def.on_rotate = rdef.on_rotate
 736         elseif rdef.drawtype == "wallmounted" then
 737                 def.on_rotate = signs_lib.wallmounted_rotate
 738         else
 739                 def.on_rotate = signs_lib.facedir_rotate
 740         end
 741
 742         if rdef.groups then
 743                 def.groups = rdef.groups
 744         else
 745                 def.groups = signs_lib.standard_wood_groups
 746         end
 747
 748         local cbox = signs_lib.make_selection_boxes(35, 25, allow_onpole)
 749
 750         def.selection_box = rdef.selection_box or cbox
 751         def.node_box      = table.copy(rdef.node_box or rdef.selection_box or cbox)
 752
 753         if def.sunlight_propagates ~= false then
 754                 def.sunlight_propagates = true
 755         end
 756
 757         minetest.register_node(":"..name, def)
 758         table.insert(signs_lib.lbm_restore_nodes, name)
 759
 760         if rdef.allow_onpole ~= false then
 761
 762                 local opdef = table.copy(def)
 763
 764                 local offset = 0.3125
 765                 if opdef.uses_slim_pole_mount then
 766                         offset = 0.35
 767                 end
 768
 769                 if opdef.paramtype2 == "wallmounted" then
 770                         opdef.node_box.wall_side[1] = def.node_box.wall_side[1] - offset
 771                         opdef.node_box.wall_side[4] = def.node_box.wall_side[4] - offset
 772
 773                         opdef.selection_box.wall_side[1] = def.selection_box.wall_side[1] - offset
 774                         opdef.selection_box.wall_side[4] = def.selection_box.wall_side[4] - offset
 775                 else
 776                         opdef.node_box.fixed[3] = def.node_box.fixed[3] + offset
 777                         opdef.node_box.fixed[6] = def.node_box.fixed[6] + offset
 778
 779                         opdef.selection_box.fixed[3] = def.selection_box.fixed[3] + offset
 780                         opdef.selection_box.fixed[6] = def.selection_box.fixed[6] + offset
 781                 end
 782
 783                 opdef.groups.not_in_creative_inventory = 1
 784                 opdef.tiles[3] = "signs_lib_pole_mount.png"
 785                 opdef.mesh = string.gsub(opdef.mesh, ".obj$", "_onpole.obj")
 786                 opdef.on_rotate = nil
 787
 788
 789                 if opdef.entity_info then
 790                         opdef.entity_info.mesh = string.gsub(opdef.entity_info.mesh, ".obj$", "_onpole.obj")
 791                 end
 792                 minetest.register_node(":"..name.."_onpole", opdef)
 793                 table.insert(signs_lib.lbm_restore_nodes, name.."_onpole")
 794         end
 795
 796         if rdef.allow_hanging then
 797
 798                 local hdef = table.copy(def)
 799                 hdef.paramtype2 = "facedir"
 800
 801                 hdef.selection_box = rdef.selection_box or signs_lib.make_selection_boxes(35, 32, false, 0, 3, -18.5, true)
 802                 hdef.node_box = rdef.node_box or rdef.selection_box or hdef.selection_box
 803
 804                 hdef.groups.not_in_creative_inventory = 1
 805                 hdef.tiles[3] = "signs_lib_hangers.png"
 806                 hdef.mesh = string.gsub(hdef.mesh, ".obj$", "_hanging.obj")
 807                 hdef.on_rotate = nil
 808
 809                 if hdef.entity_info then
 810                         hdef.entity_info.mesh = string.gsub(hdef.entity_info.mesh, ".obj$", "_hanging.obj")
 811                         hdef.entity_info.yaw = signs_lib.standard_yaw
 812                 end
 813
 814                 minetest.register_node(":"..name.."_hanging", hdef)
 815                 table.insert(signs_lib.lbm_restore_nodes, name.."_hanging")
 816         end
 817
 818 end
 819
 820 -- restore signs' text after /clearobjects and the like, the next time
 821 -- a block is reloaded by the server.
 822
 823 minetest.register_lbm({
 824         nodenames = signs_lib.lbm_restore_nodes,
 825         name = "signs_lib:restore_sign_text",
 826         label = "Restore sign text",
 827         run_at_every_load = true,
 828         action = function(pos, node)
 829                 signs_lib.update_sign(pos,nil,nil,node)
 830         end
 831 })
 832
 833 -- Convert old signs on fenceposts into signs on.. um.. fence posts :P
 834
 835 minetest.register_lbm({
 836         nodenames = signs_lib.old_fenceposts_with_signs,
 837         name = "signs_lib:fix_fencepost_signs",
 838         label = "Change single-node signs on fences into normal",
 839         run_at_every_load = true,
 840         action = function(pos, node)
 841
 842                 local fdir = node.param2 % 8
 843                 local signpos = {
 844                         x = pos.x + signs_lib.fdir_to_back[fdir+1][1],
 845                         y = pos.y,
 846                         z = pos.z + signs_lib.fdir_to_back[fdir+1][2]
 847                 }
 848
 849                 if minetest.get_node(signpos).name == "air" then
 850                         local new_wmdir = minetest.dir_to_wallmounted(minetest.facedir_to_dir(fdir))
 851                         local oldfence =  signs_lib.old_fenceposts[node.name]
 852                         local newsign =   signs_lib.old_fenceposts_replacement_signs[node.name]
 853
 854                         for _, v in ipairs(minetest.get_objects_inside_radius(pos, 0.5)) do
 855                                 local e = v:get_luaentity()
 856                                 if e and e.name == "signs_lib:text" then
 857                                         v:remove()
 858                                 end
 859                         end
 860
 861                         local oldmeta = minetest.get_meta(pos):to_table()
 862                         minetest.set_node(pos, {name = oldfence})
 863                         minetest.set_node(signpos, { name = newsign, param2 = new_wmdir })
 864                         local newmeta = minetest.get_meta(signpos)
 865                         newmeta:from_table(oldmeta)
 866                         signs_lib.update_sign(signpos)
 867                 end
 868         end
 869 })
 870
 871 signs_lib.block_list = {}
 872 signs_lib.totalblocks = 0
 873
 874 -- Maintain a list of currently-loaded blocks
 875 minetest.register_lbm({
 876         nodenames = {"group:sign"},
 877         name = "signs_lib:update_block_list",
 878         label = "Update list of loaded blocks, log only those with signs",
 879         run_at_every_load = true,
 880         action = function(pos, node)
 881                 -- yeah, yeah... I know I'm hashing a block pos, but it's still just a set of coords
 882                 local hash = minetest.hash_node_position(vector.floor(vector.divide(pos, core.MAP_BLOCKSIZE)))
 883                 if not signs_lib.block_list[hash] then
 884                         signs_lib.block_list[hash] = true
 885                         signs_lib.totalblocks = signs_lib.totalblocks + 1
 886                 end
 887         end
 888 })
 889
 890 minetest.register_chatcommand("regen_signs", {
 891         params = "",
 892         privs = {server = true},
 893         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.",
 894         func = function(player_name, params)
 895                 local allsigns = {}
 896                 local totalsigns = 0
 897                 for b in pairs(signs_lib.block_list) do
 898                         local blockpos = minetest.get_position_from_hash(b)
 899                         local pos1 = vector.multiply(blockpos, core.MAP_BLOCKSIZE)
 900                         local pos2 = vector.add(pos1, core.MAP_BLOCKSIZE - 1)
 901                         if minetest.get_node_or_nil(vector.add(pos1, core.MAP_BLOCKSIZE/2)) then
 902                                 local signs_in_block = minetest.find_nodes_in_area(pos1, pos2, {"group:sign"})
 903                                 allsigns[#allsigns + 1] = signs_in_block
 904                                 totalsigns = totalsigns + #signs_in_block
 905                         else
 906                                 signs_lib.block_list[b] = nil -- if the block is no longer loaded, remove it from the table
 907                                 signs_lib.totalblocks = signs_lib.totalblocks - 1
 908                         end
 909                 end
 910                 if signs_lib.totalblocks < 0 then signs_lib.totalblocks = 0 end
 911                 if totalsigns == 0 then
 912                         minetest.chat_send_player(player_name, "There are no signs in the currently-loaded terrain.")
 913                         signs_lib.block_list = {}
 914                         return
 915                 end
 916
 917                 minetest.chat_send_player(player_name, "Found a total of "..totalsigns.." sign nodes across "..signs_lib.totalblocks.." blocks.")
 918                 minetest.chat_send_player(player_name, "Regenerating sign entities...")
 919
 920                 for _, b in pairs(allsigns) do
 921                         for _, pos in ipairs(b) do
 922                                 local objects = minetest.get_objects_inside_radius(pos, 0.5)
 923                                 if #objects > 0 then
 924                                         for _, v in ipairs(objects) do
 925                                                 v:remove()
 926                                         end
 927                                 end
 928                                 local node = minetest.get_node(pos)
 929                                 local def = minetest.registered_items[node.name]
 930                                 if def and def.entity_info then
 931                                         signs_lib.update_sign(pos)
 932                                 end
 933                         end
 934                 end
 935                 minetest.chat_send_player(player_name, "Finished.")
 936         end
 937 })