builtin/game/register.lua

   1 -- Minetest: builtin/misc_register.lua
   2
   3 --
   4 -- Make raw registration functions inaccessible to anyone except this file
   5 --
   6
   7 local register_item_raw = core.register_item_raw
   8 core.register_item_raw = nil
   9
  10 local register_alias_raw = core.register_alias_raw
  11 core.register_alias_raw = nil
  12
  13 --
  14 -- Item / entity / ABM registration functions
  15 --
  16
  17 core.registered_abms = {}
  18 core.registered_entities = {}
  19 core.registered_items = {}
  20 core.registered_nodes = {}
  21 core.registered_craftitems = {}
  22 core.registered_tools = {}
  23 core.registered_aliases = {}
  24
  25 -- For tables that are indexed by item name:
  26 -- If table[X] does not exist, default to table[core.registered_aliases[X]]
  27 local alias_metatable = {
  28         __index = function(t, name)
  29                 return rawget(t, core.registered_aliases[name])
  30         end
  31 }
  32 setmetatable(core.registered_items, alias_metatable)
  33 setmetatable(core.registered_nodes, alias_metatable)
  34 setmetatable(core.registered_craftitems, alias_metatable)
  35 setmetatable(core.registered_tools, alias_metatable)
  36
  37 -- These item names may not be used because they would interfere
  38 -- with legacy itemstrings
  39 local forbidden_item_names = {
  40         MaterialItem = true,
  41         MaterialItem2 = true,
  42         MaterialItem3 = true,
  43         NodeItem = true,
  44         node = true,
  45         CraftItem = true,
  46         craft = true,
  47         MBOItem = true,
  48         ToolItem = true,
  49         tool = true,
  50 }
  51
  52 local function check_modname_prefix(name)
  53         if name:sub(1,1) == ":" then
  54                 -- If the name starts with a colon, we can skip the modname prefix
  55                 -- mechanism.
  56                 return name:sub(2)
  57         else
  58                 -- Enforce that the name starts with the correct mod name.
  59                 local expected_prefix = core.get_current_modname() .. ":"
  60                 if name:sub(1, #expected_prefix) ~= expected_prefix then
  61                         error("Name " .. name .. " does not follow naming conventions: " ..
  62                                 "\"" .. expected_prefix .. "\" or \":\" prefix required")
  63                 end
  64
  65                 -- Enforce that the name only contains letters, numbers and underscores.
  66                 local subname = name:sub(#expected_prefix+1)
  67                 if subname:find("[^%w_]") then
  68                         error("Name " .. name .. " does not follow naming conventions: " ..
  69                                 "contains unallowed characters")
  70                 end
  71
  72                 return name
  73         end
  74 end
  75
  76 function core.register_abm(spec)
  77         -- Add to core.registered_abms
  78         core.registered_abms[#core.registered_abms+1] = spec
  79         spec.mod_origin = core.get_current_modname() or "??"
  80 end
  81
  82 function core.register_entity(name, prototype)
  83         -- Check name
  84         if name == nil then
  85                 error("Unable to register entity: Name is nil")
  86         end
  87         name = check_modname_prefix(tostring(name))
  88
  89         prototype.name = name
  90         prototype.__index = prototype  -- so that it can be used as a metatable
  91
  92         -- Add to core.registered_entities
  93         core.registered_entities[name] = prototype
  94         prototype.mod_origin = core.get_current_modname() or "??"
  95 end
  96
  97 function core.register_item(name, itemdef)
  98         -- Check name
  99         if name == nil then
 100                 error("Unable to register item: Name is nil")
 101         end
 102         name = check_modname_prefix(tostring(name))
 103         if forbidden_item_names[name] then
 104                 error("Unable to register item: Name is forbidden: " .. name)
 105         end
 106         itemdef.name = name
 107
 108         -- Apply defaults and add to registered_* table
 109         if itemdef.type == "node" then
 110                 -- Use the nodebox as selection box if it's not set manually
 111                 if itemdef.drawtype == "nodebox" and not itemdef.selection_box then
 112                         itemdef.selection_box = itemdef.node_box
 113                 elseif itemdef.drawtype == "fencelike" and not itemdef.selection_box then
 114                         itemdef.selection_box = {
 115                                 type = "fixed",
 116                                 fixed = {-1/8, -1/2, -1/8, 1/8, 1/2, 1/8},
 117                         }
 118                 end
 119                 setmetatable(itemdef, {__index = core.nodedef_default})
 120                 core.registered_nodes[itemdef.name] = itemdef
 121         elseif itemdef.type == "craft" then
 122                 setmetatable(itemdef, {__index = core.craftitemdef_default})
 123                 core.registered_craftitems[itemdef.name] = itemdef
 124         elseif itemdef.type == "tool" then
 125                 setmetatable(itemdef, {__index = core.tooldef_default})
 126                 core.registered_tools[itemdef.name] = itemdef
 127         elseif itemdef.type == "none" then
 128                 setmetatable(itemdef, {__index = core.noneitemdef_default})
 129         else
 130                 error("Unable to register item: Type is invalid: " .. dump(itemdef))
 131         end
 132
 133         -- Flowing liquid uses param2
 134         if itemdef.type == "node" and itemdef.liquidtype == "flowing" then
 135                 itemdef.paramtype2 = "flowingliquid"
 136         end
 137
 138         -- BEGIN Legacy stuff
 139         if itemdef.cookresult_itemstring ~= nil and itemdef.cookresult_itemstring ~= "" then
 140                 core.register_craft({
 141                         type="cooking",
 142                         output=itemdef.cookresult_itemstring,
 143                         recipe=itemdef.name,
 144                         cooktime=itemdef.furnace_cooktime
 145                 })
 146         end
 147         if itemdef.furnace_burntime ~= nil and itemdef.furnace_burntime >= 0 then
 148                 core.register_craft({
 149                         type="fuel",
 150                         recipe=itemdef.name,
 151                         burntime=itemdef.furnace_burntime
 152                 })
 153         end
 154         -- END Legacy stuff
 155
 156         itemdef.mod_origin = core.get_current_modname() or "??"
 157
 158         -- Disable all further modifications
 159         getmetatable(itemdef).__newindex = {}
 160
 161         --core.log("Registering item: " .. itemdef.name)
 162         core.registered_items[itemdef.name] = itemdef
 163         core.registered_aliases[itemdef.name] = nil
 164         register_item_raw(itemdef)
 165 end
 166
 167 function core.register_node(name, nodedef)
 168         nodedef.type = "node"
 169         core.register_item(name, nodedef)
 170 end
 171
 172 function core.register_craftitem(name, craftitemdef)
 173         craftitemdef.type = "craft"
 174
 175         -- BEGIN Legacy stuff
 176         if craftitemdef.inventory_image == nil and craftitemdef.image ~= nil then
 177                 craftitemdef.inventory_image = craftitemdef.image
 178         end
 179         -- END Legacy stuff
 180
 181         core.register_item(name, craftitemdef)
 182 end
 183
 184 function core.register_tool(name, tooldef)
 185         tooldef.type = "tool"
 186         tooldef.stack_max = 1
 187
 188         -- BEGIN Legacy stuff
 189         if tooldef.inventory_image == nil and tooldef.image ~= nil then
 190                 tooldef.inventory_image = tooldef.image
 191         end
 192         if tooldef.tool_capabilities == nil and
 193            (tooldef.full_punch_interval ~= nil or
 194             tooldef.basetime ~= nil or
 195             tooldef.dt_weight ~= nil or
 196             tooldef.dt_crackiness ~= nil or
 197             tooldef.dt_crumbliness ~= nil or
 198             tooldef.dt_cuttability ~= nil or
 199             tooldef.basedurability ~= nil or
 200             tooldef.dd_weight ~= nil or
 201             tooldef.dd_crackiness ~= nil or
 202             tooldef.dd_crumbliness ~= nil or
 203             tooldef.dd_cuttability ~= nil) then
 204                 tooldef.tool_capabilities = {
 205                         full_punch_interval = tooldef.full_punch_interval,
 206                         basetime = tooldef.basetime,
 207                         dt_weight = tooldef.dt_weight,
 208                         dt_crackiness = tooldef.dt_crackiness,
 209                         dt_crumbliness = tooldef.dt_crumbliness,
 210                         dt_cuttability = tooldef.dt_cuttability,
 211                         basedurability = tooldef.basedurability,
 212                         dd_weight = tooldef.dd_weight,
 213                         dd_crackiness = tooldef.dd_crackiness,
 214                         dd_crumbliness = tooldef.dd_crumbliness,
 215                         dd_cuttability = tooldef.dd_cuttability,
 216                 }
 217         end
 218         -- END Legacy stuff
 219
 220         core.register_item(name, tooldef)
 221 end
 222
 223 function core.register_alias(name, convert_to)
 224         if forbidden_item_names[name] then
 225                 error("Unable to register alias: Name is forbidden: " .. name)
 226         end
 227         if core.registered_items[name] ~= nil then
 228                 core.log("warning", "Not registering alias, item with same name" ..
 229                         " is already defined: " .. name .. " -> " .. convert_to)
 230         else
 231                 --core.log("Registering alias: " .. name .. " -> " .. convert_to)
 232                 core.registered_aliases[name] = convert_to
 233                 register_alias_raw(name, convert_to)
 234         end
 235 end
 236
 237 function core.on_craft(itemstack, player, old_craft_list, craft_inv)
 238         for _, func in ipairs(core.registered_on_crafts) do
 239                 itemstack = func(itemstack, player, old_craft_list, craft_inv) or itemstack
 240         end
 241         return itemstack
 242 end
 243
 244 function core.craft_predict(itemstack, player, old_craft_list, craft_inv)
 245         for _, func in ipairs(core.registered_craft_predicts) do
 246                 itemstack = func(itemstack, player, old_craft_list, craft_inv) or itemstack
 247         end
 248         return itemstack
 249 end
 250
 251 -- Alias the forbidden item names to "" so they can't be
 252 -- created via itemstrings (e.g. /give)
 253 local name
 254 for name in pairs(forbidden_item_names) do
 255         core.registered_aliases[name] = ""
 256         register_alias_raw(name, "")
 257 end
 258
 259
 260 -- Deprecated:
 261 -- Aliases for core.register_alias (how ironic...)
 262 --core.alias_node = core.register_alias
 263 --core.alias_tool = core.register_alias
 264 --core.alias_craftitem = core.register_alias
 265
 266 --
 267 -- Built-in node definitions. Also defined in C.
 268 --
 269
 270 core.register_item(":unknown", {
 271         type = "none",
 272         description = "Unknown Item",
 273         inventory_image = "unknown_item.png",
 274         on_place = core.item_place,
 275         on_drop = core.item_drop,
 276         groups = {not_in_creative_inventory=1},
 277         diggable = true,
 278 })
 279
 280 core.register_node(":air", {
 281         description = "Air (you hacker you!)",
 282         inventory_image = "unknown_node.png",
 283         wield_image = "unknown_node.png",
 284         drawtype = "airlike",
 285         paramtype = "light",
 286         sunlight_propagates = true,
 287         walkable = false,
 288         pointable = false,
 289         diggable = false,
 290         buildable_to = true,
 291         air_equivalent = true,
 292         drop = "",
 293         groups = {not_in_creative_inventory=1},
 294 })
 295
 296 core.register_node(":ignore", {
 297         description = "Ignore (you hacker you!)",
 298         inventory_image = "unknown_node.png",
 299         wield_image = "unknown_node.png",
 300         drawtype = "airlike",
 301         paramtype = "none",
 302         sunlight_propagates = false,
 303         walkable = false,
 304         pointable = false,
 305         diggable = false,
 306         buildable_to = true, -- A way to remove accidentally placed ignores
 307         air_equivalent = true,
 308         drop = "",
 309         groups = {not_in_creative_inventory=1},
 310 })
 311
 312 -- The hand (bare definition)
 313 core.register_item(":", {
 314         type = "none",
 315         groups = {not_in_creative_inventory=1},
 316 })
 317
 318
 319 function core.override_item(name, redefinition)
 320         if redefinition.name ~= nil then
 321                 error("Attempt to redefine name of "..name.." to "..dump(redefinition.name), 2)
 322         end
 323         if redefinition.type ~= nil then
 324                 error("Attempt to redefine type of "..name.." to "..dump(redefinition.type), 2)
 325         end
 326         local item = core.registered_items[name]
 327         if not item then
 328                 error("Attempt to override non-existent item "..name, 2)
 329         end
 330         for k, v in pairs(redefinition) do
 331                 rawset(item, k, v)
 332         end
 333         register_item_raw(item)
 334 end
 335
 336
 337 core.callback_origins = {}
 338
 339 function core.run_callbacks(callbacks, mode, ...)
 340         assert(type(callbacks) == "table")
 341         local cb_len = #callbacks
 342         if cb_len == 0 then
 343                 if mode == 2 or mode == 3 then
 344                         return true
 345                 elseif mode == 4 or mode == 5 then
 346                         return false
 347                 end
 348         end
 349         local ret = nil
 350         for i = 1, cb_len do
 351                 local origin = core.callback_origins[callbacks[i]]
 352                 if origin then
 353                         core.set_last_run_mod(origin.mod)
 354                         --print("Running " .. tostring(callbacks[i]) ..
 355                         --      " (a " .. origin.name .. " callback in " .. origin.mod .. ")")
 356                 else
 357                         --print("No data associated with callback")
 358                 end
 359                 local cb_ret = callbacks[i](...)
 360
 361                 if mode == 0 and i == 1 then
 362                         ret = cb_ret
 363                 elseif mode == 1 and i == cb_len then
 364                         ret = cb_ret
 365                 elseif mode == 2 then
 366                         if not cb_ret or i == 1 then
 367                                 ret = cb_ret
 368                         end
 369                 elseif mode == 3 then
 370                         if cb_ret then
 371                                 return cb_ret
 372                         end
 373                         ret = cb_ret
 374                 elseif mode == 4 then
 375                         if (cb_ret and not ret) or i == 1 then
 376                                 ret = cb_ret
 377                         end
 378                 elseif mode == 5 and cb_ret then
 379                         return cb_ret
 380                 end
 381         end
 382         return ret
 383 end
 384
 385 --
 386 -- Callback registration
 387 --
 388
 389 local function make_registration()
 390         local t = {}
 391         local registerfunc = function(func)
 392                 table.insert(t, func)
 393                 core.callback_origins[func] = {
 394                         mod = core.get_current_modname() or "??",
 395                         name = debug.getinfo(1, "n").name or "??"
 396                 }
 397                 --local origin = core.callback_origins[func]
 398                 --print(origin.name .. ": " .. origin.mod .. " registering cbk " .. tostring(func))
 399         end
 400         return t, registerfunc
 401 end
 402
 403 local function make_registration_reverse()
 404         local t = {}
 405         local registerfunc = function(func)
 406                 table.insert(t, 1, func)
 407                 core.callback_origins[func] = {
 408                         mod = core.get_current_modname() or "??",
 409                         name = debug.getinfo(1, "n").name or "??"
 410                 }
 411                 --local origin = core.callback_origins[func]
 412                 --print(origin.name .. ": " .. origin.mod .. " registering cbk " .. tostring(func))
 413         end
 414         return t, registerfunc
 415 end
 416
 417 local function make_registration_wrap(reg_fn_name, clear_fn_name)
 418         local list = {}
 419
 420         local orig_reg_fn = core[reg_fn_name]
 421         core[reg_fn_name] = function(def)
 422                 local retval = orig_reg_fn(def)
 423                 if retval ~= nil then
 424                         if def.name ~= nil then
 425                                 list[def.name] = def
 426                         else
 427                                 list[retval] = def
 428                         end
 429                 end
 430                 return retval
 431         end
 432
 433         local orig_clear_fn = core[clear_fn_name]
 434         core[clear_fn_name] = function()
 435                 for k in pairs(list) do
 436                         list[k] = nil
 437                 end
 438                 return orig_clear_fn()
 439         end
 440
 441         return list
 442 end
 443
 444 core.registered_on_player_hpchanges = { modifiers = { }, loggers = { } }
 445
 446 function core.registered_on_player_hpchange(player, hp_change)
 447         local last = false
 448         for i = #core.registered_on_player_hpchanges.modifiers, 1, -1 do
 449                 local func = core.registered_on_player_hpchanges.modifiers[i]
 450                 hp_change, last = func(player, hp_change)
 451                 if type(hp_change) ~= "number" then
 452                         local debuginfo = debug.getinfo(func)
 453                         error("The register_on_hp_changes function has to return a number at " ..
 454                                 debuginfo.short_src .. " line " .. debuginfo.linedefined)
 455                 end
 456                 if last then
 457                         break
 458                 end
 459         end
 460         for i, func in ipairs(core.registered_on_player_hpchanges.loggers) do
 461                 func(player, hp_change)
 462         end
 463         return hp_change
 464 end
 465
 466 function core.register_on_player_hpchange(func, modifier)
 467         if modifier then
 468                 table.insert(core.registered_on_player_hpchanges.modifiers, func)
 469         else
 470                 table.insert(core.registered_on_player_hpchanges.loggers, func)
 471         end
 472         core.callback_origins[func] = {
 473                 mod = core.get_current_modname() or "??",
 474                 name = debug.getinfo(1, "n").name or "??"
 475         }
 476 end
 477
 478 core.registered_biomes      = make_registration_wrap("register_biome",      "clear_registered_biomes")
 479 core.registered_ores        = make_registration_wrap("register_ore",        "clear_registered_ores")
 480 core.registered_decorations = make_registration_wrap("register_decoration", "clear_registered_decorations")
 481
 482 core.registered_on_chat_messages, core.register_on_chat_message = make_registration()
 483 core.registered_globalsteps, core.register_globalstep = make_registration()
 484 core.registered_playerevents, core.register_playerevent = make_registration()
 485 core.registered_on_shutdown, core.register_on_shutdown = make_registration()
 486 core.registered_on_punchnodes, core.register_on_punchnode = make_registration()
 487 core.registered_on_placenodes, core.register_on_placenode = make_registration()
 488 core.registered_on_dignodes, core.register_on_dignode = make_registration()
 489 core.registered_on_generateds, core.register_on_generated = make_registration()
 490 core.registered_on_newplayers, core.register_on_newplayer = make_registration()
 491 core.registered_on_dieplayers, core.register_on_dieplayer = make_registration()
 492 core.registered_on_respawnplayers, core.register_on_respawnplayer = make_registration()
 493 core.registered_on_prejoinplayers, core.register_on_prejoinplayer = make_registration()
 494 core.registered_on_joinplayers, core.register_on_joinplayer = make_registration()
 495 core.registered_on_leaveplayers, core.register_on_leaveplayer = make_registration()
 496 core.registered_on_player_receive_fields, core.register_on_player_receive_fields = make_registration_reverse()
 497 core.registered_on_cheats, core.register_on_cheat = make_registration()
 498 core.registered_on_crafts, core.register_on_craft = make_registration()
 499 core.registered_craft_predicts, core.register_craft_predict = make_registration()
 500 core.registered_on_protection_violation, core.register_on_protection_violation = make_registration()
 501 core.registered_on_item_eats, core.register_on_item_eat = make_registration()
 502 core.registered_on_punchplayers, core.register_on_punchplayer = make_registration()
 503
 504 --
 505 -- Compatibility for on_mapgen_init()
 506 --
 507
 508 core.register_on_mapgen_init = function(func) func(core.get_mapgen_params()) end
 509