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 -- Apply defaults and add to registered_* table
120 if itemdef.type == "node" then
121 -- Use the nodebox as selection box if it's not set manually
122 if itemdef.drawtype == "nodebox" and not itemdef.selection_box then
123 itemdef.selection_box = itemdef.node_box
124 elseif itemdef.drawtype == "fencelike" and not itemdef.selection_box then
125 itemdef.selection_box = {
127 fixed = {-1/8, -1/2, -1/8, 1/8, 1/2, 1/8},
130 if itemdef.light_source and itemdef.light_source > core.LIGHT_MAX then
131 itemdef.light_source = core.LIGHT_MAX
132 core.log("warning", "Node 'light_source' value exceeds maximum," ..
133 " limiting to maximum: " ..name)
135 setmetatable(itemdef, {__index = core.nodedef_default})
136 core.registered_nodes[itemdef.name] = itemdef
137 elseif itemdef.type == "craft" then
138 setmetatable(itemdef, {__index = core.craftitemdef_default})
139 core.registered_craftitems[itemdef.name] = itemdef
140 elseif itemdef.type == "tool" then
141 setmetatable(itemdef, {__index = core.tooldef_default})
142 core.registered_tools[itemdef.name] = itemdef
143 elseif itemdef.type == "none" then
144 setmetatable(itemdef, {__index = core.noneitemdef_default})
146 error("Unable to register item: Type is invalid: " .. dump(itemdef))
149 -- Flowing liquid uses param2
150 if itemdef.type == "node" and itemdef.liquidtype == "flowing" then
151 itemdef.paramtype2 = "flowingliquid"
154 -- BEGIN Legacy stuff
155 if itemdef.cookresult_itemstring ~= nil and itemdef.cookresult_itemstring ~= "" then
156 core.register_craft({
158 output=itemdef.cookresult_itemstring,
160 cooktime=itemdef.furnace_cooktime
163 if itemdef.furnace_burntime ~= nil and itemdef.furnace_burntime >= 0 then
164 core.register_craft({
167 burntime=itemdef.furnace_burntime
172 itemdef.mod_origin = core.get_current_modname() or "??"
174 -- Disable all further modifications
175 getmetatable(itemdef).__newindex = {}
177 --core.log("Registering item: " .. itemdef.name)
178 core.registered_items[itemdef.name] = itemdef
179 core.registered_aliases[itemdef.name] = nil
180 register_item_raw(itemdef)
183 function core.unregister_item(name)
184 if not core.registered_items[name] then
185 core.log("warning", "Not unregistering item " ..name..
186 " because it doesn't exist.")
189 -- Erase from registered_* table
190 local type = core.registered_items[name].type
191 if type == "node" then
192 core.registered_nodes[name] = nil
193 elseif type == "craft" then
194 core.registered_craftitems[name] = nil
195 elseif type == "tool" then
196 core.registered_tools[name] = nil
198 core.registered_items[name] = nil
201 unregister_item_raw(name)
204 function core.register_node(name, nodedef)
205 nodedef.type = "node"
206 core.register_item(name, nodedef)
209 function core.register_craftitem(name, craftitemdef)
210 craftitemdef.type = "craft"
212 -- BEGIN Legacy stuff
213 if craftitemdef.inventory_image == nil and craftitemdef.image ~= nil then
214 craftitemdef.inventory_image = craftitemdef.image
218 core.register_item(name, craftitemdef)
221 function core.register_tool(name, tooldef)
222 tooldef.type = "tool"
223 tooldef.stack_max = 1
225 -- BEGIN Legacy stuff
226 if tooldef.inventory_image == nil and tooldef.image ~= nil then
227 tooldef.inventory_image = tooldef.image
229 if tooldef.tool_capabilities == nil and
230 (tooldef.full_punch_interval ~= nil or
231 tooldef.basetime ~= nil or
232 tooldef.dt_weight ~= nil or
233 tooldef.dt_crackiness ~= nil or
234 tooldef.dt_crumbliness ~= nil or
235 tooldef.dt_cuttability ~= nil or
236 tooldef.basedurability ~= nil or
237 tooldef.dd_weight ~= nil or
238 tooldef.dd_crackiness ~= nil or
239 tooldef.dd_crumbliness ~= nil or
240 tooldef.dd_cuttability ~= nil) then
241 tooldef.tool_capabilities = {
242 full_punch_interval = tooldef.full_punch_interval,
243 basetime = tooldef.basetime,
244 dt_weight = tooldef.dt_weight,
245 dt_crackiness = tooldef.dt_crackiness,
246 dt_crumbliness = tooldef.dt_crumbliness,
247 dt_cuttability = tooldef.dt_cuttability,
248 basedurability = tooldef.basedurability,
249 dd_weight = tooldef.dd_weight,
250 dd_crackiness = tooldef.dd_crackiness,
251 dd_crumbliness = tooldef.dd_crumbliness,
252 dd_cuttability = tooldef.dd_cuttability,
257 core.register_item(name, tooldef)
260 function core.register_alias(name, convert_to)
261 if forbidden_item_names[name] then
262 error("Unable to register alias: Name is forbidden: " .. name)
264 if core.registered_items[name] ~= nil then
265 core.log("warning", "Not registering alias, item with same name" ..
266 " is already defined: " .. name .. " -> " .. convert_to)
268 --core.log("Registering alias: " .. name .. " -> " .. convert_to)
269 core.registered_aliases[name] = convert_to
270 register_alias_raw(name, convert_to)
274 function core.register_alias_force(name, convert_to)
275 if forbidden_item_names[name] then
276 error("Unable to register alias: Name is forbidden: " .. name)
278 if core.registered_items[name] ~= nil then
279 core.unregister_item(name)
280 core.log("info", "Removed item " ..name..
281 " while attempting to force add an alias")
283 --core.log("Registering alias: " .. name .. " -> " .. convert_to)
284 core.registered_aliases[name] = convert_to
285 register_alias_raw(name, convert_to)
288 function core.on_craft(itemstack, player, old_craft_list, craft_inv)
289 for _, func in ipairs(core.registered_on_crafts) do
290 itemstack = func(itemstack, player, old_craft_list, craft_inv) or itemstack
295 function core.craft_predict(itemstack, player, old_craft_list, craft_inv)
296 for _, func in ipairs(core.registered_craft_predicts) do
297 itemstack = func(itemstack, player, old_craft_list, craft_inv) or itemstack
302 -- Alias the forbidden item names to "" so they can't be
303 -- created via itemstrings (e.g. /give)
305 for name in pairs(forbidden_item_names) do
306 core.registered_aliases[name] = ""
307 register_alias_raw(name, "")
312 -- Aliases for core.register_alias (how ironic...)
313 --core.alias_node = core.register_alias
314 --core.alias_tool = core.register_alias
315 --core.alias_craftitem = core.register_alias
318 -- Built-in node definitions. Also defined in C.
321 core.register_item(":unknown", {
323 description = "Unknown Item",
324 inventory_image = "unknown_item.png",
325 on_place = core.item_place,
326 on_secondary_use = core.item_secondary_use,
327 on_drop = core.item_drop,
328 groups = {not_in_creative_inventory=1},
332 core.register_node(":air", {
333 description = "Air (you hacker you!)",
334 inventory_image = "air.png",
335 wield_image = "air.png",
336 drawtype = "airlike",
338 sunlight_propagates = true,
344 air_equivalent = true,
346 groups = {not_in_creative_inventory=1},
349 core.register_node(":ignore", {
350 description = "Ignore (you hacker you!)",
351 inventory_image = "ignore.png",
352 wield_image = "ignore.png",
353 drawtype = "airlike",
355 sunlight_propagates = false,
359 buildable_to = true, -- A way to remove accidentally placed ignores
360 air_equivalent = true,
362 groups = {not_in_creative_inventory=1},
365 -- The hand (bare definition)
366 core.register_item(":", {
368 groups = {not_in_creative_inventory=1},
372 function core.override_item(name, redefinition)
373 if redefinition.name ~= nil then
374 error("Attempt to redefine name of "..name.." to "..dump(redefinition.name), 2)
376 if redefinition.type ~= nil then
377 error("Attempt to redefine type of "..name.." to "..dump(redefinition.type), 2)
379 local item = core.registered_items[name]
381 error("Attempt to override non-existent item "..name, 2)
383 for k, v in pairs(redefinition) do
386 register_item_raw(item)
390 core.callback_origins = {}
392 function core.run_callbacks(callbacks, mode, ...)
393 assert(type(callbacks) == "table")
394 local cb_len = #callbacks
396 if mode == 2 or mode == 3 then
398 elseif mode == 4 or mode == 5 then
404 local origin = core.callback_origins[callbacks[i]]
406 core.set_last_run_mod(origin.mod)
407 --print("Running " .. tostring(callbacks[i]) ..
408 -- " (a " .. origin.name .. " callback in " .. origin.mod .. ")")
410 --print("No data associated with callback")
412 local cb_ret = callbacks[i](...)
414 if mode == 0 and i == 1 then
416 elseif mode == 1 and i == cb_len then
418 elseif mode == 2 then
419 if not cb_ret or i == 1 then
422 elseif mode == 3 then
427 elseif mode == 4 then
428 if (cb_ret and not ret) or i == 1 then
431 elseif mode == 5 and cb_ret then
438 function core.run_priv_callbacks(name, priv, caller, method)
439 if not core.registered_privileges[priv]["on_" .. method] or
440 core.registered_privileges[priv]["on_" .. method](name, caller) then
441 for _, func in ipairs(core["registered_on_priv_" .. method]) do
442 if not func(name, caller) then
450 -- Callback registration
453 local function make_registration()
455 local registerfunc = function(func)
457 core.callback_origins[func] = {
458 mod = core.get_current_modname() or "??",
459 name = debug.getinfo(1, "n").name or "??"
461 --local origin = core.callback_origins[func]
462 --print(origin.name .. ": " .. origin.mod .. " registering cbk " .. tostring(func))
464 return t, registerfunc
467 local function make_registration_reverse()
469 local registerfunc = function(func)
470 table.insert(t, 1, func)
471 core.callback_origins[func] = {
472 mod = core.get_current_modname() or "??",
473 name = debug.getinfo(1, "n").name or "??"
475 --local origin = core.callback_origins[func]
476 --print(origin.name .. ": " .. origin.mod .. " registering cbk " .. tostring(func))
478 return t, registerfunc
481 local function make_registration_wrap(reg_fn_name, clear_fn_name)
484 local orig_reg_fn = core[reg_fn_name]
485 core[reg_fn_name] = function(def)
486 local retval = orig_reg_fn(def)
487 if retval ~= nil then
488 if def.name ~= nil then
497 local orig_clear_fn = core[clear_fn_name]
498 core[clear_fn_name] = function()
499 for k in pairs(list) do
502 return orig_clear_fn()
508 local function make_wrap_deregistration(reg_fn, clear_fn, list)
509 local unregister = function (unregistered_key)
510 local temporary_list = table.copy(list)
512 for k,v in pairs(temporary_list) do
513 if unregistered_key ~= k then
521 core.registered_on_player_hpchanges = { modifiers = { }, loggers = { } }
523 function core.registered_on_player_hpchange(player, hp_change)
525 for i = #core.registered_on_player_hpchanges.modifiers, 1, -1 do
526 local func = core.registered_on_player_hpchanges.modifiers[i]
527 hp_change, last = func(player, hp_change)
528 if type(hp_change) ~= "number" then
529 local debuginfo = debug.getinfo(func)
530 error("The register_on_hp_changes function has to return a number at " ..
531 debuginfo.short_src .. " line " .. debuginfo.linedefined)
537 for i, func in ipairs(core.registered_on_player_hpchanges.loggers) do
538 func(player, hp_change)
543 function core.register_on_player_hpchange(func, modifier)
545 core.registered_on_player_hpchanges.modifiers[#core.registered_on_player_hpchanges.modifiers + 1] = func
547 core.registered_on_player_hpchanges.loggers[#core.registered_on_player_hpchanges.loggers + 1] = func
549 core.callback_origins[func] = {
550 mod = core.get_current_modname() or "??",
551 name = debug.getinfo(1, "n").name or "??"
555 core.registered_biomes = make_registration_wrap("register_biome", "clear_registered_biomes")
556 core.registered_ores = make_registration_wrap("register_ore", "clear_registered_ores")
557 core.registered_decorations = make_registration_wrap("register_decoration", "clear_registered_decorations")
559 core.unregister_biome = make_wrap_deregistration(core.register_biome, core.clear_registered_biomes, core.registered_biomes)
561 core.registered_on_chat_messages, core.register_on_chat_message = make_registration()
562 core.registered_globalsteps, core.register_globalstep = make_registration()
563 core.registered_playerevents, core.register_playerevent = make_registration()
564 core.registered_on_shutdown, core.register_on_shutdown = make_registration()
565 core.registered_on_punchnodes, core.register_on_punchnode = make_registration()
566 core.registered_on_placenodes, core.register_on_placenode = make_registration()
567 core.registered_on_dignodes, core.register_on_dignode = make_registration()
568 core.registered_on_generateds, core.register_on_generated = make_registration()
569 core.registered_on_newplayers, core.register_on_newplayer = make_registration()
570 core.registered_on_dieplayers, core.register_on_dieplayer = make_registration()
571 core.registered_on_respawnplayers, core.register_on_respawnplayer = make_registration()
572 core.registered_on_prejoinplayers, core.register_on_prejoinplayer = make_registration()
573 core.registered_on_joinplayers, core.register_on_joinplayer = make_registration()
574 core.registered_on_leaveplayers, core.register_on_leaveplayer = make_registration()
575 core.registered_on_player_receive_fields, core.register_on_player_receive_fields = make_registration_reverse()
576 core.registered_on_cheats, core.register_on_cheat = make_registration()
577 core.registered_on_crafts, core.register_on_craft = make_registration()
578 core.registered_craft_predicts, core.register_craft_predict = make_registration()
579 core.registered_on_protection_violation, core.register_on_protection_violation = make_registration()
580 core.registered_on_item_eats, core.register_on_item_eat = make_registration()
581 core.registered_on_punchplayers, core.register_on_punchplayer = make_registration()
582 core.registered_on_priv_grant, core.register_on_priv_grant = make_registration()
583 core.registered_on_priv_revoke, core.register_on_priv_revoke = make_registration()
586 -- Compatibility for on_mapgen_init()
589 core.register_on_mapgen_init = function(func) func(core.get_mapgen_params()) end