1 -- Minetest: builtin/misc_register.lua
4 -- Make raw registration functions inaccessible to anyone except this file
7 local register_item_raw = minetest.register_item_raw
8 minetest.register_item_raw = nil
10 local register_alias_raw = minetest.register_alias_raw
11 minetest.register_item_raw = nil
14 -- Item / entity / ABM registration functions
17 minetest.registered_abms = {}
18 minetest.registered_entities = {}
19 minetest.registered_items = {}
20 minetest.registered_nodes = {}
21 minetest.registered_craftitems = {}
22 minetest.registered_tools = {}
23 minetest.registered_aliases = {}
25 -- For tables that are indexed by item name:
26 -- If table[X] does not exist, default to table[minetest.registered_aliases[X]]
27 local function set_alias_metatable(table)
29 __index = function(name)
30 return rawget(table, minetest.registered_aliases[name])
34 set_alias_metatable(minetest.registered_items)
35 set_alias_metatable(minetest.registered_nodes)
36 set_alias_metatable(minetest.registered_craftitems)
37 set_alias_metatable(minetest.registered_tools)
39 -- These item names may not be used because they would interfere
40 -- with legacy itemstrings
41 local forbidden_item_names = {
54 local function check_modname_prefix(name)
55 if name:sub(1,1) == ":" then
56 -- Escape the modname prefix enforcement mechanism
59 -- Modname prefix enforcement
60 local expected_prefix = minetest.get_current_modname() .. ":"
61 if name:sub(1, #expected_prefix) ~= expected_prefix then
62 error("Name " .. name .. " does not follow naming conventions: " ..
63 "\"modname:\" or \":\" prefix required")
65 local subname = name:sub(#expected_prefix+1)
66 if subname:find("[^abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_]") then
67 error("Name " .. name .. " does not follow naming conventions: " ..
68 "contains unallowed characters")
74 function minetest.register_abm(spec)
75 -- Add to minetest.registered_abms
76 minetest.registered_abms[#minetest.registered_abms+1] = spec
79 function minetest.register_entity(name, prototype)
82 error("Unable to register entity: Name is nil")
84 name = check_modname_prefix(tostring(name))
87 prototype.__index = prototype -- so that it can be used as a metatable
89 -- Add to minetest.registered_entities
90 minetest.registered_entities[name] = prototype
93 function minetest.register_item(name, itemdef)
96 error("Unable to register item: Name is nil")
98 name = check_modname_prefix(tostring(name))
99 if forbidden_item_names[name] then
100 error("Unable to register item: Name is forbidden: " .. name)
104 -- Apply defaults and add to registered_* table
105 if itemdef.type == "node" then
106 -- Use the nodebox as selection box if it's not set manually
107 if itemdef.drawtype == "nodebox" and not itemdef.selection_box then
108 itemdef.selection_box = itemdef.node_box
110 setmetatable(itemdef, {__index = minetest.nodedef_default})
111 minetest.registered_nodes[itemdef.name] = itemdef
112 elseif itemdef.type == "craft" then
113 setmetatable(itemdef, {__index = minetest.craftitemdef_default})
114 minetest.registered_craftitems[itemdef.name] = itemdef
115 elseif itemdef.type == "tool" then
116 setmetatable(itemdef, {__index = minetest.tooldef_default})
117 minetest.registered_tools[itemdef.name] = itemdef
118 elseif itemdef.type == "none" then
119 setmetatable(itemdef, {__index = minetest.noneitemdef_default})
121 error("Unable to register item: Type is invalid: " .. dump(itemdef))
124 -- Flowing liquid uses param2
125 if itemdef.type == "node" and itemdef.liquidtype == "flowing" then
126 itemdef.paramtype2 = "flowingliquid"
129 -- BEGIN Legacy stuff
130 if itemdef.cookresult_itemstring ~= nil and itemdef.cookresult_itemstring ~= "" then
131 minetest.register_craft({
133 output=itemdef.cookresult_itemstring,
135 cooktime=itemdef.furnace_cooktime
138 if itemdef.furnace_burntime ~= nil and itemdef.furnace_burntime >= 0 then
139 minetest.register_craft({
142 burntime=itemdef.furnace_burntime
147 -- Disable all further modifications
148 getmetatable(itemdef).__newindex = {}
150 --minetest.log("Registering item: " .. itemdef.name)
151 minetest.registered_items[itemdef.name] = itemdef
152 minetest.registered_aliases[itemdef.name] = nil
153 register_item_raw(itemdef)
156 function minetest.register_node(name, nodedef)
157 nodedef.type = "node"
158 minetest.register_item(name, nodedef)
161 function minetest.register_craftitem(name, craftitemdef)
162 craftitemdef.type = "craft"
164 -- BEGIN Legacy stuff
165 if craftitemdef.inventory_image == nil and craftitemdef.image ~= nil then
166 craftitemdef.inventory_image = craftitemdef.image
170 minetest.register_item(name, craftitemdef)
173 function minetest.register_tool(name, tooldef)
174 tooldef.type = "tool"
175 tooldef.stack_max = 1
177 -- BEGIN Legacy stuff
178 if tooldef.inventory_image == nil and tooldef.image ~= nil then
179 tooldef.inventory_image = tooldef.image
181 if tooldef.tool_capabilities == nil and
182 (tooldef.full_punch_interval ~= nil or
183 tooldef.basetime ~= nil or
184 tooldef.dt_weight ~= nil or
185 tooldef.dt_crackiness ~= nil or
186 tooldef.dt_crumbliness ~= nil or
187 tooldef.dt_cuttability ~= nil or
188 tooldef.basedurability ~= nil or
189 tooldef.dd_weight ~= nil or
190 tooldef.dd_crackiness ~= nil or
191 tooldef.dd_crumbliness ~= nil or
192 tooldef.dd_cuttability ~= nil) then
193 tooldef.tool_capabilities = {
194 full_punch_interval = tooldef.full_punch_interval,
195 basetime = tooldef.basetime,
196 dt_weight = tooldef.dt_weight,
197 dt_crackiness = tooldef.dt_crackiness,
198 dt_crumbliness = tooldef.dt_crumbliness,
199 dt_cuttability = tooldef.dt_cuttability,
200 basedurability = tooldef.basedurability,
201 dd_weight = tooldef.dd_weight,
202 dd_crackiness = tooldef.dd_crackiness,
203 dd_crumbliness = tooldef.dd_crumbliness,
204 dd_cuttability = tooldef.dd_cuttability,
209 minetest.register_item(name, tooldef)
212 function minetest.register_alias(name, convert_to)
213 if forbidden_item_names[name] then
214 error("Unable to register alias: Name is forbidden: " .. name)
216 if minetest.registered_items[name] ~= nil then
217 minetest.log("WARNING: Not registering alias, item with same name" ..
218 " is already defined: " .. name .. " -> " .. convert_to)
220 --minetest.log("Registering alias: " .. name .. " -> " .. convert_to)
221 minetest.registered_aliases[name] = convert_to
222 register_alias_raw(name, convert_to)
226 local register_biome_raw = minetest.register_biome
227 minetest.registered_biomes = {}
228 function minetest.register_biome(biome)
229 minetest.registered_biomes[biome.name] = biome
230 register_biome_raw(biome)
233 function minetest.on_craft(itemstack, player, old_craft_list, craft_inv)
234 for _, func in ipairs(minetest.registered_on_crafts) do
235 itemstack = func(itemstack, player, old_craft_list, craft_inv) or itemstack
240 function minetest.craft_predict(itemstack, player, old_craft_list, craft_inv)
241 for _, func in ipairs(minetest.registered_craft_predicts) do
242 itemstack = func(itemstack, player, old_craft_list, craft_inv) or itemstack
247 -- Alias the forbidden item names to "" so they can't be
248 -- created via itemstrings (e.g. /give)
250 for name in pairs(forbidden_item_names) do
251 minetest.registered_aliases[name] = ""
252 register_alias_raw(name, "")
257 -- Aliases for minetest.register_alias (how ironic...)
258 --minetest.alias_node = minetest.register_alias
259 --minetest.alias_tool = minetest.register_alias
260 --minetest.alias_craftitem = minetest.register_alias
263 -- Built-in node definitions. Also defined in C.
266 minetest.register_item(":unknown", {
268 description = "Unknown Item",
269 inventory_image = "unknown_item.png",
270 on_place = minetest.item_place,
271 on_drop = minetest.item_drop,
272 groups = {not_in_creative_inventory=1},
275 minetest.register_node(":air", {
276 description = "Air (you hacker you!)",
277 inventory_image = "unknown_node.png",
278 wield_image = "unknown_node.png",
279 drawtype = "airlike",
281 sunlight_propagates = true,
286 air_equivalent = true,
288 groups = {not_in_creative_inventory=1},
291 minetest.register_node(":ignore", {
292 description = "Ignore (you hacker you!)",
293 inventory_image = "unknown_node.png",
294 wield_image = "unknown_node.png",
295 drawtype = "airlike",
297 sunlight_propagates = false,
301 buildable_to = true, -- A way to remove accidentally placed ignores
302 air_equivalent = true,
304 groups = {not_in_creative_inventory=1},
307 -- The hand (bare definition)
308 minetest.register_item(":", {
310 groups = {not_in_creative_inventory=1},
314 -- Callback registration
317 local function make_registration()
319 local registerfunc = function(func) table.insert(t, func) end
320 return t, registerfunc
323 local function make_registration_reverse()
325 local registerfunc = function(func) table.insert(t, 1, func) end
326 return t, registerfunc
329 minetest.registered_on_chat_messages, minetest.register_on_chat_message = make_registration()
330 minetest.registered_globalsteps, minetest.register_globalstep = make_registration()
331 minetest.registered_on_mapgen_inits, minetest.register_on_mapgen_init = make_registration()
332 minetest.registered_on_shutdown, minetest.register_on_shutdown = make_registration()
333 minetest.registered_on_punchnodes, minetest.register_on_punchnode = make_registration()
334 minetest.registered_on_placenodes, minetest.register_on_placenode = make_registration()
335 minetest.registered_on_dignodes, minetest.register_on_dignode = make_registration()
336 minetest.registered_on_generateds, minetest.register_on_generated = make_registration()
337 minetest.registered_on_newplayers, minetest.register_on_newplayer = make_registration()
338 minetest.registered_on_dieplayers, minetest.register_on_dieplayer = make_registration()
339 minetest.registered_on_respawnplayers, minetest.register_on_respawnplayer = make_registration()
340 minetest.registered_on_joinplayers, minetest.register_on_joinplayer = make_registration()
341 minetest.registered_on_leaveplayers, minetest.register_on_leaveplayer = make_registration()
342 minetest.registered_on_player_receive_fields, minetest.register_on_player_receive_fields = make_registration_reverse()
343 minetest.registered_on_cheats, minetest.register_on_cheat = make_registration()
344 minetest.registered_on_crafts, minetest.register_on_craft = make_registration()
345 minetest.registered_craft_predicts, minetest.register_craft_predict = make_registration()