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