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         -- This isn't just legacy, but more of a convenience feature
 260         local toolcaps = tooldef.tool_capabilities
 261         if toolcaps and toolcaps.punch_attack_uses == nil then
 262                 for _, cap in pairs(toolcaps.groupcaps or {}) do
 263                         local level = (cap.maxlevel or 0) - 1
 264                         if (cap.uses or 0) ~= 0 and level >= 0 then
 265                                 toolcaps.punch_attack_uses = cap.uses * (3 ^ level)
 266                                 break
 267                         end
 268                 end
 269         end
 270
 271         core.register_item(name, tooldef)
 272 end
 273
 274 function core.register_alias(name, convert_to)
 275         if forbidden_item_names[name] then
 276                 error("Unable to register alias: Name is forbidden: " .. name)
 277         end
 278         if core.registered_items[name] ~= nil then
 279                 core.log("warning", "Not registering alias, item with same name" ..
 280                         " is already defined: " .. name .. " -> " .. convert_to)
 281         else
 282                 --core.log("Registering alias: " .. name .. " -> " .. convert_to)
 283                 core.registered_aliases[name] = convert_to
 284                 register_alias_raw(name, convert_to)
 285         end
 286 end
 287
 288 function core.register_alias_force(name, convert_to)
 289         if forbidden_item_names[name] then
 290                 error("Unable to register alias: Name is forbidden: " .. name)
 291         end
 292         if core.registered_items[name] ~= nil then
 293                 core.unregister_item(name)
 294                 core.log("info", "Removed item " ..name..
 295                         " while attempting to force add an alias")
 296         end
 297         --core.log("Registering alias: " .. name .. " -> " .. convert_to)
 298         core.registered_aliases[name] = convert_to
 299         register_alias_raw(name, convert_to)
 300 end
 301
 302 function core.on_craft(itemstack, player, old_craft_list, craft_inv)
 303         for _, func in ipairs(core.registered_on_crafts) do
 304                 itemstack = func(itemstack, player, old_craft_list, craft_inv) or itemstack
 305         end
 306         return itemstack
 307 end
 308
 309 function core.craft_predict(itemstack, player, old_craft_list, craft_inv)
 310         for _, func in ipairs(core.registered_craft_predicts) do
 311                 itemstack = func(itemstack, player, old_craft_list, craft_inv) or itemstack
 312         end
 313         return itemstack
 314 end
 315
 316 -- Alias the forbidden item names to "" so they can't be
 317 -- created via itemstrings (e.g. /give)
 318 for name in pairs(forbidden_item_names) do
 319         core.registered_aliases[name] = ""
 320         register_alias_raw(name, "")
 321 end
 322
 323
 324 -- Deprecated:
 325 -- Aliases for core.register_alias (how ironic...)
 326 --core.alias_node = core.register_alias
 327 --core.alias_tool = core.register_alias
 328 --core.alias_craftitem = core.register_alias
 329
 330 --
 331 -- Built-in node definitions. Also defined in C.
 332 --
 333
 334 core.register_item(":unknown", {
 335         type = "none",
 336         description = "Unknown Item",
 337         inventory_image = "unknown_item.png",
 338         on_place = core.item_place,
 339         on_secondary_use = core.item_secondary_use,
 340         on_drop = core.item_drop,
 341         groups = {not_in_creative_inventory=1},
 342         diggable = true,
 343 })
 344
 345 core.register_node(":air", {
 346         description = "Air",
 347         inventory_image = "air.png",
 348         wield_image = "air.png",
 349         drawtype = "airlike",
 350         paramtype = "light",
 351         sunlight_propagates = true,
 352         walkable = false,
 353         pointable = false,
 354         diggable = false,
 355         buildable_to = true,
 356         floodable = true,
 357         air_equivalent = true,
 358         drop = "",
 359         groups = {not_in_creative_inventory=1},
 360 })
 361
 362 core.register_node(":ignore", {
 363         description = "Ignore",
 364         inventory_image = "ignore.png",
 365         wield_image = "ignore.png",
 366         drawtype = "airlike",
 367         paramtype = "none",
 368         sunlight_propagates = false,
 369         walkable = false,
 370         pointable = false,
 371         diggable = false,
 372         buildable_to = true, -- A way to remove accidentally placed ignores
 373         air_equivalent = true,
 374         drop = "",
 375         groups = {not_in_creative_inventory=1},
 376         on_place = function(itemstack, placer, pointed_thing)
 377                 core.chat_send_player(
 378                                 placer:get_player_name(),
 379                                 core.colorize("#FF0000",
 380                                 "You can't place 'ignore' nodes!"))
 381                 return ""
 382         end,
 383 })
 384
 385 -- The hand (bare definition)
 386 core.register_item(":", {
 387         type = "none",
 388         wield_image = "wieldhand.png",
 389         groups = {not_in_creative_inventory=1},
 390 })
 391
 392
 393 function core.override_item(name, redefinition)
 394         if redefinition.name ~= nil then
 395                 error("Attempt to redefine name of "..name.." to "..dump(redefinition.name), 2)
 396         end
 397         if redefinition.type ~= nil then
 398                 error("Attempt to redefine type of "..name.." to "..dump(redefinition.type), 2)
 399         end
 400         local item = core.registered_items[name]
 401         if not item then
 402                 error("Attempt to override non-existent item "..name, 2)
 403         end
 404         for k, v in pairs(redefinition) do
 405                 rawset(item, k, v)
 406         end
 407         register_item_raw(item)
 408 end
 409
 410
 411 core.callback_origins = {}
 412
 413 function core.run_callbacks(callbacks, mode, ...)
 414         assert(type(callbacks) == "table")
 415         local cb_len = #callbacks
 416         if cb_len == 0 then
 417                 if mode == 2 or mode == 3 then
 418                         return true
 419                 elseif mode == 4 or mode == 5 then
 420                         return false
 421                 end
 422         end
 423         local ret = nil
 424         for i = 1, cb_len do
 425                 local origin = core.callback_origins[callbacks[i]]
 426                 if origin then
 427                         core.set_last_run_mod(origin.mod)
 428                 end
 429                 local cb_ret = callbacks[i](...)
 430
 431                 if mode == 0 and i == 1 then
 432                         ret = cb_ret
 433                 elseif mode == 1 and i == cb_len then
 434                         ret = cb_ret
 435                 elseif mode == 2 then
 436                         if not cb_ret or i == 1 then
 437                                 ret = cb_ret
 438                         end
 439                 elseif mode == 3 then
 440                         if cb_ret then
 441                                 return cb_ret
 442                         end
 443                         ret = cb_ret
 444                 elseif mode == 4 then
 445                         if (cb_ret and not ret) or i == 1 then
 446                                 ret = cb_ret
 447                         end
 448                 elseif mode == 5 and cb_ret then
 449                         return cb_ret
 450                 end
 451         end
 452         return ret
 453 end
 454
 455 function core.run_priv_callbacks(name, priv, caller, method)
 456         local def = core.registered_privileges[priv]
 457         if not def or not def["on_" .. method] or
 458                         not def["on_" .. method](name, caller) then
 459                 for _, func in ipairs(core["registered_on_priv_" .. method]) do
 460                         if not func(name, caller, priv) then
 461                                 break
 462                         end
 463                 end
 464         end
 465 end
 466
 467 --
 468 -- Callback registration
 469 --
 470
 471 local function make_registration()
 472         local t = {}
 473         local registerfunc = function(func)
 474                 t[#t + 1] = func
 475                 core.callback_origins[func] = {
 476                         mod = core.get_current_modname() or "??",
 477                         name = debug.getinfo(1, "n").name or "??"
 478                 }
 479                 --local origin = core.callback_origins[func]
 480                 --print(origin.name .. ": " .. origin.mod .. " registering cbk " .. tostring(func))
 481         end
 482         return t, registerfunc
 483 end
 484
 485 local function make_registration_reverse()
 486         local t = {}
 487         local registerfunc = function(func)
 488                 table.insert(t, 1, func)
 489                 core.callback_origins[func] = {
 490                         mod = core.get_current_modname() or "??",
 491                         name = debug.getinfo(1, "n").name or "??"
 492                 }
 493                 --local origin = core.callback_origins[func]
 494                 --print(origin.name .. ": " .. origin.mod .. " registering cbk " .. tostring(func))
 495         end
 496         return t, registerfunc
 497 end
 498
 499 local function make_registration_wrap(reg_fn_name, clear_fn_name)
 500         local list = {}
 501
 502         local orig_reg_fn = core[reg_fn_name]
 503         core[reg_fn_name] = function(def)
 504                 local retval = orig_reg_fn(def)
 505                 if retval ~= nil then
 506                         if def.name ~= nil then
 507                                 list[def.name] = def
 508                         else
 509                                 list[retval] = def
 510                         end
 511                 end
 512                 return retval
 513         end
 514
 515         local orig_clear_fn = core[clear_fn_name]
 516         core[clear_fn_name] = function()
 517                 for k in pairs(list) do
 518                         list[k] = nil
 519                 end
 520                 return orig_clear_fn()
 521         end
 522
 523         return list
 524 end
 525
 526 local function make_wrap_deregistration(reg_fn, clear_fn, list)
 527         local unregister = function (key)
 528                 if type(key) ~= "string" then
 529                         error("key is not a string", 2)
 530                 end
 531                 if not list[key] then
 532                         error("Attempt to unregister non-existent element - '" .. key .. "'", 2)
 533                 end
 534                 local temporary_list = table.copy(list)
 535                 clear_fn()
 536                 for k,v in pairs(temporary_list) do
 537                         if key ~= k then
 538                                 reg_fn(v)
 539                         end
 540                 end
 541         end
 542         return unregister
 543 end
 544
 545 core.registered_on_player_hpchanges = { modifiers = { }, loggers = { } }
 546
 547 function core.registered_on_player_hpchange(player, hp_change, reason)
 548         local last
 549         for i = #core.registered_on_player_hpchanges.modifiers, 1, -1 do
 550                 local func = core.registered_on_player_hpchanges.modifiers[i]
 551                 hp_change, last = func(player, hp_change, reason)
 552                 if type(hp_change) ~= "number" then
 553                         local debuginfo = debug.getinfo(func)
 554                         error("The register_on_hp_changes function has to return a number at " ..
 555                                 debuginfo.short_src .. " line " .. debuginfo.linedefined)
 556                 end
 557                 if last then
 558                         break
 559                 end
 560         end
 561         for i, func in ipairs(core.registered_on_player_hpchanges.loggers) do
 562                 func(player, hp_change, reason)
 563         end
 564         return hp_change
 565 end
 566
 567 function core.register_on_player_hpchange(func, modifier)
 568         if modifier then
 569                 core.registered_on_player_hpchanges.modifiers[#core.registered_on_player_hpchanges.modifiers + 1] = func
 570         else
 571                 core.registered_on_player_hpchanges.loggers[#core.registered_on_player_hpchanges.loggers + 1] = func
 572         end
 573         core.callback_origins[func] = {
 574                 mod = core.get_current_modname() or "??",
 575                 name = debug.getinfo(1, "n").name or "??"
 576         }
 577 end
 578
 579 core.registered_biomes      = make_registration_wrap("register_biome",      "clear_registered_biomes")
 580 core.registered_ores        = make_registration_wrap("register_ore",        "clear_registered_ores")
 581 core.registered_decorations = make_registration_wrap("register_decoration", "clear_registered_decorations")
 582
 583 core.unregister_biome = make_wrap_deregistration(core.register_biome,
 584                 core.clear_registered_biomes, core.registered_biomes)
 585
 586 core.registered_on_chat_messages, core.register_on_chat_message = make_registration()
 587 core.registered_globalsteps, core.register_globalstep = make_registration()
 588 core.registered_playerevents, core.register_playerevent = make_registration()
 589 core.registered_on_mods_loaded, core.register_on_mods_loaded = make_registration()
 590 core.registered_on_shutdown, core.register_on_shutdown = make_registration()
 591 core.registered_on_punchnodes, core.register_on_punchnode = make_registration()
 592 core.registered_on_placenodes, core.register_on_placenode = make_registration()
 593 core.registered_on_dignodes, core.register_on_dignode = make_registration()
 594 core.registered_on_generateds, core.register_on_generated = make_registration()
 595 core.registered_on_newplayers, core.register_on_newplayer = make_registration()
 596 core.registered_on_dieplayers, core.register_on_dieplayer = make_registration()
 597 core.registered_on_respawnplayers, core.register_on_respawnplayer = make_registration()
 598 core.registered_on_prejoinplayers, core.register_on_prejoinplayer = make_registration()
 599 core.registered_on_joinplayers, core.register_on_joinplayer = make_registration()
 600 core.registered_on_leaveplayers, core.register_on_leaveplayer = make_registration()
 601 core.registered_on_player_receive_fields, core.register_on_player_receive_fields = make_registration_reverse()
 602 core.registered_on_cheats, core.register_on_cheat = make_registration()
 603 core.registered_on_crafts, core.register_on_craft = make_registration()
 604 core.registered_craft_predicts, core.register_craft_predict = make_registration()
 605 core.registered_on_protection_violation, core.register_on_protection_violation = make_registration()
 606 core.registered_on_item_eats, core.register_on_item_eat = make_registration()
 607 core.registered_on_punchplayers, core.register_on_punchplayer = make_registration()
 608 core.registered_on_priv_grant, core.register_on_priv_grant = make_registration()
 609 core.registered_on_priv_revoke, core.register_on_priv_revoke = make_registration()
 610 core.registered_can_bypass_userlimit, core.register_can_bypass_userlimit = make_registration()
 611 core.registered_on_modchannel_message, core.register_on_modchannel_message = make_registration()
 612 core.registered_on_auth_fail, core.register_on_auth_fail = make_registration()
 613 core.registered_on_player_inventory_actions, core.register_on_player_inventory_action = make_registration()
 614 core.registered_allow_player_inventory_actions, core.register_allow_player_inventory_action = make_registration()
 615
 616 --
 617 -- Compatibility for on_mapgen_init()
 618 --
 619
 620 core.register_on_mapgen_init = function(func) func(core.get_mapgen_params()) end