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 registration functions
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 = {}
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])
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)
37 -- These item names may not be used because they would interfere
38 -- with legacy itemstrings
39 local forbidden_item_names = {
52 local function check_modname_prefix(name)
53 if name:sub(1,1) == ":" then
54 -- If the name starts with a colon, we can skip the modname prefix
58 -- Enforce that the name starts with the correct mod name.
59 local expected_prefix = core.get_current_modname() .. ":"
60 if name:sub(1, #expected_prefix) ~= expected_prefix then
61 error("Name " .. name .. " does not follow naming conventions: " ..
62 "\"" .. expected_prefix .. "\" or \":\" prefix required")
65 -- Enforce that the name only contains letters, numbers and underscores.
66 local subname = name:sub(#expected_prefix+1)
67 if subname:find("[^%w_]") then
68 error("Name " .. name .. " does not follow naming conventions: " ..
69 "contains unallowed characters")
76 function core.register_abm(spec)
77 -- Add to core.registered_abms
78 core.registered_abms[#core.registered_abms+1] = spec
79 spec.mod_origin = core.get_current_modname() or "??"
82 function core.register_entity(name, prototype)
85 error("Unable to register entity: Name is nil")
87 name = check_modname_prefix(tostring(name))
90 prototype.__index = prototype -- so that it can be used as a metatable
92 -- Add to core.registered_entities
93 core.registered_entities[name] = prototype
94 prototype.mod_origin = core.get_current_modname() or "??"
97 function core.register_item(name, itemdef)
100 error("Unable to register item: Name is nil")
102 name = check_modname_prefix(tostring(name))
103 if forbidden_item_names[name] then
104 error("Unable to register item: Name is forbidden: " .. name)
108 -- Apply defaults and add to registered_* table
109 if itemdef.type == "node" then
110 -- Use the nodebox as selection box if it's not set manually
111 if itemdef.drawtype == "nodebox" and not itemdef.selection_box then
112 itemdef.selection_box = itemdef.node_box
113 elseif itemdef.drawtype == "fencelike" and not itemdef.selection_box then
114 itemdef.selection_box = {
116 fixed = {-1/8, -1/2, -1/8, 1/8, 1/2, 1/8},
119 setmetatable(itemdef, {__index = core.nodedef_default})
120 core.registered_nodes[itemdef.name] = itemdef
121 elseif itemdef.type == "craft" then
122 setmetatable(itemdef, {__index = core.craftitemdef_default})
123 core.registered_craftitems[itemdef.name] = itemdef
124 elseif itemdef.type == "tool" then
125 setmetatable(itemdef, {__index = core.tooldef_default})
126 core.registered_tools[itemdef.name] = itemdef
127 elseif itemdef.type == "none" then
128 setmetatable(itemdef, {__index = core.noneitemdef_default})
130 error("Unable to register item: Type is invalid: " .. dump(itemdef))
133 -- Flowing liquid uses param2
134 if itemdef.type == "node" and itemdef.liquidtype == "flowing" then
135 itemdef.paramtype2 = "flowingliquid"
138 -- BEGIN Legacy stuff
139 if itemdef.cookresult_itemstring ~= nil and itemdef.cookresult_itemstring ~= "" then
140 core.register_craft({
142 output=itemdef.cookresult_itemstring,
144 cooktime=itemdef.furnace_cooktime
147 if itemdef.furnace_burntime ~= nil and itemdef.furnace_burntime >= 0 then
148 core.register_craft({
151 burntime=itemdef.furnace_burntime
156 itemdef.mod_origin = core.get_current_modname() or "??"
158 -- Disable all further modifications
159 getmetatable(itemdef).__newindex = {}
161 --core.log("Registering item: " .. itemdef.name)
162 core.registered_items[itemdef.name] = itemdef
163 core.registered_aliases[itemdef.name] = nil
164 register_item_raw(itemdef)
167 function core.register_node(name, nodedef)
168 nodedef.type = "node"
169 core.register_item(name, nodedef)
172 function core.register_craftitem(name, craftitemdef)
173 craftitemdef.type = "craft"
175 -- BEGIN Legacy stuff
176 if craftitemdef.inventory_image == nil and craftitemdef.image ~= nil then
177 craftitemdef.inventory_image = craftitemdef.image
181 core.register_item(name, craftitemdef)
184 function core.register_tool(name, tooldef)
185 tooldef.type = "tool"
186 tooldef.stack_max = 1
188 -- BEGIN Legacy stuff
189 if tooldef.inventory_image == nil and tooldef.image ~= nil then
190 tooldef.inventory_image = tooldef.image
192 if tooldef.tool_capabilities == nil and
193 (tooldef.full_punch_interval ~= nil or
194 tooldef.basetime ~= nil or
195 tooldef.dt_weight ~= nil or
196 tooldef.dt_crackiness ~= nil or
197 tooldef.dt_crumbliness ~= nil or
198 tooldef.dt_cuttability ~= nil or
199 tooldef.basedurability ~= nil or
200 tooldef.dd_weight ~= nil or
201 tooldef.dd_crackiness ~= nil or
202 tooldef.dd_crumbliness ~= nil or
203 tooldef.dd_cuttability ~= nil) then
204 tooldef.tool_capabilities = {
205 full_punch_interval = tooldef.full_punch_interval,
206 basetime = tooldef.basetime,
207 dt_weight = tooldef.dt_weight,
208 dt_crackiness = tooldef.dt_crackiness,
209 dt_crumbliness = tooldef.dt_crumbliness,
210 dt_cuttability = tooldef.dt_cuttability,
211 basedurability = tooldef.basedurability,
212 dd_weight = tooldef.dd_weight,
213 dd_crackiness = tooldef.dd_crackiness,
214 dd_crumbliness = tooldef.dd_crumbliness,
215 dd_cuttability = tooldef.dd_cuttability,
220 core.register_item(name, tooldef)
223 function core.register_alias(name, convert_to)
224 if forbidden_item_names[name] then
225 error("Unable to register alias: Name is forbidden: " .. name)
227 if core.registered_items[name] ~= nil then
228 core.log("warning", "Not registering alias, item with same name" ..
229 " is already defined: " .. name .. " -> " .. convert_to)
231 --core.log("Registering alias: " .. name .. " -> " .. convert_to)
232 core.registered_aliases[name] = convert_to
233 register_alias_raw(name, convert_to)
237 function core.on_craft(itemstack, player, old_craft_list, craft_inv)
238 for _, func in ipairs(core.registered_on_crafts) do
239 itemstack = func(itemstack, player, old_craft_list, craft_inv) or itemstack
244 function core.craft_predict(itemstack, player, old_craft_list, craft_inv)
245 for _, func in ipairs(core.registered_craft_predicts) do
246 itemstack = func(itemstack, player, old_craft_list, craft_inv) or itemstack
251 -- Alias the forbidden item names to "" so they can't be
252 -- created via itemstrings (e.g. /give)
254 for name in pairs(forbidden_item_names) do
255 core.registered_aliases[name] = ""
256 register_alias_raw(name, "")
261 -- Aliases for core.register_alias (how ironic...)
262 --core.alias_node = core.register_alias
263 --core.alias_tool = core.register_alias
264 --core.alias_craftitem = core.register_alias
267 -- Built-in node definitions. Also defined in C.
270 core.register_item(":unknown", {
272 description = "Unknown Item",
273 inventory_image = "unknown_item.png",
274 on_place = core.item_place,
275 on_secondary_use = core.item_secondary_use,
276 on_drop = core.item_drop,
277 groups = {not_in_creative_inventory=1},
281 core.register_node(":air", {
282 description = "Air (you hacker you!)",
283 inventory_image = "unknown_node.png",
284 wield_image = "unknown_node.png",
285 drawtype = "airlike",
287 sunlight_propagates = true,
293 air_equivalent = true,
295 groups = {not_in_creative_inventory=1},
298 core.register_node(":ignore", {
299 description = "Ignore (you hacker you!)",
300 inventory_image = "unknown_node.png",
301 wield_image = "unknown_node.png",
302 drawtype = "airlike",
304 sunlight_propagates = false,
308 buildable_to = true, -- A way to remove accidentally placed ignores
309 air_equivalent = true,
311 groups = {not_in_creative_inventory=1},
314 -- The hand (bare definition)
315 core.register_item(":", {
317 groups = {not_in_creative_inventory=1},
321 function core.override_item(name, redefinition)
322 if redefinition.name ~= nil then
323 error("Attempt to redefine name of "..name.." to "..dump(redefinition.name), 2)
325 if redefinition.type ~= nil then
326 error("Attempt to redefine type of "..name.." to "..dump(redefinition.type), 2)
328 local item = core.registered_items[name]
330 error("Attempt to override non-existent item "..name, 2)
332 for k, v in pairs(redefinition) do
335 register_item_raw(item)
339 core.callback_origins = {}
341 function core.run_callbacks(callbacks, mode, ...)
342 assert(type(callbacks) == "table")
343 local cb_len = #callbacks
345 if mode == 2 or mode == 3 then
347 elseif mode == 4 or mode == 5 then
353 local origin = core.callback_origins[callbacks[i]]
355 core.set_last_run_mod(origin.mod)
356 --print("Running " .. tostring(callbacks[i]) ..
357 -- " (a " .. origin.name .. " callback in " .. origin.mod .. ")")
359 --print("No data associated with callback")
361 local cb_ret = callbacks[i](...)
363 if mode == 0 and i == 1 then
365 elseif mode == 1 and i == cb_len then
367 elseif mode == 2 then
368 if not cb_ret or i == 1 then
371 elseif mode == 3 then
376 elseif mode == 4 then
377 if (cb_ret and not ret) or i == 1 then
380 elseif mode == 5 and cb_ret then
388 -- Callback registration
391 local function make_registration()
393 local registerfunc = function(func)
394 table.insert(t, func)
395 core.callback_origins[func] = {
396 mod = core.get_current_modname() or "??",
397 name = debug.getinfo(1, "n").name or "??"
399 --local origin = core.callback_origins[func]
400 --print(origin.name .. ": " .. origin.mod .. " registering cbk " .. tostring(func))
402 return t, registerfunc
405 local function make_registration_reverse()
407 local registerfunc = function(func)
408 table.insert(t, 1, func)
409 core.callback_origins[func] = {
410 mod = core.get_current_modname() or "??",
411 name = debug.getinfo(1, "n").name or "??"
413 --local origin = core.callback_origins[func]
414 --print(origin.name .. ": " .. origin.mod .. " registering cbk " .. tostring(func))
416 return t, registerfunc
419 local function make_registration_wrap(reg_fn_name, clear_fn_name)
422 local orig_reg_fn = core[reg_fn_name]
423 core[reg_fn_name] = function(def)
424 local retval = orig_reg_fn(def)
425 if retval ~= nil then
426 if def.name ~= nil then
435 local orig_clear_fn = core[clear_fn_name]
436 core[clear_fn_name] = function()
437 for k in pairs(list) do
440 return orig_clear_fn()
446 core.registered_on_player_hpchanges = { modifiers = { }, loggers = { } }
448 function core.registered_on_player_hpchange(player, hp_change)
450 for i = #core.registered_on_player_hpchanges.modifiers, 1, -1 do
451 local func = core.registered_on_player_hpchanges.modifiers[i]
452 hp_change, last = func(player, hp_change)
453 if type(hp_change) ~= "number" then
454 local debuginfo = debug.getinfo(func)
455 error("The register_on_hp_changes function has to return a number at " ..
456 debuginfo.short_src .. " line " .. debuginfo.linedefined)
462 for i, func in ipairs(core.registered_on_player_hpchanges.loggers) do
463 func(player, hp_change)
468 function core.register_on_player_hpchange(func, modifier)
470 table.insert(core.registered_on_player_hpchanges.modifiers, func)
472 table.insert(core.registered_on_player_hpchanges.loggers, func)
474 core.callback_origins[func] = {
475 mod = core.get_current_modname() or "??",
476 name = debug.getinfo(1, "n").name or "??"
480 core.registered_biomes = make_registration_wrap("register_biome", "clear_registered_biomes")
481 core.registered_ores = make_registration_wrap("register_ore", "clear_registered_ores")
482 core.registered_decorations = make_registration_wrap("register_decoration", "clear_registered_decorations")
484 core.registered_on_chat_messages, core.register_on_chat_message = make_registration()
485 core.registered_globalsteps, core.register_globalstep = make_registration()
486 core.registered_playerevents, core.register_playerevent = make_registration()
487 core.registered_on_shutdown, core.register_on_shutdown = make_registration()
488 core.registered_on_punchnodes, core.register_on_punchnode = make_registration()
489 core.registered_on_placenodes, core.register_on_placenode = make_registration()
490 core.registered_on_dignodes, core.register_on_dignode = make_registration()
491 core.registered_on_generateds, core.register_on_generated = make_registration()
492 core.registered_on_newplayers, core.register_on_newplayer = make_registration()
493 core.registered_on_dieplayers, core.register_on_dieplayer = make_registration()
494 core.registered_on_respawnplayers, core.register_on_respawnplayer = make_registration()
495 core.registered_on_prejoinplayers, core.register_on_prejoinplayer = make_registration()
496 core.registered_on_joinplayers, core.register_on_joinplayer = make_registration()
497 core.registered_on_leaveplayers, core.register_on_leaveplayer = make_registration()
498 core.registered_on_player_receive_fields, core.register_on_player_receive_fields = make_registration_reverse()
499 core.registered_on_cheats, core.register_on_cheat = make_registration()
500 core.registered_on_crafts, core.register_on_craft = make_registration()
501 core.registered_craft_predicts, core.register_craft_predict = make_registration()
502 core.registered_on_protection_violation, core.register_on_protection_violation = make_registration()
503 core.registered_on_item_eats, core.register_on_item_eat = make_registration()
504 core.registered_on_punchplayers, core.register_on_punchplayer = make_registration()
507 -- Compatibility for on_mapgen_init()
510 core.register_on_mapgen_init = function(func) func(core.get_mapgen_params()) end