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 setmetatable(itemdef, {__index = minetest.nodedef_default})
107 minetest.registered_nodes[itemdef.name] = itemdef
108 elseif itemdef.type == "craft" then
109 setmetatable(itemdef, {__index = minetest.craftitemdef_default})
110 minetest.registered_craftitems[itemdef.name] = itemdef
111 elseif itemdef.type == "tool" then
112 setmetatable(itemdef, {__index = minetest.tooldef_default})
113 minetest.registered_tools[itemdef.name] = itemdef
114 elseif itemdef.type == "none" then
115 setmetatable(itemdef, {__index = minetest.noneitemdef_default})
117 error("Unable to register item: Type is invalid: " .. dump(itemdef))
120 -- Flowing liquid uses param2
121 if itemdef.type == "node" and itemdef.liquidtype == "flowing" then
122 itemdef.paramtype2 = "flowingliquid"
125 -- BEGIN Legacy stuff
126 if itemdef.cookresult_itemstring ~= nil and itemdef.cookresult_itemstring ~= "" then
127 minetest.register_craft({
129 output=itemdef.cookresult_itemstring,
131 cooktime=itemdef.furnace_cooktime
134 if itemdef.furnace_burntime ~= nil and itemdef.furnace_burntime >= 0 then
135 minetest.register_craft({
138 burntime=itemdef.furnace_burntime
143 -- Disable all further modifications
144 getmetatable(itemdef).__newindex = {}
146 --minetest.log("Registering item: " .. itemdef.name)
147 minetest.registered_items[itemdef.name] = itemdef
148 minetest.registered_aliases[itemdef.name] = nil
149 register_item_raw(itemdef)
152 function minetest.register_node(name, nodedef)
153 nodedef.type = "node"
154 minetest.register_item(name, nodedef)
157 function minetest.register_craftitem(name, craftitemdef)
158 craftitemdef.type = "craft"
160 -- BEGIN Legacy stuff
161 if craftitemdef.inventory_image == nil and craftitemdef.image ~= nil then
162 craftitemdef.inventory_image = craftitemdef.image
166 minetest.register_item(name, craftitemdef)
169 function minetest.register_tool(name, tooldef)
170 tooldef.type = "tool"
171 tooldef.stack_max = 1
173 -- BEGIN Legacy stuff
174 if tooldef.inventory_image == nil and tooldef.image ~= nil then
175 tooldef.inventory_image = tooldef.image
177 if tooldef.tool_capabilities == nil and
178 (tooldef.full_punch_interval ~= nil or
179 tooldef.basetime ~= nil or
180 tooldef.dt_weight ~= nil or
181 tooldef.dt_crackiness ~= nil or
182 tooldef.dt_crumbliness ~= nil or
183 tooldef.dt_cuttability ~= nil or
184 tooldef.basedurability ~= nil or
185 tooldef.dd_weight ~= nil or
186 tooldef.dd_crackiness ~= nil or
187 tooldef.dd_crumbliness ~= nil or
188 tooldef.dd_cuttability ~= nil) then
189 tooldef.tool_capabilities = {
190 full_punch_interval = tooldef.full_punch_interval,
191 basetime = tooldef.basetime,
192 dt_weight = tooldef.dt_weight,
193 dt_crackiness = tooldef.dt_crackiness,
194 dt_crumbliness = tooldef.dt_crumbliness,
195 dt_cuttability = tooldef.dt_cuttability,
196 basedurability = tooldef.basedurability,
197 dd_weight = tooldef.dd_weight,
198 dd_crackiness = tooldef.dd_crackiness,
199 dd_crumbliness = tooldef.dd_crumbliness,
200 dd_cuttability = tooldef.dd_cuttability,
205 minetest.register_item(name, tooldef)
208 function minetest.register_alias(name, convert_to)
209 if forbidden_item_names[name] then
210 error("Unable to register alias: Name is forbidden: " .. name)
212 if minetest.registered_items[name] ~= nil then
213 minetest.log("WARNING: Not registering alias, item with same name" ..
214 " is already defined: " .. name .. " -> " .. convert_to)
216 --minetest.log("Registering alias: " .. name .. " -> " .. convert_to)
217 minetest.registered_aliases[name] = convert_to
218 register_alias_raw(name, convert_to)
222 -- Alias the forbidden item names to "" so they can't be
223 -- created via itemstrings (e.g. /give)
225 for name in pairs(forbidden_item_names) do
226 minetest.registered_aliases[name] = ""
227 register_alias_raw(name, "")
232 -- Aliases for minetest.register_alias (how ironic...)
233 --minetest.alias_node = minetest.register_alias
234 --minetest.alias_tool = minetest.register_alias
235 --minetest.alias_craftitem = minetest.register_alias
238 -- Built-in node definitions. Also defined in C.
241 minetest.register_item(":unknown", {
243 description = "Unknown Item",
244 inventory_image = "unknown_item.png",
245 on_place = minetest.item_place,
246 on_drop = minetest.item_drop,
247 groups = {not_in_creative_inventory=1},
250 minetest.register_node(":air", {
251 description = "Air (you hacker you!)",
252 inventory_image = "unknown_block.png",
253 wield_image = "unknown_block.png",
254 drawtype = "airlike",
256 sunlight_propagates = true,
261 air_equivalent = true,
263 groups = {not_in_creative_inventory=1},
266 minetest.register_node(":ignore", {
267 description = "Ignore (you hacker you!)",
268 inventory_image = "unknown_block.png",
269 wield_image = "unknown_block.png",
270 drawtype = "airlike",
272 sunlight_propagates = false,
276 buildable_to = true, -- A way to remove accidentally placed ignores
277 air_equivalent = true,
279 groups = {not_in_creative_inventory=1},
282 -- The hand (bare definition)
283 minetest.register_item(":", {
285 groups = {not_in_creative_inventory=1},
289 -- Callback registration
292 local function make_registration()
294 local registerfunc = function(func) table.insert(t, func) end
295 return t, registerfunc
298 local function make_registration_reverse()
300 local registerfunc = function(func) table.insert(t, 1, func) end
301 return t, registerfunc
304 minetest.registered_on_chat_messages, minetest.register_on_chat_message = make_registration()
305 minetest.registered_globalsteps, minetest.register_globalstep = make_registration()
306 minetest.registered_on_punchnodes, minetest.register_on_punchnode = make_registration()
307 minetest.registered_on_placenodes, minetest.register_on_placenode = make_registration()
308 minetest.registered_on_dignodes, minetest.register_on_dignode = make_registration()
309 minetest.registered_on_generateds, minetest.register_on_generated = make_registration()
310 minetest.registered_on_newplayers, minetest.register_on_newplayer = make_registration()
311 minetest.registered_on_dieplayers, minetest.register_on_dieplayer = make_registration()
312 minetest.registered_on_respawnplayers, minetest.register_on_respawnplayer = make_registration()
313 minetest.registered_on_joinplayers, minetest.register_on_joinplayer = make_registration()
314 minetest.registered_on_leaveplayers, minetest.register_on_leaveplayer = make_registration()
315 minetest.registered_on_player_receive_fields, minetest.register_on_player_receive_fields = make_registration_reverse()