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 -- Escape the modname prefix enforcement mechanism
57 -- Modname prefix enforcement
58 local expected_prefix = core.get_current_modname() .. ":"
59 if name:sub(1, #expected_prefix) ~= expected_prefix then
60 error("Name " .. name .. " does not follow naming conventions: " ..
61 "\"modname:\" or \":\" prefix required")
63 local subname = name:sub(#expected_prefix+1)
64 if subname:find("[^abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_]") then
65 error("Name " .. name .. " does not follow naming conventions: " ..
66 "contains unallowed characters")
72 function core.register_abm(spec)
73 -- Add to core.registered_abms
74 core.registered_abms[#core.registered_abms+1] = spec
77 function core.register_entity(name, prototype)
80 error("Unable to register entity: Name is nil")
82 name = check_modname_prefix(tostring(name))
85 prototype.__index = prototype -- so that it can be used as a metatable
87 -- Add to core.registered_entities
88 core.registered_entities[name] = prototype
91 function core.register_item(name, itemdef)
94 error("Unable to register item: Name is nil")
96 name = check_modname_prefix(tostring(name))
97 if forbidden_item_names[name] then
98 error("Unable to register item: Name is forbidden: " .. name)
102 -- Apply defaults and add to registered_* table
103 if itemdef.type == "node" then
104 -- Use the nodebox as selection box if it's not set manually
105 if itemdef.drawtype == "nodebox" and not itemdef.selection_box then
106 itemdef.selection_box = itemdef.node_box
107 elseif itemdef.drawtype == "fencelike" and not itemdef.selection_box then
108 itemdef.selection_box = {
110 fixed = {-1/8, -1/2, -1/8, 1/8, 1/2, 1/8},
113 setmetatable(itemdef, {__index = core.nodedef_default})
114 core.registered_nodes[itemdef.name] = itemdef
115 elseif itemdef.type == "craft" then
116 setmetatable(itemdef, {__index = core.craftitemdef_default})
117 core.registered_craftitems[itemdef.name] = itemdef
118 elseif itemdef.type == "tool" then
119 setmetatable(itemdef, {__index = core.tooldef_default})
120 core.registered_tools[itemdef.name] = itemdef
121 elseif itemdef.type == "none" then
122 setmetatable(itemdef, {__index = core.noneitemdef_default})
124 error("Unable to register item: Type is invalid: " .. dump(itemdef))
127 -- Flowing liquid uses param2
128 if itemdef.type == "node" and itemdef.liquidtype == "flowing" then
129 itemdef.paramtype2 = "flowingliquid"
132 -- BEGIN Legacy stuff
133 if itemdef.cookresult_itemstring ~= nil and itemdef.cookresult_itemstring ~= "" then
134 core.register_craft({
136 output=itemdef.cookresult_itemstring,
138 cooktime=itemdef.furnace_cooktime
141 if itemdef.furnace_burntime ~= nil and itemdef.furnace_burntime >= 0 then
142 core.register_craft({
145 burntime=itemdef.furnace_burntime
150 -- Disable all further modifications
151 getmetatable(itemdef).__newindex = {}
153 --core.log("Registering item: " .. itemdef.name)
154 core.registered_items[itemdef.name] = itemdef
155 core.registered_aliases[itemdef.name] = nil
156 register_item_raw(itemdef)
159 function core.register_node(name, nodedef)
160 nodedef.type = "node"
161 core.register_item(name, nodedef)
164 function core.register_craftitem(name, craftitemdef)
165 craftitemdef.type = "craft"
167 -- BEGIN Legacy stuff
168 if craftitemdef.inventory_image == nil and craftitemdef.image ~= nil then
169 craftitemdef.inventory_image = craftitemdef.image
173 core.register_item(name, craftitemdef)
176 function core.register_tool(name, tooldef)
177 tooldef.type = "tool"
178 tooldef.stack_max = 1
180 -- BEGIN Legacy stuff
181 if tooldef.inventory_image == nil and tooldef.image ~= nil then
182 tooldef.inventory_image = tooldef.image
184 if tooldef.tool_capabilities == nil and
185 (tooldef.full_punch_interval ~= nil or
186 tooldef.basetime ~= nil or
187 tooldef.dt_weight ~= nil or
188 tooldef.dt_crackiness ~= nil or
189 tooldef.dt_crumbliness ~= nil or
190 tooldef.dt_cuttability ~= nil or
191 tooldef.basedurability ~= nil or
192 tooldef.dd_weight ~= nil or
193 tooldef.dd_crackiness ~= nil or
194 tooldef.dd_crumbliness ~= nil or
195 tooldef.dd_cuttability ~= nil) then
196 tooldef.tool_capabilities = {
197 full_punch_interval = tooldef.full_punch_interval,
198 basetime = tooldef.basetime,
199 dt_weight = tooldef.dt_weight,
200 dt_crackiness = tooldef.dt_crackiness,
201 dt_crumbliness = tooldef.dt_crumbliness,
202 dt_cuttability = tooldef.dt_cuttability,
203 basedurability = tooldef.basedurability,
204 dd_weight = tooldef.dd_weight,
205 dd_crackiness = tooldef.dd_crackiness,
206 dd_crumbliness = tooldef.dd_crumbliness,
207 dd_cuttability = tooldef.dd_cuttability,
212 core.register_item(name, tooldef)
215 function core.register_alias(name, convert_to)
216 if forbidden_item_names[name] then
217 error("Unable to register alias: Name is forbidden: " .. name)
219 if core.registered_items[name] ~= nil then
220 core.log("WARNING: Not registering alias, item with same name" ..
221 " is already defined: " .. name .. " -> " .. convert_to)
223 --core.log("Registering alias: " .. name .. " -> " .. convert_to)
224 core.registered_aliases[name] = convert_to
225 register_alias_raw(name, convert_to)
229 function core.on_craft(itemstack, player, old_craft_list, craft_inv)
230 for _, func in ipairs(core.registered_on_crafts) do
231 itemstack = func(itemstack, player, old_craft_list, craft_inv) or itemstack
236 function core.craft_predict(itemstack, player, old_craft_list, craft_inv)
237 for _, func in ipairs(core.registered_craft_predicts) do
238 itemstack = func(itemstack, player, old_craft_list, craft_inv) or itemstack
243 -- Alias the forbidden item names to "" so they can't be
244 -- created via itemstrings (e.g. /give)
246 for name in pairs(forbidden_item_names) do
247 core.registered_aliases[name] = ""
248 register_alias_raw(name, "")
253 -- Aliases for core.register_alias (how ironic...)
254 --core.alias_node = core.register_alias
255 --core.alias_tool = core.register_alias
256 --core.alias_craftitem = core.register_alias
259 -- Built-in node definitions. Also defined in C.
262 core.register_item(":unknown", {
264 description = "Unknown Item",
265 inventory_image = "unknown_item.png",
266 on_place = core.item_place,
267 on_drop = core.item_drop,
268 groups = {not_in_creative_inventory=1},
272 core.register_node(":air", {
273 description = "Air (you hacker you!)",
274 inventory_image = "unknown_node.png",
275 wield_image = "unknown_node.png",
276 drawtype = "airlike",
278 sunlight_propagates = true,
283 air_equivalent = true,
285 groups = {not_in_creative_inventory=1},
288 core.register_node(":ignore", {
289 description = "Ignore (you hacker you!)",
290 inventory_image = "unknown_node.png",
291 wield_image = "unknown_node.png",
292 drawtype = "airlike",
294 sunlight_propagates = false,
298 buildable_to = true, -- A way to remove accidentally placed ignores
299 air_equivalent = true,
301 groups = {not_in_creative_inventory=1},
304 -- The hand (bare definition)
305 core.register_item(":", {
307 groups = {not_in_creative_inventory=1},
311 function core.override_item(name, redefinition)
312 if redefinition.name ~= nil then
313 error("Attempt to redefine name of "..name.." to "..dump(redefinition.name), 2)
315 if redefinition.type ~= nil then
316 error("Attempt to redefine type of "..name.." to "..dump(redefinition.type), 2)
318 local item = core.registered_items[name]
320 error("Attempt to override non-existent item "..name, 2)
322 for k, v in pairs(redefinition) do
325 register_item_raw(item)
329 function core.run_callbacks(callbacks, mode, ...)
330 assert(type(callbacks) == "table")
331 local cb_len = #callbacks
333 if mode == 2 or mode == 3 then
335 elseif mode == 4 or mode == 5 then
341 local cb_ret = callbacks[i](...)
343 if mode == 0 and i == 1 then
345 elseif mode == 1 and i == cb_len then
347 elseif mode == 2 then
348 if not cb_ret or i == 1 then
351 elseif mode == 3 then
356 elseif mode == 4 then
357 if (cb_ret and not ret) or i == 1 then
360 elseif mode == 5 and cb_ret then
368 -- Callback registration
371 local function make_registration()
373 local registerfunc = function(func) table.insert(t, func) end
374 return t, registerfunc
377 local function make_registration_reverse()
379 local registerfunc = function(func) table.insert(t, 1, func) end
380 return t, registerfunc
383 local function make_registration_wrap(reg_fn_name, clear_fn_name)
386 local orig_reg_fn = core[reg_fn_name]
387 core[reg_fn_name] = function(def)
388 local retval = orig_reg_fn(def)
389 if retval ~= nil then
390 if def.name ~= nil then
399 local orig_clear_fn = core[clear_fn_name]
400 core[clear_fn_name] = function()
402 return orig_clear_fn()
408 core.registered_biomes = make_registration_wrap("register_biome", "clear_registered_biomes")
409 core.registered_ores = make_registration_wrap("register_ore", "clear_registered_ores")
410 core.registered_decorations = make_registration_wrap("register_decoration", "clear_registered_decorations")
412 core.registered_on_chat_messages, core.register_on_chat_message = make_registration()
413 core.registered_globalsteps, core.register_globalstep = make_registration()
414 core.registered_playerevents, core.register_playerevent = make_registration()
415 core.registered_on_shutdown, core.register_on_shutdown = make_registration()
416 core.registered_on_punchnodes, core.register_on_punchnode = make_registration()
417 core.registered_on_placenodes, core.register_on_placenode = make_registration()
418 core.registered_on_dignodes, core.register_on_dignode = make_registration()
419 core.registered_on_generateds, core.register_on_generated = make_registration()
420 core.registered_on_newplayers, core.register_on_newplayer = make_registration()
421 core.registered_on_dieplayers, core.register_on_dieplayer = make_registration()
422 core.registered_on_respawnplayers, core.register_on_respawnplayer = make_registration()
423 core.registered_on_prejoinplayers, core.register_on_prejoinplayer = make_registration()
424 core.registered_on_joinplayers, core.register_on_joinplayer = make_registration()
425 core.registered_on_leaveplayers, core.register_on_leaveplayer = make_registration()
426 core.registered_on_player_receive_fields, core.register_on_player_receive_fields = make_registration_reverse()
427 core.registered_on_cheats, core.register_on_cheat = make_registration()
428 core.registered_on_crafts, core.register_on_craft = make_registration()
429 core.registered_craft_predicts, core.register_craft_predict = make_registration()
430 core.registered_on_protection_violation, core.register_on_protection_violation = make_registration()
431 core.registered_on_item_eats, core.register_on_item_eat = make_registration()
434 -- Compatibility for on_mapgen_init()
437 core.register_on_mapgen_init = function(func) func(core.get_mapgen_params()) end