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