]> git.lizzy.rs Git - dragonfireclient.git/blobdiff - builtin/game/register.lua
Remove nodeupdate and nodeupdate_single
[dragonfireclient.git] / builtin / game / register.lua
index 99c5115c43f1966e321b5ff1df909970d570b486..1f355c7e56e2369e7396c16233bcb2e8bf19b583 100644 (file)
@@ -4,35 +4,39 @@
 -- Make raw registration functions inaccessible to anyone except this file
 --
 
-local register_item_raw = minetest.register_item_raw
-minetest.register_item_raw = nil
+local register_item_raw = core.register_item_raw
+core.register_item_raw = nil
 
-local register_alias_raw = minetest.register_alias_raw
-minetest.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
 --
 
-minetest.registered_abms = {}
-minetest.registered_entities = {}
-minetest.registered_items = {}
-minetest.registered_nodes = {}
-minetest.registered_craftitems = {}
-minetest.registered_tools = {}
-minetest.registered_aliases = {}
+core.registered_abms = {}
+core.registered_lbms = {}
+core.registered_entities = {}
+core.registered_items = {}
+core.registered_nodes = {}
+core.registered_craftitems = {}
+core.registered_tools = {}
+core.registered_aliases = {}
 
 -- For tables that are indexed by item name:
--- If table[X] does not exist, default to table[minetest.registered_aliases[X]]
+-- If table[X] does not exist, default to table[core.registered_aliases[X]]
 local alias_metatable = {
        __index = function(t, name)
-               return rawget(t, minetest.registered_aliases[name])
+               return rawget(t, core.registered_aliases[name])
        end
 }
-setmetatable(minetest.registered_items, alias_metatable)
-setmetatable(minetest.registered_nodes, alias_metatable)
-setmetatable(minetest.registered_craftitems, alias_metatable)
-setmetatable(minetest.registered_tools, alias_metatable)
+setmetatable(core.registered_items, alias_metatable)
+setmetatable(core.registered_nodes, alias_metatable)
+setmetatable(core.registered_craftitems, alias_metatable)
+setmetatable(core.registered_tools, alias_metatable)
 
 -- These item names may not be used because they would interfere
 -- with legacy itemstrings
@@ -51,30 +55,42 @@ 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
-               local expected_prefix = minetest.get_current_modname() .. ":"
+               -- 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 minetest.register_abm(spec)
-       -- Add to minetest.registered_abms
-       minetest.registered_abms[#minetest.registered_abms+1] = spec
+function core.register_abm(spec)
+       -- Add to core.registered_abms
+       core.registered_abms[#core.registered_abms + 1] = spec
+       spec.mod_origin = core.get_current_modname() or "??"
 end
 
-function minetest.register_entity(name, prototype)
+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)
        -- Check name
        if name == nil then
                error("Unable to register entity: Name is nil")
@@ -84,11 +100,12 @@ function minetest.register_entity(name, prototype)
        prototype.name = name
        prototype.__index = prototype  -- so that it can be used as a metatable
 
-       -- Add to minetest.registered_entities
-       minetest.registered_entities[name] = prototype
+       -- Add to core.registered_entities
+       core.registered_entities[name] = prototype
+       prototype.mod_origin = core.get_current_modname() or "??"
 end
 
-function minetest.register_item(name, itemdef)
+function core.register_item(name, itemdef)
        -- Check name
        if name == nil then
                error("Unable to register item: Name is nil")
@@ -110,16 +127,21 @@ function minetest.register_item(name, itemdef)
                                fixed = {-1/8, -1/2, -1/8, 1/8, 1/2, 1/8},
                        }
                end
-               setmetatable(itemdef, {__index = minetest.nodedef_default})
-               minetest.registered_nodes[itemdef.name] = itemdef
+               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
-               setmetatable(itemdef, {__index = minetest.craftitemdef_default})
-               minetest.registered_craftitems[itemdef.name] = itemdef
+               setmetatable(itemdef, {__index = core.craftitemdef_default})
+               core.registered_craftitems[itemdef.name] = itemdef
        elseif itemdef.type == "tool" then
-               setmetatable(itemdef, {__index = minetest.tooldef_default})
-               minetest.registered_tools[itemdef.name] = itemdef
+               setmetatable(itemdef, {__index = core.tooldef_default})
+               core.registered_tools[itemdef.name] = itemdef
        elseif itemdef.type == "none" then
-               setmetatable(itemdef, {__index = minetest.noneitemdef_default})
+               setmetatable(itemdef, {__index = core.noneitemdef_default})
        else
                error("Unable to register item: Type is invalid: " .. dump(itemdef))
        end
@@ -131,7 +153,7 @@ function minetest.register_item(name, itemdef)
 
        -- BEGIN Legacy stuff
        if itemdef.cookresult_itemstring ~= nil and itemdef.cookresult_itemstring ~= "" then
-               minetest.register_craft({
+               core.register_craft({
                        type="cooking",
                        output=itemdef.cookresult_itemstring,
                        recipe=itemdef.name,
@@ -139,7 +161,7 @@ function minetest.register_item(name, itemdef)
                })
        end
        if itemdef.furnace_burntime ~= nil and itemdef.furnace_burntime >= 0 then
-               minetest.register_craft({
+               core.register_craft({
                        type="fuel",
                        recipe=itemdef.name,
                        burntime=itemdef.furnace_burntime
@@ -147,21 +169,44 @@ function minetest.register_item(name, itemdef)
        end
        -- END Legacy stuff
 
+       itemdef.mod_origin = core.get_current_modname() or "??"
+
        -- Disable all further modifications
        getmetatable(itemdef).__newindex = {}
 
-       --minetest.log("Registering item: " .. itemdef.name)
-       minetest.registered_items[itemdef.name] = itemdef
-       minetest.registered_aliases[itemdef.name] = nil
+       --core.log("Registering item: " .. itemdef.name)
+       core.registered_items[itemdef.name] = itemdef
+       core.registered_aliases[itemdef.name] = nil
        register_item_raw(itemdef)
 end
 
-function minetest.register_node(name, nodedef)
+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"
-       minetest.register_item(name, nodedef)
+       core.register_item(name, nodedef)
 end
 
-function minetest.register_craftitem(name, craftitemdef)
+function core.register_craftitem(name, craftitemdef)
        craftitemdef.type = "craft"
 
        -- BEGIN Legacy stuff
@@ -170,10 +215,10 @@ function minetest.register_craftitem(name, craftitemdef)
        end
        -- END Legacy stuff
 
-       minetest.register_item(name, craftitemdef)
+       core.register_item(name, craftitemdef)
 end
 
-function minetest.register_tool(name, tooldef)
+function core.register_tool(name, tooldef)
        tooldef.type = "tool"
        tooldef.stack_max = 1
 
@@ -209,39 +254,46 @@ function minetest.register_tool(name, tooldef)
        end
        -- END Legacy stuff
 
-       minetest.register_item(name, tooldef)
+       core.register_item(name, tooldef)
 end
 
-function minetest.register_alias(name, convert_to)
+function core.register_alias(name, convert_to)
        if forbidden_item_names[name] then
                error("Unable to register alias: Name is forbidden: " .. name)
        end
-       if minetest.registered_items[name] ~= nil then
-               minetest.log("WARNING: Not registering alias, item with same name" ..
+       if core.registered_items[name] ~= nil then
+               core.log("warning", "Not registering alias, item with same name" ..
                        " is already defined: " .. name .. " -> " .. convert_to)
        else
-               --minetest.log("Registering alias: " .. name .. " -> " .. convert_to)
-               minetest.registered_aliases[name] = convert_to
+               --core.log("Registering alias: " .. name .. " -> " .. convert_to)
+               core.registered_aliases[name] = convert_to
                register_alias_raw(name, convert_to)
        end
 end
 
-local register_biome_raw = minetest.register_biome
-minetest.registered_biomes = {}
-function minetest.register_biome(biome)
-       minetest.registered_biomes[biome.name] = biome
-       register_biome_raw(biome)
+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 minetest.on_craft(itemstack, player, old_craft_list, craft_inv)
-       for _, func in ipairs(minetest.registered_on_crafts) do
+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
        end
        return itemstack
 end
 
-function minetest.craft_predict(itemstack, player, old_craft_list, craft_inv)
-       for _, func in ipairs(minetest.registered_craft_predicts) do
+function core.craft_predict(itemstack, player, old_craft_list, craft_inv)
+       for _, func in ipairs(core.registered_craft_predicts) do
                itemstack = func(itemstack, player, old_craft_list, craft_inv) or itemstack
        end
        return itemstack
@@ -251,35 +303,36 @@ end
 -- created via itemstrings (e.g. /give)
 local name
 for name in pairs(forbidden_item_names) do
-       minetest.registered_aliases[name] = ""
+       core.registered_aliases[name] = ""
        register_alias_raw(name, "")
 end
 
 
 -- Deprecated:
--- Aliases for minetest.register_alias (how ironic...)
---minetest.alias_node = minetest.register_alias
---minetest.alias_tool = minetest.register_alias
---minetest.alias_craftitem = minetest.register_alias
+-- Aliases for core.register_alias (how ironic...)
+--core.alias_node = core.register_alias
+--core.alias_tool = core.register_alias
+--core.alias_craftitem = core.register_alias
 
 --
 -- Built-in node definitions. Also defined in C.
 --
 
-minetest.register_item(":unknown", {
+core.register_item(":unknown", {
        type = "none",
        description = "Unknown Item",
        inventory_image = "unknown_item.png",
-       on_place = minetest.item_place,
-       on_drop = minetest.item_drop,
+       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,
 })
 
-minetest.register_node(":air", {
+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,
@@ -287,15 +340,16 @@ minetest.register_node(":air", {
        pointable = false,
        diggable = false,
        buildable_to = true,
+       floodable = true,
        air_equivalent = true,
        drop = "",
        groups = {not_in_creative_inventory=1},
 })
 
-minetest.register_node(":ignore", {
+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,
@@ -309,20 +363,20 @@ minetest.register_node(":ignore", {
 })
 
 -- The hand (bare definition)
-minetest.register_item(":", {
+core.register_item(":", {
        type = "none",
        groups = {not_in_creative_inventory=1},
 })
 
 
-function minetest.override_item(name, redefinition)
+function core.override_item(name, redefinition)
        if redefinition.name ~= nil then
                error("Attempt to redefine name of "..name.." to "..dump(redefinition.name), 2)
        end
        if redefinition.type ~= nil then
                error("Attempt to redefine type of "..name.." to "..dump(redefinition.type), 2)
        end
-       local item = minetest.registered_items[name]
+       local item = core.registered_items[name]
        if not item then
                error("Attempt to override non-existent item "..name, 2)
        end
@@ -333,7 +387,9 @@ function minetest.override_item(name, redefinition)
 end
 
 
-function minetest.run_callbacks(callbacks, mode, ...)
+core.callback_origins = {}
+
+function core.run_callbacks(callbacks, mode, ...)
        assert(type(callbacks) == "table")
        local cb_len = #callbacks
        if cb_len == 0 then
@@ -345,6 +401,14 @@ function minetest.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
@@ -371,40 +435,155 @@ function minetest.run_callbacks(callbacks, mode, ...)
        return ret
 end
 
+function core.run_priv_callbacks(name, priv, caller, method)
+       if not core.registered_privileges[priv]["on_" .. method] or
+                       not core.registered_privileges[priv]["on_" .. method](name, caller) then
+               for _, func in ipairs(core["registered_on_priv_" .. method]) do
+                       if not func(name, caller, priv) then
+                               break
+                       end
+               end
+       end
+end
+
 --
 -- Callback registration
 --
 
 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
 
-minetest.registered_on_chat_messages, minetest.register_on_chat_message = make_registration()
-minetest.registered_globalsteps, minetest.register_globalstep = make_registration()
-minetest.registered_playerevents, minetest.register_playerevent = make_registration()
-minetest.registered_on_mapgen_inits, minetest.register_on_mapgen_init = make_registration()
-minetest.registered_on_shutdown, minetest.register_on_shutdown = make_registration()
-minetest.registered_on_punchnodes, minetest.register_on_punchnode = make_registration()
-minetest.registered_on_placenodes, minetest.register_on_placenode = make_registration()
-minetest.registered_on_dignodes, minetest.register_on_dignode = make_registration()
-minetest.registered_on_generateds, minetest.register_on_generated = make_registration()
-minetest.registered_on_newplayers, minetest.register_on_newplayer = make_registration()
-minetest.registered_on_dieplayers, minetest.register_on_dieplayer = make_registration()
-minetest.registered_on_respawnplayers, minetest.register_on_respawnplayer = make_registration()
-minetest.registered_on_prejoinplayers, minetest.register_on_prejoinplayer = make_registration()
-minetest.registered_on_joinplayers, minetest.register_on_joinplayer = make_registration()
-minetest.registered_on_leaveplayers, minetest.register_on_leaveplayer = make_registration()
-minetest.registered_on_player_receive_fields, minetest.register_on_player_receive_fields = make_registration_reverse()
-minetest.registered_on_cheats, minetest.register_on_cheat = make_registration()
-minetest.registered_on_crafts, minetest.register_on_craft = make_registration()
-minetest.registered_craft_predicts, minetest.register_craft_predict = make_registration()
-minetest.registered_on_protection_violation, minetest.register_on_protection_violation = make_registration()
+local function make_registration_wrap(reg_fn_name, clear_fn_name)
+       local list = {}
+
+       local orig_reg_fn = core[reg_fn_name]
+       core[reg_fn_name] = function(def)
+               local retval = orig_reg_fn(def)
+               if retval ~= nil then
+                       if def.name ~= nil then
+                               list[def.name] = def
+                       else
+                               list[retval] = def
+                       end
+               end
+               return retval
+       end
+
+       local orig_clear_fn = core[clear_fn_name]
+       core[clear_fn_name] = function()
+               for k in pairs(list) do
+                       list[k] = nil
+               end
+               return orig_clear_fn()
+       end
+
+       return list
+end
+
+local function make_wrap_deregistration(reg_fn, clear_fn, list)
+       local unregister = function (unregistered_key)
+               local temporary_list = table.copy(list)
+               clear_fn()
+               for k,v in pairs(temporary_list) do
+                       if unregistered_key ~= k then
+                               reg_fn(v)
+                       end
+               end
+       end
+       return unregister
+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
+               local func = core.registered_on_player_hpchanges.modifiers[i]
+               hp_change, last = func(player, hp_change)
+               if type(hp_change) ~= "number" then
+                       local debuginfo = debug.getinfo(func)
+                       error("The register_on_hp_changes function has to return a number at " ..
+                               debuginfo.short_src .. " line " .. debuginfo.linedefined)
+               end
+               if last then
+                       break
+               end
+       end
+       for i, func in ipairs(core.registered_on_player_hpchanges.loggers) do
+               func(player, hp_change)
+       end
+       return hp_change
+end
+
+function core.register_on_player_hpchange(func, modifier)
+       if modifier then
+               core.registered_on_player_hpchanges.modifiers[#core.registered_on_player_hpchanges.modifiers + 1] = func
+       else
+               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")
+core.registered_ores        = make_registration_wrap("register_ore",        "clear_registered_ores")
+core.registered_decorations = make_registration_wrap("register_decoration", "clear_registered_decorations")
+
+core.unregister_biome = make_wrap_deregistration(core.register_biome, core.clear_registered_biomes, core.registered_biomes)
+
+core.registered_on_chat_messages, core.register_on_chat_message = make_registration()
+core.registered_globalsteps, core.register_globalstep = make_registration()
+core.registered_playerevents, core.register_playerevent = make_registration()
+core.registered_on_shutdown, core.register_on_shutdown = make_registration()
+core.registered_on_punchnodes, core.register_on_punchnode = make_registration()
+core.registered_on_placenodes, core.register_on_placenode = make_registration()
+core.registered_on_dignodes, core.register_on_dignode = make_registration()
+core.registered_on_generateds, core.register_on_generated = make_registration()
+core.registered_on_newplayers, core.register_on_newplayer = make_registration()
+core.registered_on_dieplayers, core.register_on_dieplayer = make_registration()
+core.registered_on_respawnplayers, core.register_on_respawnplayer = make_registration()
+core.registered_on_prejoinplayers, core.register_on_prejoinplayer = make_registration()
+core.registered_on_joinplayers, core.register_on_joinplayer = make_registration()
+core.registered_on_leaveplayers, core.register_on_leaveplayer = make_registration()
+core.registered_on_player_receive_fields, core.register_on_player_receive_fields = make_registration_reverse()
+core.registered_on_cheats, core.register_on_cheat = make_registration()
+core.registered_on_crafts, core.register_on_craft = make_registration()
+core.registered_craft_predicts, core.register_craft_predict = make_registration()
+core.registered_on_protection_violation, core.register_on_protection_violation = make_registration()
+core.registered_on_item_eats, core.register_on_item_eat = make_registration()
+core.registered_on_punchplayers, core.register_on_punchplayer = make_registration()
+core.registered_on_priv_grant, core.register_on_priv_grant = make_registration()
+core.registered_on_priv_revoke, core.register_on_priv_revoke = make_registration()
+
+--
+-- Compatibility for on_mapgen_init()
+--
 
+core.register_on_mapgen_init = function(func) func(core.get_mapgen_params()) end