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