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 register_alias_raw = core.register_alias_raw
11 core.register_alias_raw = nil
14 -- Item / entity / ABM / LBM registration functions
17 core.registered_abms = {}
18 core.registered_lbms = {}
19 core.registered_entities = {}
20 core.registered_items = {}
21 core.registered_nodes = {}
22 core.registered_craftitems = {}
23 core.registered_tools = {}
24 core.registered_aliases = {}
26 -- For tables that are indexed by item name:
27 -- If table[X] does not exist, default to table[core.registered_aliases[X]]
28 local alias_metatable = {
29 __index = function(t, name)
30 return rawget(t, core.registered_aliases[name])
33 setmetatable(core.registered_items, alias_metatable)
34 setmetatable(core.registered_nodes, alias_metatable)
35 setmetatable(core.registered_craftitems, alias_metatable)
36 setmetatable(core.registered_tools, alias_metatable)
38 -- These item names may not be used because they would interfere
39 -- with legacy itemstrings
40 local forbidden_item_names = {
53 local function check_modname_prefix(name)
54 if name:sub(1,1) == ":" then
55 -- If the name starts with a colon, we can skip the modname prefix
59 -- Enforce that the name starts with the correct mod name.
60 local expected_prefix = core.get_current_modname() .. ":"
61 if name:sub(1, #expected_prefix) ~= expected_prefix then
62 error("Name " .. name .. " does not follow naming conventions: " ..
63 "\"" .. expected_prefix .. "\" or \":\" prefix required")
66 -- Enforce that the name only contains letters, numbers and underscores.
67 local subname = name:sub(#expected_prefix+1)
68 if subname:find("[^%w_]") then
69 error("Name " .. name .. " does not follow naming conventions: " ..
70 "contains unallowed characters")
77 function core.register_abm(spec)
78 -- Add to core.registered_abms
79 core.registered_abms[#core.registered_abms + 1] = spec
80 spec.mod_origin = core.get_current_modname() or "??"
83 function core.register_lbm(spec)
84 -- Add to core.registered_lbms
85 check_modname_prefix(spec.name)
86 core.registered_lbms[#core.registered_lbms + 1] = spec
87 spec.mod_origin = core.get_current_modname() or "??"
90 function core.register_entity(name, prototype)
93 error("Unable to register entity: Name is nil")
95 name = check_modname_prefix(tostring(name))
98 prototype.__index = prototype -- so that it can be used as a metatable
100 -- Add to core.registered_entities
101 core.registered_entities[name] = prototype
102 prototype.mod_origin = core.get_current_modname() or "??"
105 function core.register_item(name, itemdef)
108 error("Unable to register item: Name is nil")
110 name = check_modname_prefix(tostring(name))
111 if forbidden_item_names[name] then
112 error("Unable to register item: Name is forbidden: " .. name)
116 -- Apply defaults and add to registered_* table
117 if itemdef.type == "node" then
118 -- Use the nodebox as selection box if it's not set manually
119 if itemdef.drawtype == "nodebox" and not itemdef.selection_box then
120 itemdef.selection_box = itemdef.node_box
121 elseif itemdef.drawtype == "fencelike" and not itemdef.selection_box then
122 itemdef.selection_box = {
124 fixed = {-1/8, -1/2, -1/8, 1/8, 1/2, 1/8},
127 setmetatable(itemdef, {__index = core.nodedef_default})
128 core.registered_nodes[itemdef.name] = itemdef
129 elseif itemdef.type == "craft" then
130 setmetatable(itemdef, {__index = core.craftitemdef_default})
131 core.registered_craftitems[itemdef.name] = itemdef
132 elseif itemdef.type == "tool" then
133 setmetatable(itemdef, {__index = core.tooldef_default})
134 core.registered_tools[itemdef.name] = itemdef
135 elseif itemdef.type == "none" then
136 setmetatable(itemdef, {__index = core.noneitemdef_default})
138 error("Unable to register item: Type is invalid: " .. dump(itemdef))
141 -- Flowing liquid uses param2
142 if itemdef.type == "node" and itemdef.liquidtype == "flowing" then
143 itemdef.paramtype2 = "flowingliquid"
146 -- BEGIN Legacy stuff
147 if itemdef.cookresult_itemstring ~= nil and itemdef.cookresult_itemstring ~= "" then
148 core.register_craft({
150 output=itemdef.cookresult_itemstring,
152 cooktime=itemdef.furnace_cooktime
155 if itemdef.furnace_burntime ~= nil and itemdef.furnace_burntime >= 0 then
156 core.register_craft({
159 burntime=itemdef.furnace_burntime
164 itemdef.mod_origin = core.get_current_modname() or "??"
166 -- Disable all further modifications
167 getmetatable(itemdef).__newindex = {}
169 --core.log("Registering item: " .. itemdef.name)
170 core.registered_items[itemdef.name] = itemdef
171 core.registered_aliases[itemdef.name] = nil
172 register_item_raw(itemdef)
175 function core.register_node(name, nodedef)
176 nodedef.type = "node"
177 core.register_item(name, nodedef)
180 function core.register_craftitem(name, craftitemdef)
181 craftitemdef.type = "craft"
183 -- BEGIN Legacy stuff
184 if craftitemdef.inventory_image == nil and craftitemdef.image ~= nil then
185 craftitemdef.inventory_image = craftitemdef.image
189 core.register_item(name, craftitemdef)
192 function core.register_tool(name, tooldef)
193 tooldef.type = "tool"
194 tooldef.stack_max = 1
196 -- BEGIN Legacy stuff
197 if tooldef.inventory_image == nil and tooldef.image ~= nil then
198 tooldef.inventory_image = tooldef.image
200 if tooldef.tool_capabilities == nil and
201 (tooldef.full_punch_interval ~= nil or
202 tooldef.basetime ~= nil or
203 tooldef.dt_weight ~= nil or
204 tooldef.dt_crackiness ~= nil or
205 tooldef.dt_crumbliness ~= nil or
206 tooldef.dt_cuttability ~= nil or
207 tooldef.basedurability ~= nil or
208 tooldef.dd_weight ~= nil or
209 tooldef.dd_crackiness ~= nil or
210 tooldef.dd_crumbliness ~= nil or
211 tooldef.dd_cuttability ~= nil) then
212 tooldef.tool_capabilities = {
213 full_punch_interval = tooldef.full_punch_interval,
214 basetime = tooldef.basetime,
215 dt_weight = tooldef.dt_weight,
216 dt_crackiness = tooldef.dt_crackiness,
217 dt_crumbliness = tooldef.dt_crumbliness,
218 dt_cuttability = tooldef.dt_cuttability,
219 basedurability = tooldef.basedurability,
220 dd_weight = tooldef.dd_weight,
221 dd_crackiness = tooldef.dd_crackiness,
222 dd_crumbliness = tooldef.dd_crumbliness,
223 dd_cuttability = tooldef.dd_cuttability,
228 core.register_item(name, tooldef)
231 function core.register_alias(name, convert_to)
232 if forbidden_item_names[name] then
233 error("Unable to register alias: Name is forbidden: " .. name)
235 if core.registered_items[name] ~= nil then
236 core.log("warning", "Not registering alias, item with same name" ..
237 " is already defined: " .. name .. " -> " .. convert_to)
239 --core.log("Registering alias: " .. name .. " -> " .. convert_to)
240 core.registered_aliases[name] = convert_to
241 register_alias_raw(name, convert_to)
245 function core.on_craft(itemstack, player, old_craft_list, craft_inv)
246 for _, func in ipairs(core.registered_on_crafts) do
247 itemstack = func(itemstack, player, old_craft_list, craft_inv) or itemstack
252 function core.craft_predict(itemstack, player, old_craft_list, craft_inv)
253 for _, func in ipairs(core.registered_craft_predicts) do
254 itemstack = func(itemstack, player, old_craft_list, craft_inv) or itemstack
259 -- Alias the forbidden item names to "" so they can't be
260 -- created via itemstrings (e.g. /give)
262 for name in pairs(forbidden_item_names) do
263 core.registered_aliases[name] = ""
264 register_alias_raw(name, "")
269 -- Aliases for core.register_alias (how ironic...)
270 --core.alias_node = core.register_alias
271 --core.alias_tool = core.register_alias
272 --core.alias_craftitem = core.register_alias
275 -- Built-in node definitions. Also defined in C.
278 core.register_item(":unknown", {
280 description = "Unknown Item",
281 inventory_image = "unknown_item.png",
282 on_place = core.item_place,
283 on_secondary_use = core.item_secondary_use,
284 on_drop = core.item_drop,
285 groups = {not_in_creative_inventory=1},
289 core.register_node(":air", {
290 description = "Air (you hacker you!)",
291 inventory_image = "unknown_node.png",
292 wield_image = "unknown_node.png",
293 drawtype = "airlike",
295 sunlight_propagates = true,
301 air_equivalent = true,
303 groups = {not_in_creative_inventory=1},
306 core.register_node(":ignore", {
307 description = "Ignore (you hacker you!)",
308 inventory_image = "unknown_node.png",
309 wield_image = "unknown_node.png",
310 drawtype = "airlike",
312 sunlight_propagates = false,
316 buildable_to = true, -- A way to remove accidentally placed ignores
317 air_equivalent = true,
319 groups = {not_in_creative_inventory=1},
322 -- The hand (bare definition)
323 core.register_item(":", {
325 groups = {not_in_creative_inventory=1},
329 function core.override_item(name, redefinition)
330 if redefinition.name ~= nil then
331 error("Attempt to redefine name of "..name.." to "..dump(redefinition.name), 2)
333 if redefinition.type ~= nil then
334 error("Attempt to redefine type of "..name.." to "..dump(redefinition.type), 2)
336 local item = core.registered_items[name]
338 error("Attempt to override non-existent item "..name, 2)
340 for k, v in pairs(redefinition) do
343 register_item_raw(item)
347 core.callback_origins = {}
349 function core.run_callbacks(callbacks, mode, ...)
350 assert(type(callbacks) == "table")
351 local cb_len = #callbacks
353 if mode == 2 or mode == 3 then
355 elseif mode == 4 or mode == 5 then
361 local origin = core.callback_origins[callbacks[i]]
363 core.set_last_run_mod(origin.mod)
364 --print("Running " .. tostring(callbacks[i]) ..
365 -- " (a " .. origin.name .. " callback in " .. origin.mod .. ")")
367 --print("No data associated with callback")
369 local cb_ret = callbacks[i](...)
371 if mode == 0 and i == 1 then
373 elseif mode == 1 and i == cb_len then
375 elseif mode == 2 then
376 if not cb_ret or i == 1 then
379 elseif mode == 3 then
384 elseif mode == 4 then
385 if (cb_ret and not ret) or i == 1 then
388 elseif mode == 5 and cb_ret then
396 -- Callback registration
399 local function make_registration()
401 local registerfunc = function(func)
403 core.callback_origins[func] = {
404 mod = core.get_current_modname() or "??",
405 name = debug.getinfo(1, "n").name or "??"
407 --local origin = core.callback_origins[func]
408 --print(origin.name .. ": " .. origin.mod .. " registering cbk " .. tostring(func))
410 return t, registerfunc
413 local function make_registration_reverse()
415 local registerfunc = function(func)
416 table.insert(t, 1, func)
417 core.callback_origins[func] = {
418 mod = core.get_current_modname() or "??",
419 name = debug.getinfo(1, "n").name or "??"
421 --local origin = core.callback_origins[func]
422 --print(origin.name .. ": " .. origin.mod .. " registering cbk " .. tostring(func))
424 return t, registerfunc
427 local function make_registration_wrap(reg_fn_name, clear_fn_name)
430 local orig_reg_fn = core[reg_fn_name]
431 core[reg_fn_name] = function(def)
432 local retval = orig_reg_fn(def)
433 if retval ~= nil then
434 if def.name ~= nil then
443 local orig_clear_fn = core[clear_fn_name]
444 core[clear_fn_name] = function()
445 for k in pairs(list) do
448 return orig_clear_fn()
454 core.registered_on_player_hpchanges = { modifiers = { }, loggers = { } }
456 function core.registered_on_player_hpchange(player, hp_change)
458 for i = #core.registered_on_player_hpchanges.modifiers, 1, -1 do
459 local func = core.registered_on_player_hpchanges.modifiers[i]
460 hp_change, last = func(player, hp_change)
461 if type(hp_change) ~= "number" then
462 local debuginfo = debug.getinfo(func)
463 error("The register_on_hp_changes function has to return a number at " ..
464 debuginfo.short_src .. " line " .. debuginfo.linedefined)
470 for i, func in ipairs(core.registered_on_player_hpchanges.loggers) do
471 func(player, hp_change)
476 function core.register_on_player_hpchange(func, modifier)
478 core.registered_on_player_hpchanges.modifiers[#core.registered_on_player_hpchanges.modifiers + 1] = func
480 core.registered_on_player_hpchanges.loggers[#core.registered_on_player_hpchanges.loggers + 1] = func
482 core.callback_origins[func] = {
483 mod = core.get_current_modname() or "??",
484 name = debug.getinfo(1, "n").name or "??"
488 core.registered_biomes = make_registration_wrap("register_biome", "clear_registered_biomes")
489 core.registered_ores = make_registration_wrap("register_ore", "clear_registered_ores")
490 core.registered_decorations = make_registration_wrap("register_decoration", "clear_registered_decorations")
492 core.registered_on_chat_messages, core.register_on_chat_message = make_registration()
493 core.registered_globalsteps, core.register_globalstep = make_registration()
494 core.registered_playerevents, core.register_playerevent = make_registration()
495 core.registered_on_shutdown, core.register_on_shutdown = make_registration()
496 core.registered_on_punchnodes, core.register_on_punchnode = make_registration()
497 core.registered_on_placenodes, core.register_on_placenode = make_registration()
498 core.registered_on_dignodes, core.register_on_dignode = make_registration()
499 core.registered_on_generateds, core.register_on_generated = make_registration()
500 core.registered_on_newplayers, core.register_on_newplayer = make_registration()
501 core.registered_on_dieplayers, core.register_on_dieplayer = make_registration()
502 core.registered_on_respawnplayers, core.register_on_respawnplayer = make_registration()
503 core.registered_on_prejoinplayers, core.register_on_prejoinplayer = make_registration()
504 core.registered_on_joinplayers, core.register_on_joinplayer = make_registration()
505 core.registered_on_leaveplayers, core.register_on_leaveplayer = make_registration()
506 core.registered_on_player_receive_fields, core.register_on_player_receive_fields = make_registration_reverse()
507 core.registered_on_cheats, core.register_on_cheat = make_registration()
508 core.registered_on_crafts, core.register_on_craft = make_registration()
509 core.registered_craft_predicts, core.register_craft_predict = make_registration()
510 core.registered_on_protection_violation, core.register_on_protection_violation = make_registration()
511 core.registered_on_item_eats, core.register_on_item_eat = make_registration()
512 core.registered_on_punchplayers, core.register_on_punchplayer = make_registration()
515 -- Compatibility for on_mapgen_init()
518 core.register_on_mapgen_init = function(func) func(core.get_mapgen_params()) end