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