Add configurable key bindings for hotbar scrolling, and for changing volume.
[oweals/minetest.git] / builtin / game / register.lua
index 3a13abfb35e364b9fc71ce981d589a8a03da46ff..ec6f28097c8543698e8d9bceb20def960c1f0ea2 100644 (file)
@@ -7,14 +7,18 @@
 local register_item_raw = core.register_item_raw
 core.register_item_raw = nil
 
+local unregister_item_raw = core.unregister_item_raw
+core.unregister_item_raw = nil
+
 local register_alias_raw = core.register_alias_raw
 core.register_alias_raw = nil
 
 --
--- Item / entity / ABM registration functions
+-- Item / entity / ABM / LBM registration functions
 --
 
 core.registered_abms = {}
+core.registered_lbms = {}
 core.registered_entities = {}
 core.registered_items = {}
 core.registered_nodes = {}
@@ -51,27 +55,39 @@ local forbidden_item_names = {
 
 local function check_modname_prefix(name)
        if name:sub(1,1) == ":" then
-               -- Escape the modname prefix enforcement mechanism
+               -- If the name starts with a colon, we can skip the modname prefix
+               -- mechanism.
                return name:sub(2)
        else
-               -- Modname prefix enforcement
+               -- Enforce that the name starts with the correct mod name.
                local expected_prefix = core.get_current_modname() .. ":"
                if name:sub(1, #expected_prefix) ~= expected_prefix then
                        error("Name " .. name .. " does not follow naming conventions: " ..
-                               "\"modname:\" or \":\" prefix required")
+                               "\"" .. expected_prefix .. "\" or \":\" prefix required")
                end
+               
+               -- Enforce that the name only contains letters, numbers and underscores.
                local subname = name:sub(#expected_prefix+1)
-               if subname:find("[^abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_]") then
+               if subname:find("[^%w_]") then
                        error("Name " .. name .. " does not follow naming conventions: " ..
                                "contains unallowed characters")
                end
+               
                return name
        end
 end
 
 function core.register_abm(spec)
        -- Add to core.registered_abms
-       core.registered_abms[#core.registered_abms+1] = spec
+       core.registered_abms[#core.registered_abms + 1] = spec
+       spec.mod_origin = core.get_current_modname() or "??"
+end
+
+function core.register_lbm(spec)
+       -- Add to core.registered_lbms
+       check_modname_prefix(spec.name)
+       core.registered_lbms[#core.registered_lbms + 1] = spec
+       spec.mod_origin = core.get_current_modname() or "??"
 end
 
 function core.register_entity(name, prototype)
@@ -86,6 +102,7 @@ function core.register_entity(name, prototype)
 
        -- Add to core.registered_entities
        core.registered_entities[name] = prototype
+       prototype.mod_origin = core.get_current_modname() or "??"
 end
 
 function core.register_item(name, itemdef)
@@ -110,6 +127,11 @@ function core.register_item(name, itemdef)
                                fixed = {-1/8, -1/2, -1/8, 1/8, 1/2, 1/8},
                        }
                end
+               if itemdef.light_source and itemdef.light_source > core.LIGHT_MAX then
+                       itemdef.light_source = core.LIGHT_MAX
+                       core.log("warning", "Node 'light_source' value exceeds maximum," ..
+                               " limiting to maximum: " ..name)
+               end
                setmetatable(itemdef, {__index = core.nodedef_default})
                core.registered_nodes[itemdef.name] = itemdef
        elseif itemdef.type == "craft" then
@@ -147,6 +169,8 @@ function core.register_item(name, itemdef)
        end
        -- END Legacy stuff
 
+       itemdef.mod_origin = core.get_current_modname() or "??"
+
        -- Disable all further modifications
        getmetatable(itemdef).__newindex = {}
 
@@ -156,6 +180,27 @@ function core.register_item(name, itemdef)
        register_item_raw(itemdef)
 end
 
+function core.unregister_item(name)
+       if not core.registered_items[name] then
+               core.log("warning", "Not unregistering item " ..name..
+                       " because it doesn't exist.")
+               return
+       end
+       -- Erase from registered_* table
+       local type = core.registered_items[name].type
+       if type == "node" then
+               core.registered_nodes[name] = nil
+       elseif type == "craft" then
+               core.registered_craftitems[name] = nil
+       elseif type == "tool" then
+               core.registered_tools[name] = nil
+       end
+       core.registered_items[name] = nil
+
+
+       unregister_item_raw(name)
+end
+
 function core.register_node(name, nodedef)
        nodedef.type = "node"
        core.register_item(name, nodedef)
@@ -217,7 +262,7 @@ function core.register_alias(name, convert_to)
                error("Unable to register alias: Name is forbidden: " .. name)
        end
        if core.registered_items[name] ~= nil then
-               core.log("WARNING: Not registering alias, item with same name" ..
+               core.log("warning", "Not registering alias, item with same name" ..
                        " is already defined: " .. name .. " -> " .. convert_to)
        else
                --core.log("Registering alias: " .. name .. " -> " .. convert_to)
@@ -226,6 +271,20 @@ function core.register_alias(name, convert_to)
        end
 end
 
+function core.register_alias_force(name, convert_to)
+       if forbidden_item_names[name] then
+               error("Unable to register alias: Name is forbidden: " .. name)
+       end
+       if core.registered_items[name] ~= nil then
+               core.unregister_item(name)
+               core.log("info", "Removed item " ..name..
+                       " while attempting to force add an alias")
+       end
+       --core.log("Registering alias: " .. name .. " -> " .. convert_to)
+       core.registered_aliases[name] = convert_to
+       register_alias_raw(name, convert_to)
+end
+
 function core.on_craft(itemstack, player, old_craft_list, craft_inv)
        for _, func in ipairs(core.registered_on_crafts) do
                itemstack = func(itemstack, player, old_craft_list, craft_inv) or itemstack
@@ -264,6 +323,7 @@ core.register_item(":unknown", {
        description = "Unknown Item",
        inventory_image = "unknown_item.png",
        on_place = core.item_place,
+       on_secondary_use = core.item_secondary_use,
        on_drop = core.item_drop,
        groups = {not_in_creative_inventory=1},
        diggable = true,
@@ -271,8 +331,8 @@ core.register_item(":unknown", {
 
 core.register_node(":air", {
        description = "Air (you hacker you!)",
-       inventory_image = "unknown_node.png",
-       wield_image = "unknown_node.png",
+       inventory_image = "air.png",
+       wield_image = "air.png",
        drawtype = "airlike",
        paramtype = "light",
        sunlight_propagates = true,
@@ -280,6 +340,7 @@ core.register_node(":air", {
        pointable = false,
        diggable = false,
        buildable_to = true,
+       floodable = true,
        air_equivalent = true,
        drop = "",
        groups = {not_in_creative_inventory=1},
@@ -287,8 +348,8 @@ core.register_node(":air", {
 
 core.register_node(":ignore", {
        description = "Ignore (you hacker you!)",
-       inventory_image = "unknown_node.png",
-       wield_image = "unknown_node.png",
+       inventory_image = "ignore.png",
+       wield_image = "ignore.png",
        drawtype = "airlike",
        paramtype = "none",
        sunlight_propagates = false,
@@ -326,6 +387,8 @@ function core.override_item(name, redefinition)
 end
 
 
+core.callback_origins = {}
+
 function core.run_callbacks(callbacks, mode, ...)
        assert(type(callbacks) == "table")
        local cb_len = #callbacks
@@ -338,6 +401,14 @@ function core.run_callbacks(callbacks, mode, ...)
        end
        local ret = nil
        for i = 1, cb_len do
+               local origin = core.callback_origins[callbacks[i]]
+               if origin then
+                       core.set_last_run_mod(origin.mod)
+                       --print("Running " .. tostring(callbacks[i]) ..
+                       --      " (a " .. origin.name .. " callback in " .. origin.mod .. ")")
+               else
+                       --print("No data associated with callback")
+               end
                local cb_ret = callbacks[i](...)
 
                if mode == 0 and i == 1 then
@@ -370,13 +441,29 @@ end
 
 local function make_registration()
        local t = {}
-       local registerfunc = function(func) table.insert(t, func) end
+       local registerfunc = function(func)
+               t[#t + 1] = func
+               core.callback_origins[func] = {
+                       mod = core.get_current_modname() or "??",
+                       name = debug.getinfo(1, "n").name or "??"
+               }
+               --local origin = core.callback_origins[func]
+               --print(origin.name .. ": " .. origin.mod .. " registering cbk " .. tostring(func))
+       end
        return t, registerfunc
 end
 
 local function make_registration_reverse()
        local t = {}
-       local registerfunc = function(func) table.insert(t, 1, func) end
+       local registerfunc = function(func)
+               table.insert(t, 1, func)
+               core.callback_origins[func] = {
+                       mod = core.get_current_modname() or "??",
+                       name = debug.getinfo(1, "n").name or "??"
+               }
+               --local origin = core.callback_origins[func]
+               --print(origin.name .. ": " .. origin.mod .. " registering cbk " .. tostring(func))
+       end
        return t, registerfunc
 end
 
@@ -408,6 +495,7 @@ local function make_registration_wrap(reg_fn_name, clear_fn_name)
 end
 
 core.registered_on_player_hpchanges = { modifiers = { }, loggers = { } }
+
 function core.registered_on_player_hpchange(player, hp_change)
        local last = false
        for i = #core.registered_on_player_hpchanges.modifiers, 1, -1 do
@@ -427,12 +515,17 @@ function core.registered_on_player_hpchange(player, hp_change)
        end
        return hp_change
 end
+
 function core.register_on_player_hpchange(func, modifier)
        if modifier then
-               table.insert(core.registered_on_player_hpchanges.modifiers, func)
+               core.registered_on_player_hpchanges.modifiers[#core.registered_on_player_hpchanges.modifiers + 1] = func
        else
-               table.insert(core.registered_on_player_hpchanges.loggers, func)
+               core.registered_on_player_hpchanges.loggers[#core.registered_on_player_hpchanges.loggers + 1] = func
        end
+       core.callback_origins[func] = {
+               mod = core.get_current_modname() or "??",
+               name = debug.getinfo(1, "n").name or "??"
+       }
 end
 
 core.registered_biomes      = make_registration_wrap("register_biome",      "clear_registered_biomes")