]> git.lizzy.rs Git - signs_lib.git/blobdiff - api.lua
Allow mod to specify custom selbox for on-pole variants
[signs_lib.git] / api.lua
diff --git a/api.lua b/api.lua
index 80e545b6d243af42901c942d311f2d2685913bc5..0d8263bcf9fbfcee7b940761049080beb1d9747b 100644 (file)
--- a/api.lua
+++ b/api.lua
@@ -10,16 +10,24 @@ signs_lib.allowed_poles = {}
 
 -- Settings used for a standard wood or steel wall sign
 signs_lib.standard_lines = 6
-signs_lib.standard_hscale = 1.7
-signs_lib.standard_vscale = 1.75
+signs_lib.standard_hscale = 1
+signs_lib.standard_vscale = 1
 signs_lib.standard_lspace = 1
 signs_lib.standard_fsize = 15
-signs_lib.standard_xoffs = 5
-signs_lib.standard_yoffs = 38
-signs_lib.standard_cpl = 25
+signs_lib.standard_xoffs = 4
+signs_lib.standard_yoffs = 0
+signs_lib.standard_cpl = 35
 
-signs_lib.standard_wood_groups =  {choppy = 2, flammable = 2, oddly_breakable_by_hand = 3}
-signs_lib.standard_steel_groups = {cracky = 2, oddly_breakable_by_hand = 3} 
+signs_lib.standard_wood_groups = table.copy(minetest.registered_items["default:sign_wall_wood"].groups)
+signs_lib.standard_wood_groups.sign = 1
+signs_lib.standard_wood_groups.attached_node = nil
+
+signs_lib.standard_steel_groups = table.copy(minetest.registered_items["default:sign_wall_steel"].groups)
+signs_lib.standard_steel_groups.sign = 1
+signs_lib.standard_steel_groups.attached_node = nil
+
+signs_lib.standard_wood_sign_sounds  = table.copy(minetest.registered_items["default:sign_wall_wood"].sounds)
+signs_lib.standard_steel_sign_sounds = table.copy(minetest.registered_items["default:sign_wall_steel"].sounds)
 
 signs_lib.standard_yaw = {
        0,
@@ -37,15 +45,6 @@ signs_lib.wallmounted_yaw = {
        math.pi,
 }
 
-local wall_dir_change = {
-       [0] = 2,
-       2,
-       5,
-       4,
-       2,
-       3,
-}
-
 signs_lib.fdir_to_back = {
        {  0, -1 },
        { -1,  0 },
@@ -62,12 +61,38 @@ signs_lib.wall_fdir_to_back = {
        {  1,  0 },
 }
 
+signs_lib.rotate_facedir = {
+       [0] = 1,
+       [1] = 6,
+       [2] = 3,
+       [3] = 0,
+       [4] = 2,
+       [5] = 6,
+       [6] = 4
+}
+
+signs_lib.rotate_walldir = {
+       [0] = 1,
+       [1] = 5,
+       [2] = 0,
+       [3] = 4,
+       [4] = 2,
+       [5] = 3
+}
+
 -- Initialize character texture cache
 local ctexcache = {}
 
 signs_lib.wallmounted_rotate = function(pos, node, user, mode)
-       if mode ~= screwdriver.ROTATE_FACE then return false end
-       minetest.swap_node(pos, { name = node.name, param2 = wall_dir_change[node.param2 % 6] })
+       if not signs_lib.can_modify(pos, user) then return false end
+
+       if mode ~= screwdriver.ROTATE_FACE or string.match(node.name, "_onpole") then
+               return false
+       end
+
+       local newparam2 = signs_lib.rotate_walldir[node.param2] or 0
+
+       minetest.swap_node(pos, { name = node.name, param2 = newparam2 })
        for _, v in ipairs(minetest.get_objects_inside_radius(pos, 0.5)) do
                local e = v:get_luaentity()
                if e and e.name == "signs_lib:text" then
@@ -79,8 +104,14 @@ signs_lib.wallmounted_rotate = function(pos, node, user, mode)
 end
 
 signs_lib.facedir_rotate = function(pos, node, user, mode)
-       if mode ~= screwdriver.ROTATE_FACE or not signs_lib.can_modify(pos, user) then return end
-       newparam2 = ((node.param2 % 6 ) == 0) and 1 or 0
+       if not signs_lib.can_modify(pos, user) then return false end
+
+       if mode ~= screwdriver.ROTATE_FACE or string.match(node.name, "_onpole") then
+               return false
+       end
+
+       local newparam2 = signs_lib.rotate_facedir[node.param2] or 0
+
        minetest.swap_node(pos, { name = node.name, param2 = newparam2 })
        for _, v in ipairs(minetest.get_objects_inside_radius(pos, 0.5)) do
                local e = v:get_luaentity()
@@ -411,7 +442,10 @@ signs_lib.construct_sign = function(pos)
                "textarea[0,-0.3;6.5,3;text;;${text}]"..
                "button_exit[2,3.4;2,1;ok;"..S("Write").."]"..
                "background[-0.5,-0.5;7,5;signs_lib_sign_bg.jpg]")
-       meta:set_string("infotext", "")
+       local i = meta:get_string("infotext")
+       if i == "" then -- it wasn't even set, so set it.
+               meta:set_string("infotext", "")
+       end
 end
 
 function signs_lib.destruct_sign(pos)
@@ -527,7 +561,7 @@ end
 minetest.register_entity("signs_lib:text", {
        collisionbox = { 0, 0, 0, 0, 0, 0 },
        visual = "mesh",
-       mesh = "signs_lib_basic_entity.obj",
+       mesh = "signs_lib_standard_wall_sign_entity.obj",
        textures = {},
        on_activate = signs_text_on_activate,
 })
@@ -535,7 +569,7 @@ minetest.register_entity("signs_lib:text", {
 -- make selection boxes
 -- sizex/sizey specified in inches because that's what MUTCD uses.
 
-function signs_lib.make_selection_boxes(sizex, sizey, onpole, xoffs, yoffs, zoffs, fdir)
+function signs_lib.make_selection_boxes(sizex, sizey, foo, xoffs, yoffs, zoffs, is_facedir)
 
        local tx = (sizex * 0.0254 ) / 2
        local ty = (sizey * 0.0254 ) / 2
@@ -543,34 +577,18 @@ function signs_lib.make_selection_boxes(sizex, sizey, onpole, xoffs, yoffs, zoff
        local yo = yoffs and yoffs * 0.0254 or 0
        local zo = zoffs and zoffs * 0.0254 or 0
 
-       if onpole == "_onpole" then
-               if not fdir then
-                       return {
-                               type = "wallmounted",
-                               wall_side =   { -0.5 - 0.3125 + zo, -ty + yo, -tx + xo, -0.4375 - 0.3125 + zo, ty + yo , tx + xo },
-                               wall_top =    {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5 },
-                               wall_bottom = {-0.5, -0.5, -0.5, 0.5, 0.5, 0.5 },
-                       }
-               else
-                       return {
-                               type = "fixed",
-                               fixed = { -tx + xo, -ty + yo, 0.5 + 0.3125 + zo, tx + xo, ty + yo, 0.4375 + 0.3125 + zo }
-                       }
-               end
+       if not is_facedir then
+               return {
+                       type = "wallmounted",
+                       wall_side =   { -0.5 + zo, -ty + yo, -tx + xo, -0.4375 + zo, ty + yo, tx + xo },
+                       wall_top =    { -tx - xo, 0.5 + zo, -ty + yo, tx - xo, 0.4375 + zo, ty + yo},
+                       wall_bottom = { -tx - xo, -0.5 + zo, -ty + yo, tx - xo, -0.4375 + zo, ty + yo }
+               }
        else
-               if not fdir then
-                       return {
-                               type = "wallmounted",
-                               wall_side =   { -0.5, -ty, -tx, -0.4375, ty, tx },
-                               wall_top =    { -tx - xo, 0.5 + zo, -ty + yo, tx - xo, 0.4375 + zo, ty + yo},
-                               wall_bottom = { -tx - xo, -0.5 + zo, -ty + yo, tx - xo, -0.4375 + zo, ty + yo }
-                       }
-               else
-                       return {
-                               type = "fixed",
-                               fixed = { -tx + xo, -ty + yo, 0.5 + zo, tx + xo, ty + yo, 0.4375 + zo}
-                       }
-               end
+               return {
+                       type = "fixed",
+                       fixed = { -tx + xo, -ty + yo, 0.5 + zo, tx + xo, ty + yo, 0.4375 + zo}
+               }
        end
 end
 
@@ -579,26 +597,43 @@ function signs_lib.check_for_pole(pos, pointed_thing)
        local pnode = minetest.get_node(ppos)
        local pdef = minetest.registered_items[pnode.name]
 
-       if signs_lib.allowed_poles[pnode.name]
+       if (signs_lib.allowed_poles[pnode.name]
                  or (pdef and pdef.drawtype == "fencelike")
                  or string.find(pnode.name, "default:fence_")
                  or string.find(pnode.name, "_post")
                  or string.find(pnode.name, "fencepost")
                  or (pnode.name == "streets:bigpole" and pnode.param2 < 4)
-                 or (pnode.name == "streets:bigpole" and pnode.param2 > 19 and pnode.param2 < 24) then
+                 or (pnode.name == "streets:bigpole" and pnode.param2 > 19 and pnode.param2 < 24)
+               )
+         and
+               (pos.x ~= ppos.x or pos.z ~= ppos.z) then
+               return true
+       end
+end
+
+function signs_lib.check_for_ceiling(pointed_thing)
+       if pointed_thing.above.x == pointed_thing.under.x
+         and pointed_thing.above.z == pointed_thing.under.z
+         and pointed_thing.above.y < pointed_thing.under.y then
                return true
        end
 end
 
 function signs_lib.after_place_node(pos, placer, itemstack, pointed_thing, locked)
+       local playername = placer:get_player_name()
+       local def = minetest.registered_items[itemstack:get_name()]
+
        local ppos = minetest.get_pointed_thing_position(pointed_thing)
        local pnode = minetest.get_node(ppos)
        local pdef = minetest.registered_items[pnode.name]
-       local playername = placer:get_player_name()
 
-       if signs_lib.check_for_pole(pos, pointed_thing) then
+       if (def.allow_onpole ~= false) and signs_lib.check_for_pole(pos, pointed_thing) then
                local node = minetest.get_node(pos)
                minetest.swap_node(pos, {name = itemstack:get_name().."_onpole", param2 = node.param2})
+       elseif def.allow_hanging and signs_lib.check_for_ceiling(pointed_thing) then
+               local newparam2 = minetest.dir_to_facedir(placer:get_look_dir())
+               local node = minetest.get_node(pos)
+               minetest.swap_node(pos, {name = itemstack:get_name().."_hanging", param2 = newparam2})
        end
        if locked then
                local meta = minetest.get_meta(pos)
@@ -611,6 +646,182 @@ function signs_lib.register_fence_with_sign()
        minetest.log("warning", "[signs_lib] ".."Attempt to call no longer used function signs_lib.register_fence_with_sign()")
 end
 
+--[[
+The main sign registration function
+===================================
+
+Example minimal recommended def for writable signs:
+
+signs_lib.register_sign("foo:my_cool_sign", {
+       description = "Wooden cool sign",
+       inventory_image = "signs_lib_sign_cool_inv.png",
+       tiles = {
+               "signs_lib_sign_cool.png",
+               "signs_lib_sign_cool_edges.png"
+       },
+       number_of_lines = 2,
+       horiz_scaling = 0.8,
+       vert_scaling = 1,
+       line_spacing = 9,
+       font_size = 31,
+       x_offset = 7,
+       y_offset = 4,
+       chars_per_line = 40,
+       entity_info = "standard"
+})
+
+* default def assumes a wallmounted sign with on-pole being allowed.
+
+*For signs that can't support onpole, include in the def:
+       allow_onpole = false,
+
+* "standard" entity info implies the standard wood/steel sign model, in
+  wallmounted mode.  For facedir signs using the standard model, use:
+
+       entity_info = {
+               mesh = "signs_lib_standard_wall_sign_entity.obj",
+               yaw = signs_lib.standard_yaw
+       },
+
+]]--
+
+function signs_lib.register_sign(name, rdef)
+
+       local def = table.copy(rdef)
+
+       if rdef.entity_info == "standard" then
+               def.entity_info = {
+                       mesh = "signs_lib_standard_wall_sign_entity.obj",
+                       yaw = signs_lib.wallmounted_yaw
+               }
+       elseif rdef.entity_info then
+               def.entity_info = rdef.entity_info
+       end
+
+       if rdef.entity_info then
+               def.on_rightclick       = rdef.on_rightclick       or signs_lib.construct_sign
+               def.on_construct        = rdef.on_construct        or signs_lib.construct_sign
+               def.on_destruct         = rdef.on_destruct         or signs_lib.destruct_sign
+               def.on_receive_fields   = rdef.on_receive_fields   or signs_lib.receive_fields
+               def.on_punch            = rdef.on_punch            or signs_lib.update_sign
+               def.number_of_lines     = rdef.number_of_lines     or signs_lib.standard_lines
+               def.horiz_scaling       = rdef.horiz_scaling       or signs_lib.standard_hscale
+               def.vert_scaling        = rdef.vert_scaling        or signs_lib.standard_vscale
+               def.line_spacing        = rdef.line_spacing        or signs_lib.standard_lspace
+               def.font_size           = rdef.font_size           or signs_lib.standard_fsize
+               def.x_offset            = rdef.x_offset            or signs_lib.standard_xoffs
+               def.y_offset            = rdef.y_offset            or signs_lib.standard_yoffs
+               def.chars_per_line      = rdef.chars_per_line      or signs_lib.standard_cpl
+               def.default_color       = rdef.default_color       or "0"
+               if rdef.locked and not rdef.after_place_node then
+                       def.after_place_node = function(pos, placer, itemstack, pointed_thing)
+                               signs_lib.after_place_node(pos, placer, itemstack, pointed_thing, true)
+                       end
+               else
+                       def.after_place_node = rdef.after_place_node or signs_lib.after_place_node
+               end
+       end
+
+       def.paramtype           = rdef.paramtype           or "light"
+       def.drawtype            = rdef.drawtype            or "mesh"
+       def.mesh                = rdef.mesh                or "signs_lib_standard_wall_sign.obj"
+       def.wield_image         = rdef.wield_image         or def.inventory_image
+       def.drop                = rdef.drop                or name
+       def.sounds              = rdef.sounds              or signs_lib.standard_wood_sign_sounds
+       def.on_rotate           = rdef.on_rotate           or signs_lib.wallmounted_rotate
+       def.paramtype2          = rdef.paramtype2          or "wallmounted"
+
+       if rdef.on_rotate then
+               def.on_rotate = rdef.on_rotate
+       elseif rdef.drawtype == "wallmounted" then
+               def.on_rotate = signs_lib.wallmounted_rotate
+       else
+               def.on_rotate = signs_lib.facedir_rotate
+       end
+
+       if rdef.groups then
+               def.groups = rdef.groups
+       else
+               def.groups = signs_lib.standard_wood_groups
+       end
+
+       local cbox = signs_lib.make_selection_boxes(35, 25, allow_onpole)
+
+       def.selection_box = rdef.selection_box or cbox
+       def.node_box      = table.copy(rdef.node_box or rdef.selection_box or cbox)
+
+       if def.sunlight_propagates ~= false then
+               def.sunlight_propagates = true
+       end
+
+       minetest.register_node(":"..name, def)
+       table.insert(signs_lib.lbm_restore_nodes, name)
+
+       if rdef.allow_onpole ~= false then
+
+               local opdef = table.copy(def)
+
+               local offset = 0.3125
+               if opdef.uses_slim_pole_mount then
+                       offset = 0.35
+               end
+
+               opdef.selection_box = rdef.onpole_selection_box or opdef.selection_box
+               opdef.node_box = rdef.onpole_node_box or opdef.selection_box
+
+               if opdef.paramtype2 == "wallmounted" then
+                       opdef.node_box.wall_side[1] = def.node_box.wall_side[1] - offset
+                       opdef.node_box.wall_side[4] = def.node_box.wall_side[4] - offset
+
+                       opdef.selection_box.wall_side[1] = def.selection_box.wall_side[1] - offset
+                       opdef.selection_box.wall_side[4] = def.selection_box.wall_side[4] - offset
+               else
+                       opdef.node_box.fixed[3] = def.node_box.fixed[3] + offset
+                       opdef.node_box.fixed[6] = def.node_box.fixed[6] + offset
+
+                       opdef.selection_box.fixed[3] = def.selection_box.fixed[3] + offset
+                       opdef.selection_box.fixed[6] = def.selection_box.fixed[6] + offset
+               end
+
+               opdef.groups.not_in_creative_inventory = 1
+               opdef.tiles[3] = "signs_lib_pole_mount.png"
+               opdef.mesh = string.gsub(opdef.mesh, ".obj$", "_onpole.obj")
+               opdef.on_rotate = nil
+
+
+               if opdef.entity_info then
+                       opdef.entity_info.mesh = string.gsub(opdef.entity_info.mesh, ".obj$", "_onpole.obj")
+               end
+               minetest.register_node(":"..name.."_onpole", opdef)
+               table.insert(signs_lib.lbm_restore_nodes, name.."_onpole")
+       end
+
+       if rdef.allow_hanging then
+
+               local hdef = table.copy(def)
+               hdef.paramtype2 = "facedir"
+
+               local hcbox = signs_lib.make_selection_boxes(35, 32, false, 0, 3, -18.5, true)
+
+               hdef.selection_box = rdef.hanging_selection_box or hcbox
+               hdef.node_box = rdef.hanging_node_box or rdef.hanging_selection_box or hcbox
+
+               hdef.groups.not_in_creative_inventory = 1
+               hdef.tiles[3] = "signs_lib_hangers.png"
+               hdef.mesh = string.gsub(string.gsub(hdef.mesh, "_facedir.obj", ".obj"), ".obj$", "_hanging.obj")
+               hdef.on_rotate = nil
+
+               if hdef.entity_info then
+                       hdef.entity_info.mesh = string.gsub(string.gsub(hdef.entity_info.mesh, "_facedir.obj", ".obj"), ".obj$", "_hanging.obj")
+                       hdef.entity_info.yaw = signs_lib.standard_yaw
+               end
+
+               minetest.register_node(":"..name.."_hanging", hdef)
+               table.insert(signs_lib.lbm_restore_nodes, name.."_hanging")
+       end
+
+end
+
 -- restore signs' text after /clearobjects and the like, the next time
 -- a block is reloaded by the server.
 
@@ -661,3 +872,71 @@ minetest.register_lbm({
                end
        end
 })
+
+signs_lib.block_list = {}
+signs_lib.totalblocks = 0
+
+-- Maintain a list of currently-loaded blocks
+minetest.register_lbm({
+       nodenames = {"group:sign"},
+       name = "signs_lib:update_block_list",
+       label = "Update list of loaded blocks, log only those with signs",
+       run_at_every_load = true,
+       action = function(pos, node)
+               -- yeah, yeah... I know I'm hashing a block pos, but it's still just a set of coords
+               local hash = minetest.hash_node_position(vector.floor(vector.divide(pos, core.MAP_BLOCKSIZE)))
+               if not signs_lib.block_list[hash] then
+                       signs_lib.block_list[hash] = true
+                       signs_lib.totalblocks = signs_lib.totalblocks + 1
+               end
+       end
+})
+
+minetest.register_chatcommand("regen_signs", {
+       params = "",
+       privs = {server = true},
+       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.",
+       func = function(player_name, params)
+               local allsigns = {}
+               local totalsigns = 0
+               for b in pairs(signs_lib.block_list) do
+                       local blockpos = minetest.get_position_from_hash(b)
+                       local pos1 = vector.multiply(blockpos, core.MAP_BLOCKSIZE)
+                       local pos2 = vector.add(pos1, core.MAP_BLOCKSIZE - 1)
+                       if minetest.get_node_or_nil(vector.add(pos1, core.MAP_BLOCKSIZE/2)) then
+                               local signs_in_block = minetest.find_nodes_in_area(pos1, pos2, {"group:sign"})
+                               allsigns[#allsigns + 1] = signs_in_block
+                               totalsigns = totalsigns + #signs_in_block
+                       else
+                               signs_lib.block_list[b] = nil -- if the block is no longer loaded, remove it from the table
+                               signs_lib.totalblocks = signs_lib.totalblocks - 1
+                       end
+               end
+               if signs_lib.totalblocks < 0 then signs_lib.totalblocks = 0 end
+               if totalsigns == 0 then
+                       minetest.chat_send_player(player_name, "There are no signs in the currently-loaded terrain.")
+                       signs_lib.block_list = {}
+                       return
+               end
+
+               minetest.chat_send_player(player_name, "Found a total of "..totalsigns.." sign nodes across "..signs_lib.totalblocks.." blocks.")
+               minetest.chat_send_player(player_name, "Regenerating sign entities...")
+
+               for _, b in pairs(allsigns) do
+                       for _, pos in ipairs(b) do
+                               local objects = minetest.get_objects_inside_radius(pos, 0.5)
+                               if #objects > 0 then
+                                       for _, v in ipairs(objects) do
+                                               v:remove()
+                                       end
+                               end
+                               local node = minetest.get_node(pos)
+                               local def = minetest.registered_items[node.name]
+                               if def and def.entity_info then
+                                       signs_lib.update_sign(pos)
+                               end
+                       end
+               end
+               minetest.chat_send_player(player_name, "Finished.")
+       end
+})