1 -- Minetest: builtin/register.lua
3 local S = core.get_translator("__builtin")
6 -- Make raw registration functions inaccessible to anyone except this file
9 local register_item_raw = core.register_item_raw
10 core.register_item_raw = nil
12 local unregister_item_raw = core.unregister_item_raw
13 core.unregister_item_raw = nil
15 local register_alias_raw = core.register_alias_raw
16 core.register_alias_raw = nil
19 -- Item / entity / ABM / LBM registration functions
22 core.registered_abms = {}
23 core.registered_lbms = {}
24 core.registered_entities = {}
25 core.registered_items = {}
26 core.registered_nodes = {}
27 core.registered_craftitems = {}
28 core.registered_tools = {}
29 core.registered_aliases = {}
31 -- For tables that are indexed by item name:
32 -- If table[X] does not exist, default to table[core.registered_aliases[X]]
33 local alias_metatable = {
34 __index = function(t, name)
35 return rawget(t, core.registered_aliases[name])
38 setmetatable(core.registered_items, alias_metatable)
39 setmetatable(core.registered_nodes, alias_metatable)
40 setmetatable(core.registered_craftitems, alias_metatable)
41 setmetatable(core.registered_tools, alias_metatable)
43 -- These item names may not be used because they would interfere
44 -- with legacy itemstrings
45 local forbidden_item_names = {
58 local function check_modname_prefix(name)
59 if name:sub(1,1) == ":" then
60 -- If the name starts with a colon, we can skip the modname prefix
64 -- Enforce that the name starts with the correct mod name.
65 local expected_prefix = core.get_current_modname() .. ":"
66 if name:sub(1, #expected_prefix) ~= expected_prefix then
67 error("Name " .. name .. " does not follow naming conventions: " ..
68 "\"" .. expected_prefix .. "\" or \":\" prefix required")
71 -- Enforce that the name only contains letters, numbers and underscores.
72 local subname = name:sub(#expected_prefix+1)
73 if subname:find("[^%w_]") then
74 error("Name " .. name .. " does not follow naming conventions: " ..
75 "contains unallowed characters")
82 local function check_node_list(list, field)
85 for _, entry in pairs(list) do
86 assert(type(entry) == "string",
87 "Field '" .. field .. "' contains non-string entry")
89 elseif t ~= "string" and t ~= "nil" then
90 error("Field '" .. field .. "' has invalid type " .. t)
94 function core.register_abm(spec)
95 -- Add to core.registered_abms
96 check_node_list(spec.nodenames, "nodenames")
97 check_node_list(spec.neighbors, "neighbors")
98 assert(type(spec.action) == "function", "Required field 'action' of type function")
99 core.registered_abms[#core.registered_abms + 1] = spec
100 spec.mod_origin = core.get_current_modname() or "??"
103 function core.register_lbm(spec)
104 -- Add to core.registered_lbms
105 check_modname_prefix(spec.name)
106 check_node_list(spec.nodenames, "nodenames")
107 assert(type(spec.action) == "function", "Required field 'action' of type function")
108 core.registered_lbms[#core.registered_lbms + 1] = spec
109 spec.mod_origin = core.get_current_modname() or "??"
112 function core.register_entity(name, prototype)
115 error("Unable to register entity: Name is nil")
117 name = check_modname_prefix(tostring(name))
119 prototype.name = name
120 prototype.__index = prototype -- so that it can be used as a metatable
122 -- Add to core.registered_entities
123 core.registered_entities[name] = prototype
124 prototype.mod_origin = core.get_current_modname() or "??"
127 function core.register_item(name, itemdef)
130 error("Unable to register item: Name is nil")
132 name = check_modname_prefix(tostring(name))
133 if forbidden_item_names[name] then
134 error("Unable to register item: Name is forbidden: " .. name)
138 -- Apply defaults and add to registered_* table
139 if itemdef.type == "node" then
140 -- Use the nodebox as selection box if it's not set manually
141 if itemdef.drawtype == "nodebox" and not itemdef.selection_box then
142 itemdef.selection_box = itemdef.node_box
143 elseif itemdef.drawtype == "fencelike" and not itemdef.selection_box then
144 itemdef.selection_box = {
146 fixed = {-1/8, -1/2, -1/8, 1/8, 1/2, 1/8},
149 if itemdef.light_source and itemdef.light_source > core.LIGHT_MAX then
150 itemdef.light_source = core.LIGHT_MAX
151 core.log("warning", "Node 'light_source' value exceeds maximum," ..
152 " limiting to maximum: " ..name)
154 setmetatable(itemdef, {__index = core.nodedef_default})
155 core.registered_nodes[itemdef.name] = itemdef
156 elseif itemdef.type == "craft" then
157 setmetatable(itemdef, {__index = core.craftitemdef_default})
158 core.registered_craftitems[itemdef.name] = itemdef
159 elseif itemdef.type == "tool" then
160 setmetatable(itemdef, {__index = core.tooldef_default})
161 core.registered_tools[itemdef.name] = itemdef
162 elseif itemdef.type == "none" then
163 setmetatable(itemdef, {__index = core.noneitemdef_default})
165 error("Unable to register item: Type is invalid: " .. dump(itemdef))
168 -- Flowing liquid uses param2
169 if itemdef.type == "node" and itemdef.liquidtype == "flowing" then
170 itemdef.paramtype2 = "flowingliquid"
173 -- BEGIN Legacy stuff
174 if itemdef.cookresult_itemstring ~= nil and itemdef.cookresult_itemstring ~= "" then
175 core.register_craft({
177 output=itemdef.cookresult_itemstring,
179 cooktime=itemdef.furnace_cooktime
182 if itemdef.furnace_burntime ~= nil and itemdef.furnace_burntime >= 0 then
183 core.register_craft({
186 burntime=itemdef.furnace_burntime
191 itemdef.mod_origin = core.get_current_modname() or "??"
193 -- Disable all further modifications
194 getmetatable(itemdef).__newindex = {}
196 --core.log("Registering item: " .. itemdef.name)
197 core.registered_items[itemdef.name] = itemdef
198 core.registered_aliases[itemdef.name] = nil
199 register_item_raw(itemdef)
202 function core.unregister_item(name)
203 if not core.registered_items[name] then
204 core.log("warning", "Not unregistering item " ..name..
205 " because it doesn't exist.")
208 -- Erase from registered_* table
209 local type = core.registered_items[name].type
210 if type == "node" then
211 core.registered_nodes[name] = nil
212 elseif type == "craft" then
213 core.registered_craftitems[name] = nil
214 elseif type == "tool" then
215 core.registered_tools[name] = nil
217 core.registered_items[name] = nil
220 unregister_item_raw(name)
223 function core.register_node(name, nodedef)
224 nodedef.type = "node"
225 core.register_item(name, nodedef)
228 function core.register_craftitem(name, craftitemdef)
229 craftitemdef.type = "craft"
231 -- BEGIN Legacy stuff
232 if craftitemdef.inventory_image == nil and craftitemdef.image ~= nil then
233 craftitemdef.inventory_image = craftitemdef.image
237 core.register_item(name, craftitemdef)
240 function core.register_tool(name, tooldef)
241 tooldef.type = "tool"
242 tooldef.stack_max = 1
244 -- BEGIN Legacy stuff
245 if tooldef.inventory_image == nil and tooldef.image ~= nil then
246 tooldef.inventory_image = tooldef.image
248 if tooldef.tool_capabilities == nil and
249 (tooldef.full_punch_interval ~= nil or
250 tooldef.basetime ~= nil or
251 tooldef.dt_weight ~= nil or
252 tooldef.dt_crackiness ~= nil or
253 tooldef.dt_crumbliness ~= nil or
254 tooldef.dt_cuttability ~= nil or
255 tooldef.basedurability ~= nil or
256 tooldef.dd_weight ~= nil or
257 tooldef.dd_crackiness ~= nil or
258 tooldef.dd_crumbliness ~= nil or
259 tooldef.dd_cuttability ~= nil) then
260 tooldef.tool_capabilities = {
261 full_punch_interval = tooldef.full_punch_interval,
262 basetime = tooldef.basetime,
263 dt_weight = tooldef.dt_weight,
264 dt_crackiness = tooldef.dt_crackiness,
265 dt_crumbliness = tooldef.dt_crumbliness,
266 dt_cuttability = tooldef.dt_cuttability,
267 basedurability = tooldef.basedurability,
268 dd_weight = tooldef.dd_weight,
269 dd_crackiness = tooldef.dd_crackiness,
270 dd_crumbliness = tooldef.dd_crumbliness,
271 dd_cuttability = tooldef.dd_cuttability,
276 -- This isn't just legacy, but more of a convenience feature
277 local toolcaps = tooldef.tool_capabilities
278 if toolcaps and toolcaps.punch_attack_uses == nil then
279 for _, cap in pairs(toolcaps.groupcaps or {}) do
280 local level = (cap.maxlevel or 0) - 1
281 if (cap.uses or 0) ~= 0 and level >= 0 then
282 toolcaps.punch_attack_uses = cap.uses * (3 ^ level)
288 core.register_item(name, tooldef)
291 function core.register_alias(name, convert_to)
292 if forbidden_item_names[name] then
293 error("Unable to register alias: Name is forbidden: " .. name)
295 if core.registered_items[name] ~= nil then
296 core.log("warning", "Not registering alias, item with same name" ..
297 " is already defined: " .. name .. " -> " .. convert_to)
299 --core.log("Registering alias: " .. name .. " -> " .. convert_to)
300 core.registered_aliases[name] = convert_to
301 register_alias_raw(name, convert_to)
305 function core.register_alias_force(name, convert_to)
306 if forbidden_item_names[name] then
307 error("Unable to register alias: Name is forbidden: " .. name)
309 if core.registered_items[name] ~= nil then
310 core.unregister_item(name)
311 core.log("info", "Removed item " ..name..
312 " while attempting to force add an alias")
314 --core.log("Registering alias: " .. name .. " -> " .. convert_to)
315 core.registered_aliases[name] = convert_to
316 register_alias_raw(name, convert_to)
319 function core.on_craft(itemstack, player, old_craft_list, craft_inv)
320 for _, func in ipairs(core.registered_on_crafts) do
321 -- cast to ItemStack since func() could return a string
322 itemstack = ItemStack(func(itemstack, player, old_craft_list, craft_inv) or itemstack)
327 function core.craft_predict(itemstack, player, old_craft_list, craft_inv)
328 for _, func in ipairs(core.registered_craft_predicts) do
329 -- cast to ItemStack since func() could return a string
330 itemstack = ItemStack(func(itemstack, player, old_craft_list, craft_inv) or itemstack)
335 -- Alias the forbidden item names to "" so they can't be
336 -- created via itemstrings (e.g. /give)
337 for name in pairs(forbidden_item_names) do
338 core.registered_aliases[name] = ""
339 register_alias_raw(name, "")
343 -- Built-in node definitions. Also defined in C.
346 core.register_item(":unknown", {
348 description = S("Unknown Item"),
349 inventory_image = "unknown_item.png",
350 on_place = core.item_place,
351 on_secondary_use = core.item_secondary_use,
352 on_drop = core.item_drop,
353 groups = {not_in_creative_inventory=1},
357 core.register_node(":air", {
358 description = S("Air"),
359 inventory_image = "air.png",
360 wield_image = "air.png",
361 drawtype = "airlike",
363 sunlight_propagates = true,
369 air_equivalent = true,
371 groups = {not_in_creative_inventory=1},
374 core.register_node(":ignore", {
375 description = S("Ignore"),
376 inventory_image = "ignore.png",
377 wield_image = "ignore.png",
378 drawtype = "airlike",
380 sunlight_propagates = false,
384 buildable_to = true, -- A way to remove accidentally placed ignores
385 air_equivalent = true,
387 groups = {not_in_creative_inventory=1},
388 node_placement_prediction = "",
389 on_place = function(itemstack, placer, pointed_thing)
390 core.chat_send_player(
391 placer:get_player_name(),
392 core.colorize("#FF0000",
393 S("You can't place 'ignore' nodes!")))
398 -- The hand (bare definition)
399 core.register_item(":", {
401 wield_image = "wieldhand.png",
402 groups = {not_in_creative_inventory=1},
406 function core.override_item(name, redefinition)
407 if redefinition.name ~= nil then
408 error("Attempt to redefine name of "..name.." to "..dump(redefinition.name), 2)
410 if redefinition.type ~= nil then
411 error("Attempt to redefine type of "..name.." to "..dump(redefinition.type), 2)
413 local item = core.registered_items[name]
415 error("Attempt to override non-existent item "..name, 2)
417 for k, v in pairs(redefinition) do
420 register_item_raw(item)
424 local default = {mod = "??", name = "??"}
425 core.callback_origins = setmetatable({}, {
432 function core.run_callbacks(callbacks, mode, ...)
433 assert(type(callbacks) == "table")
434 local cb_len = #callbacks
436 if mode == 2 or mode == 3 then
438 elseif mode == 4 or mode == 5 then
444 local origin = core.callback_origins[callbacks[i]]
445 core.set_last_run_mod(origin.mod)
446 local cb_ret = callbacks[i](...)
448 if mode == 0 and i == 1 then
450 elseif mode == 1 and i == cb_len then
452 elseif mode == 2 then
453 if not cb_ret or i == 1 then
456 elseif mode == 3 then
461 elseif mode == 4 then
462 if (cb_ret and not ret) or i == 1 then
465 elseif mode == 5 and cb_ret then
472 function core.run_priv_callbacks(name, priv, caller, method)
473 local def = core.registered_privileges[priv]
474 if not def or not def["on_" .. method] or
475 not def["on_" .. method](name, caller) then
476 for _, func in ipairs(core["registered_on_priv_" .. method]) do
477 if not func(name, caller, priv) then
485 -- Callback registration
488 local function make_registration()
490 local registerfunc = function(func)
492 core.callback_origins[func] = {
493 mod = core.get_current_modname() or "??",
494 name = debug.getinfo(1, "n").name or "??"
496 --local origin = core.callback_origins[func]
497 --print(origin.name .. ": " .. origin.mod .. " registering cbk " .. tostring(func))
499 return t, registerfunc
502 local function make_registration_reverse()
504 local registerfunc = function(func)
505 table.insert(t, 1, func)
506 core.callback_origins[func] = {
507 mod = core.get_current_modname() or "??",
508 name = debug.getinfo(1, "n").name or "??"
510 --local origin = core.callback_origins[func]
511 --print(origin.name .. ": " .. origin.mod .. " registering cbk " .. tostring(func))
513 return t, registerfunc
516 local function make_registration_wrap(reg_fn_name, clear_fn_name)
519 local orig_reg_fn = core[reg_fn_name]
520 core[reg_fn_name] = function(def)
521 local retval = orig_reg_fn(def)
522 if retval ~= nil then
523 if def.name ~= nil then
532 local orig_clear_fn = core[clear_fn_name]
533 core[clear_fn_name] = function()
534 for k in pairs(list) do
537 return orig_clear_fn()
543 local function make_wrap_deregistration(reg_fn, clear_fn, list)
544 local unregister = function (key)
545 if type(key) ~= "string" then
546 error("key is not a string", 2)
548 if not list[key] then
549 error("Attempt to unregister non-existent element - '" .. key .. "'", 2)
551 local temporary_list = table.copy(list)
553 for k,v in pairs(temporary_list) do
562 core.registered_on_player_hpchanges = { modifiers = { }, loggers = { } }
564 function core.registered_on_player_hpchange(player, hp_change, reason)
566 for i = #core.registered_on_player_hpchanges.modifiers, 1, -1 do
567 local func = core.registered_on_player_hpchanges.modifiers[i]
568 hp_change, last = func(player, hp_change, reason)
569 if type(hp_change) ~= "number" then
570 local debuginfo = debug.getinfo(func)
571 error("The register_on_hp_changes function has to return a number at " ..
572 debuginfo.short_src .. " line " .. debuginfo.linedefined)
578 for i, func in ipairs(core.registered_on_player_hpchanges.loggers) do
579 func(player, hp_change, reason)
584 function core.register_on_player_hpchange(func, modifier)
586 core.registered_on_player_hpchanges.modifiers[#core.registered_on_player_hpchanges.modifiers + 1] = func
588 core.registered_on_player_hpchanges.loggers[#core.registered_on_player_hpchanges.loggers + 1] = func
590 core.callback_origins[func] = {
591 mod = core.get_current_modname() or "??",
592 name = debug.getinfo(1, "n").name or "??"
596 core.registered_biomes = make_registration_wrap("register_biome", "clear_registered_biomes")
597 core.registered_ores = make_registration_wrap("register_ore", "clear_registered_ores")
598 core.registered_decorations = make_registration_wrap("register_decoration", "clear_registered_decorations")
600 core.unregister_biome = make_wrap_deregistration(core.register_biome,
601 core.clear_registered_biomes, core.registered_biomes)
603 core.registered_on_chat_messages, core.register_on_chat_message = make_registration()
604 core.registered_on_chatcommands, core.register_on_chatcommand = make_registration()
605 core.registered_globalsteps, core.register_globalstep = make_registration()
606 core.registered_playerevents, core.register_playerevent = make_registration()
607 core.registered_on_mods_loaded, core.register_on_mods_loaded = make_registration()
608 core.registered_on_shutdown, core.register_on_shutdown = make_registration()
609 core.registered_on_punchnodes, core.register_on_punchnode = make_registration()
610 core.registered_on_placenodes, core.register_on_placenode = make_registration()
611 core.registered_on_dignodes, core.register_on_dignode = make_registration()
612 core.registered_on_generateds, core.register_on_generated = make_registration()
613 core.registered_on_newplayers, core.register_on_newplayer = make_registration()
614 core.registered_on_dieplayers, core.register_on_dieplayer = make_registration()
615 core.registered_on_respawnplayers, core.register_on_respawnplayer = make_registration()
616 core.registered_on_prejoinplayers, core.register_on_prejoinplayer = make_registration()
617 core.registered_on_joinplayers, core.register_on_joinplayer = make_registration()
618 core.registered_on_leaveplayers, core.register_on_leaveplayer = make_registration()
619 core.registered_on_player_receive_fields, core.register_on_player_receive_fields = make_registration_reverse()
620 core.registered_on_cheats, core.register_on_cheat = make_registration()
621 core.registered_on_crafts, core.register_on_craft = make_registration()
622 core.registered_craft_predicts, core.register_craft_predict = make_registration()
623 core.registered_on_protection_violation, core.register_on_protection_violation = make_registration()
624 core.registered_on_item_eats, core.register_on_item_eat = make_registration()
625 core.registered_on_item_pickups, core.register_on_item_pickup = make_registration()
626 core.registered_on_punchplayers, core.register_on_punchplayer = make_registration()
627 core.registered_on_priv_grant, core.register_on_priv_grant = make_registration()
628 core.registered_on_priv_revoke, core.register_on_priv_revoke = make_registration()
629 core.registered_on_authplayers, core.register_on_authplayer = make_registration()
630 core.registered_can_bypass_userlimit, core.register_can_bypass_userlimit = make_registration()
631 core.registered_on_modchannel_message, core.register_on_modchannel_message = make_registration()
632 core.registered_on_player_inventory_actions, core.register_on_player_inventory_action = make_registration()
633 core.registered_allow_player_inventory_actions, core.register_allow_player_inventory_action = make_registration()
634 core.registered_on_rightclickplayers, core.register_on_rightclickplayer = make_registration()
635 core.registered_on_liquid_transformed, core.register_on_liquid_transformed = make_registration()
638 -- Compatibility for on_mapgen_init()
641 core.register_on_mapgen_init = function(func) func(core.get_mapgen_params()) end