1 -- Minetest: builtin/misc_register.lua
4 -- Make raw registration functions inaccessible to anyone except this file
7 local register_item_raw = core.register_item_raw
8 core.register_item_raw = nil
10 local unregister_item_raw = core.unregister_item_raw
11 core.unregister_item_raw = nil
13 local register_alias_raw = core.register_alias_raw
14 core.register_alias_raw = nil
17 -- Item / entity / ABM / LBM registration functions
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 = {}
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])
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)
41 -- These item names may not be used because they would interfere
42 -- with legacy itemstrings
43 local forbidden_item_names = {
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
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")
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")
80 function core.register_abm(spec)
81 -- Add to core.registered_abms
82 core.registered_abms[#core.registered_abms + 1] = spec
83 spec.mod_origin = core.get_current_modname() or "??"
86 function core.register_lbm(spec)
87 -- Add to core.registered_lbms
88 check_modname_prefix(spec.name)
89 core.registered_lbms[#core.registered_lbms + 1] = spec
90 spec.mod_origin = core.get_current_modname() or "??"
93 function core.register_entity(name, prototype)
96 error("Unable to register entity: Name is nil")
98 name = check_modname_prefix(tostring(name))
100 prototype.name = name
101 prototype.__index = prototype -- so that it can be used as a metatable
103 -- Add to core.registered_entities
104 core.registered_entities[name] = prototype
105 prototype.mod_origin = core.get_current_modname() or "??"
108 function core.register_item(name, itemdef)
111 error("Unable to register item: Name is nil")
113 name = check_modname_prefix(tostring(name))
114 if forbidden_item_names[name] then
115 error("Unable to register item: Name is forbidden: " .. name)
119 local is_overriding = core.registered_items[name]
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 = {
129 fixed = {-1/8, -1/2, -1/8, 1/8, 1/2, 1/8},
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)
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})
148 error("Unable to register item: Type is invalid: " .. dump(itemdef))
151 -- Flowing liquid uses param2
152 if itemdef.type == "node" and itemdef.liquidtype == "flowing" then
153 itemdef.paramtype2 = "flowingliquid"
156 -- BEGIN Legacy stuff
157 if itemdef.cookresult_itemstring ~= nil and itemdef.cookresult_itemstring ~= "" then
158 core.register_craft({
160 output=itemdef.cookresult_itemstring,
162 cooktime=itemdef.furnace_cooktime
165 if itemdef.furnace_burntime ~= nil and itemdef.furnace_burntime >= 0 then
166 core.register_craft({
169 burntime=itemdef.furnace_burntime
174 itemdef.mod_origin = core.get_current_modname() or "??"
176 -- Disable all further modifications
177 getmetatable(itemdef).__newindex = {}
179 --core.log("Registering item: " .. itemdef.name)
180 core.registered_items[itemdef.name] = itemdef
181 core.registered_aliases[itemdef.name] = nil
183 -- Used to allow builtin to register ignore to registered_items
184 if name ~= "ignore" then
185 register_item_raw(itemdef)
186 elseif is_overriding then
187 core.log("warning", "Attempted redefinition of \"ignore\"")
191 function core.unregister_item(name)
192 if not core.registered_items[name] then
193 core.log("warning", "Not unregistering item " ..name..
194 " because it doesn't exist.")
197 -- Erase from registered_* table
198 local type = core.registered_items[name].type
199 if type == "node" then
200 core.registered_nodes[name] = nil
201 elseif type == "craft" then
202 core.registered_craftitems[name] = nil
203 elseif type == "tool" then
204 core.registered_tools[name] = nil
206 core.registered_items[name] = nil
209 unregister_item_raw(name)
212 function core.register_node(name, nodedef)
213 nodedef.type = "node"
214 core.register_item(name, nodedef)
217 function core.register_craftitem(name, craftitemdef)
218 craftitemdef.type = "craft"
220 -- BEGIN Legacy stuff
221 if craftitemdef.inventory_image == nil and craftitemdef.image ~= nil then
222 craftitemdef.inventory_image = craftitemdef.image
226 core.register_item(name, craftitemdef)
229 function core.register_tool(name, tooldef)
230 tooldef.type = "tool"
231 tooldef.stack_max = 1
233 -- BEGIN Legacy stuff
234 if tooldef.inventory_image == nil and tooldef.image ~= nil then
235 tooldef.inventory_image = tooldef.image
237 if tooldef.tool_capabilities == nil and
238 (tooldef.full_punch_interval ~= nil or
239 tooldef.basetime ~= nil or
240 tooldef.dt_weight ~= nil or
241 tooldef.dt_crackiness ~= nil or
242 tooldef.dt_crumbliness ~= nil or
243 tooldef.dt_cuttability ~= nil or
244 tooldef.basedurability ~= nil or
245 tooldef.dd_weight ~= nil or
246 tooldef.dd_crackiness ~= nil or
247 tooldef.dd_crumbliness ~= nil or
248 tooldef.dd_cuttability ~= nil) then
249 tooldef.tool_capabilities = {
250 full_punch_interval = tooldef.full_punch_interval,
251 basetime = tooldef.basetime,
252 dt_weight = tooldef.dt_weight,
253 dt_crackiness = tooldef.dt_crackiness,
254 dt_crumbliness = tooldef.dt_crumbliness,
255 dt_cuttability = tooldef.dt_cuttability,
256 basedurability = tooldef.basedurability,
257 dd_weight = tooldef.dd_weight,
258 dd_crackiness = tooldef.dd_crackiness,
259 dd_crumbliness = tooldef.dd_crumbliness,
260 dd_cuttability = tooldef.dd_cuttability,
265 core.register_item(name, tooldef)
268 function core.register_alias(name, convert_to)
269 if forbidden_item_names[name] then
270 error("Unable to register alias: Name is forbidden: " .. name)
272 if core.registered_items[name] ~= nil then
273 core.log("warning", "Not registering alias, item with same name" ..
274 " is already defined: " .. name .. " -> " .. convert_to)
276 --core.log("Registering alias: " .. name .. " -> " .. convert_to)
277 core.registered_aliases[name] = convert_to
278 register_alias_raw(name, convert_to)
282 function core.register_alias_force(name, convert_to)
283 if forbidden_item_names[name] then
284 error("Unable to register alias: Name is forbidden: " .. name)
286 if core.registered_items[name] ~= nil then
287 core.unregister_item(name)
288 core.log("info", "Removed item " ..name..
289 " while attempting to force add an alias")
291 --core.log("Registering alias: " .. name .. " -> " .. convert_to)
292 core.registered_aliases[name] = convert_to
293 register_alias_raw(name, convert_to)
296 function core.on_craft(itemstack, player, old_craft_list, craft_inv)
297 for _, func in ipairs(core.registered_on_crafts) do
298 itemstack = func(itemstack, player, old_craft_list, craft_inv) or itemstack
303 function core.craft_predict(itemstack, player, old_craft_list, craft_inv)
304 for _, func in ipairs(core.registered_craft_predicts) do
305 itemstack = func(itemstack, player, old_craft_list, craft_inv) or itemstack
310 -- Alias the forbidden item names to "" so they can't be
311 -- created via itemstrings (e.g. /give)
313 for name in pairs(forbidden_item_names) do
314 core.registered_aliases[name] = ""
315 register_alias_raw(name, "")
320 -- Aliases for core.register_alias (how ironic...)
321 --core.alias_node = core.register_alias
322 --core.alias_tool = core.register_alias
323 --core.alias_craftitem = core.register_alias
326 -- Built-in node definitions. Also defined in C.
329 core.register_item(":unknown", {
331 description = "Unknown Item",
332 inventory_image = "unknown_item.png",
333 on_place = core.item_place,
334 on_secondary_use = core.item_secondary_use,
335 on_drop = core.item_drop,
336 groups = {not_in_creative_inventory=1},
340 core.register_node(":air", {
341 description = "Air (you hacker you!)",
342 inventory_image = "air.png",
343 wield_image = "air.png",
344 drawtype = "airlike",
346 sunlight_propagates = true,
352 air_equivalent = true,
354 groups = {not_in_creative_inventory=1},
357 core.register_node(":ignore", {
358 description = "Ignore (you hacker you!)",
359 inventory_image = "ignore.png",
360 wield_image = "ignore.png",
361 drawtype = "airlike",
363 sunlight_propagates = false,
367 buildable_to = true, -- A way to remove accidentally placed ignores
368 air_equivalent = true,
370 groups = {not_in_creative_inventory=1},
373 -- The hand (bare definition)
374 core.register_item(":", {
376 groups = {not_in_creative_inventory=1},
380 function core.override_item(name, redefinition)
381 if redefinition.name ~= nil then
382 error("Attempt to redefine name of "..name.." to "..dump(redefinition.name), 2)
384 if redefinition.type ~= nil then
385 error("Attempt to redefine type of "..name.." to "..dump(redefinition.type), 2)
387 local item = core.registered_items[name]
389 error("Attempt to override non-existent item "..name, 2)
391 for k, v in pairs(redefinition) do
394 register_item_raw(item)
398 core.callback_origins = {}
400 function core.run_callbacks(callbacks, mode, ...)
401 assert(type(callbacks) == "table")
402 local cb_len = #callbacks
404 if mode == 2 or mode == 3 then
406 elseif mode == 4 or mode == 5 then
412 local origin = core.callback_origins[callbacks[i]]
414 core.set_last_run_mod(origin.mod)
415 --print("Running " .. tostring(callbacks[i]) ..
416 -- " (a " .. origin.name .. " callback in " .. origin.mod .. ")")
418 --print("No data associated with callback")
420 local cb_ret = callbacks[i](...)
422 if mode == 0 and i == 1 then
424 elseif mode == 1 and i == cb_len then
426 elseif mode == 2 then
427 if not cb_ret or i == 1 then
430 elseif mode == 3 then
435 elseif mode == 4 then
436 if (cb_ret and not ret) or i == 1 then
439 elseif mode == 5 and cb_ret then
446 function core.run_priv_callbacks(name, priv, caller, method)
447 local def = core.registered_privileges[priv]
448 if not def or not def["on_" .. method] or
449 not def[priv]["on_" .. method](name, caller) then
450 for _, func in ipairs(core["registered_on_priv_" .. method]) do
451 if not func(name, caller, priv) then
459 -- Callback registration
462 local function make_registration()
464 local registerfunc = function(func)
466 core.callback_origins[func] = {
467 mod = core.get_current_modname() or "??",
468 name = debug.getinfo(1, "n").name or "??"
470 --local origin = core.callback_origins[func]
471 --print(origin.name .. ": " .. origin.mod .. " registering cbk " .. tostring(func))
473 return t, registerfunc
476 local function make_registration_reverse()
478 local registerfunc = function(func)
479 table.insert(t, 1, func)
480 core.callback_origins[func] = {
481 mod = core.get_current_modname() or "??",
482 name = debug.getinfo(1, "n").name or "??"
484 --local origin = core.callback_origins[func]
485 --print(origin.name .. ": " .. origin.mod .. " registering cbk " .. tostring(func))
487 return t, registerfunc
490 local function make_registration_wrap(reg_fn_name, clear_fn_name)
493 local orig_reg_fn = core[reg_fn_name]
494 core[reg_fn_name] = function(def)
495 local retval = orig_reg_fn(def)
496 if retval ~= nil then
497 if def.name ~= nil then
506 local orig_clear_fn = core[clear_fn_name]
507 core[clear_fn_name] = function()
508 for k in pairs(list) do
511 return orig_clear_fn()
517 local function make_wrap_deregistration(reg_fn, clear_fn, list)
518 local unregister = function (unregistered_key)
519 local temporary_list = table.copy(list)
521 for k,v in pairs(temporary_list) do
522 if unregistered_key ~= k then
530 core.registered_on_player_hpchanges = { modifiers = { }, loggers = { } }
532 function core.registered_on_player_hpchange(player, hp_change)
534 for i = #core.registered_on_player_hpchanges.modifiers, 1, -1 do
535 local func = core.registered_on_player_hpchanges.modifiers[i]
536 hp_change, last = func(player, hp_change)
537 if type(hp_change) ~= "number" then
538 local debuginfo = debug.getinfo(func)
539 error("The register_on_hp_changes function has to return a number at " ..
540 debuginfo.short_src .. " line " .. debuginfo.linedefined)
546 for i, func in ipairs(core.registered_on_player_hpchanges.loggers) do
547 func(player, hp_change)
552 function core.register_on_player_hpchange(func, modifier)
554 core.registered_on_player_hpchanges.modifiers[#core.registered_on_player_hpchanges.modifiers + 1] = func
556 core.registered_on_player_hpchanges.loggers[#core.registered_on_player_hpchanges.loggers + 1] = func
558 core.callback_origins[func] = {
559 mod = core.get_current_modname() or "??",
560 name = debug.getinfo(1, "n").name or "??"
564 core.registered_biomes = make_registration_wrap("register_biome", "clear_registered_biomes")
565 core.registered_ores = make_registration_wrap("register_ore", "clear_registered_ores")
566 core.registered_decorations = make_registration_wrap("register_decoration", "clear_registered_decorations")
568 core.unregister_biome = make_wrap_deregistration(core.register_biome, core.clear_registered_biomes, core.registered_biomes)
570 core.registered_on_chat_messages, core.register_on_chat_message = make_registration()
571 core.registered_globalsteps, core.register_globalstep = make_registration()
572 core.registered_playerevents, core.register_playerevent = make_registration()
573 core.registered_on_shutdown, core.register_on_shutdown = make_registration()
574 core.registered_on_punchnodes, core.register_on_punchnode = make_registration()
575 core.registered_on_placenodes, core.register_on_placenode = make_registration()
576 core.registered_on_dignodes, core.register_on_dignode = make_registration()
577 core.registered_on_generateds, core.register_on_generated = make_registration()
578 core.registered_on_newplayers, core.register_on_newplayer = make_registration()
579 core.registered_on_dieplayers, core.register_on_dieplayer = make_registration()
580 core.registered_on_respawnplayers, core.register_on_respawnplayer = make_registration()
581 core.registered_on_prejoinplayers, core.register_on_prejoinplayer = make_registration()
582 core.registered_on_joinplayers, core.register_on_joinplayer = make_registration()
583 core.registered_on_leaveplayers, core.register_on_leaveplayer = make_registration()
584 core.registered_on_player_receive_fields, core.register_on_player_receive_fields = make_registration_reverse()
585 core.registered_on_cheats, core.register_on_cheat = make_registration()
586 core.registered_on_crafts, core.register_on_craft = make_registration()
587 core.registered_craft_predicts, core.register_craft_predict = make_registration()
588 core.registered_on_protection_violation, core.register_on_protection_violation = make_registration()
589 core.registered_on_item_eats, core.register_on_item_eat = make_registration()
590 core.registered_on_punchplayers, core.register_on_punchplayer = make_registration()
591 core.registered_on_priv_grant, core.register_on_priv_grant = make_registration()
592 core.registered_on_priv_revoke, core.register_on_priv_revoke = make_registration()
593 core.registered_can_bypass_userlimit, core.register_can_bypass_userlimit = make_registration()
594 core.registered_on_modchannel_message, core.register_on_modchannel_message = make_registration()
595 core.registered_on_auth_fail, core.register_on_auth_fail = make_registration()
598 -- Compatibility for on_mapgen_init()
601 core.register_on_mapgen_init = function(func) func(core.get_mapgen_params()) end