builtin/misc_register.lua

   1 -- Minetest: builtin/misc_register.lua
   2
   3 --
   4 -- Make raw registration functions inaccessible to anyone except this file
   5 --
   6
   7 local register_item_raw = minetest.register_item_raw
   8 minetest.register_item_raw = nil
   9
  10 local register_alias_raw = minetest.register_alias_raw
  11 minetest.register_item_raw = nil
  12
  13 --
  14 -- Item / entity / ABM registration functions
  15 --
  16
  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 = {}
  24
  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)
  28         setmetatable(table, {
  29                 __index = function(name)
  30                         return rawget(table, minetest.registered_aliases[name])
  31                 end
  32         })
  33 end
  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)
  38
  39 -- These item names may not be used because they would interfere
  40 -- with legacy itemstrings
  41 local forbidden_item_names = {
  42         MaterialItem = true,
  43         MaterialItem2 = true,
  44         MaterialItem3 = true,
  45         NodeItem = true,
  46         node = true,
  47         CraftItem = true,
  48         craft = true,
  49         MBOItem = true,
  50         ToolItem = true,
  51         tool = true,
  52 }
  53
  54 local function check_modname_prefix(name)
  55         if name:sub(1,1) == ":" then
  56                 -- Escape the modname prefix enforcement mechanism
  57                 return name:sub(2)
  58         else
  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")
  64                 end
  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")
  69                 end
  70                 return name
  71         end
  72 end
  73
  74 function minetest.register_abm(spec)
  75         -- Add to minetest.registered_abms
  76         minetest.registered_abms[#minetest.registered_abms+1] = spec
  77 end
  78
  79 function minetest.register_entity(name, prototype)
  80         -- Check name
  81         if name == nil then
  82                 error("Unable to register entity: Name is nil")
  83         end
  84         name = check_modname_prefix(tostring(name))
  85
  86         prototype.name = name
  87         prototype.__index = prototype  -- so that it can be used as a metatable
  88
  89         -- Add to minetest.registered_entities
  90         minetest.registered_entities[name] = prototype
  91 end
  92
  93 function minetest.register_item(name, itemdef)
  94         -- Check name
  95         if name == nil then
  96                 error("Unable to register item: Name is nil")
  97         end
  98         name = check_modname_prefix(tostring(name))
  99         if forbidden_item_names[name] then
 100                 error("Unable to register item: Name is forbidden: " .. name)
 101         end
 102         itemdef.name = name
 103
 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
 109                 elseif itemdef.drawtype == "fencelike" and not itemdef.selection_box then
 110                         itemdef.selection_box = {
 111                                 type = "fixed",
 112                                 fixed = {-1/8, -1/2, -1/8, 1/8, 1/2, 1/8},
 113                         }
 114                 end
 115                 setmetatable(itemdef, {__index = minetest.nodedef_default})
 116                 minetest.registered_nodes[itemdef.name] = itemdef
 117         elseif itemdef.type == "craft" then
 118                 setmetatable(itemdef, {__index = minetest.craftitemdef_default})
 119                 minetest.registered_craftitems[itemdef.name] = itemdef
 120         elseif itemdef.type == "tool" then
 121                 setmetatable(itemdef, {__index = minetest.tooldef_default})
 122                 minetest.registered_tools[itemdef.name] = itemdef
 123         elseif itemdef.type == "none" then
 124                 setmetatable(itemdef, {__index = minetest.noneitemdef_default})
 125         else
 126                 error("Unable to register item: Type is invalid: " .. dump(itemdef))
 127         end
 128
 129         -- Flowing liquid uses param2
 130         if itemdef.type == "node" and itemdef.liquidtype == "flowing" then
 131                 itemdef.paramtype2 = "flowingliquid"
 132         end
 133
 134         -- BEGIN Legacy stuff
 135         if itemdef.cookresult_itemstring ~= nil and itemdef.cookresult_itemstring ~= "" then
 136                 minetest.register_craft({
 137                         type="cooking",
 138                         output=itemdef.cookresult_itemstring,
 139                         recipe=itemdef.name,
 140                         cooktime=itemdef.furnace_cooktime
 141                 })
 142         end
 143         if itemdef.furnace_burntime ~= nil and itemdef.furnace_burntime >= 0 then
 144                 minetest.register_craft({
 145                         type="fuel",
 146                         recipe=itemdef.name,
 147                         burntime=itemdef.furnace_burntime
 148                 })
 149         end
 150         -- END Legacy stuff
 151
 152         -- Disable all further modifications
 153         getmetatable(itemdef).__newindex = {}
 154
 155         --minetest.log("Registering item: " .. itemdef.name)
 156         minetest.registered_items[itemdef.name] = itemdef
 157         minetest.registered_aliases[itemdef.name] = nil
 158         register_item_raw(itemdef)
 159 end
 160
 161 function minetest.register_node(name, nodedef)
 162         nodedef.type = "node"
 163         minetest.register_item(name, nodedef)
 164 end
 165
 166 function minetest.register_craftitem(name, craftitemdef)
 167         craftitemdef.type = "craft"
 168
 169         -- BEGIN Legacy stuff
 170         if craftitemdef.inventory_image == nil and craftitemdef.image ~= nil then
 171                 craftitemdef.inventory_image = craftitemdef.image
 172         end
 173         -- END Legacy stuff
 174
 175         minetest.register_item(name, craftitemdef)
 176 end
 177
 178 function minetest.register_tool(name, tooldef)
 179         tooldef.type = "tool"
 180         tooldef.stack_max = 1
 181
 182         -- BEGIN Legacy stuff
 183         if tooldef.inventory_image == nil and tooldef.image ~= nil then
 184                 tooldef.inventory_image = tooldef.image
 185         end
 186         if tooldef.tool_capabilities == nil and
 187            (tooldef.full_punch_interval ~= nil or
 188             tooldef.basetime ~= nil or
 189             tooldef.dt_weight ~= nil or
 190             tooldef.dt_crackiness ~= nil or
 191             tooldef.dt_crumbliness ~= nil or
 192             tooldef.dt_cuttability ~= nil or
 193             tooldef.basedurability ~= nil or
 194             tooldef.dd_weight ~= nil or
 195             tooldef.dd_crackiness ~= nil or
 196             tooldef.dd_crumbliness ~= nil or
 197             tooldef.dd_cuttability ~= nil) then
 198                 tooldef.tool_capabilities = {
 199                         full_punch_interval = tooldef.full_punch_interval,
 200                         basetime = tooldef.basetime,
 201                         dt_weight = tooldef.dt_weight,
 202                         dt_crackiness = tooldef.dt_crackiness,
 203                         dt_crumbliness = tooldef.dt_crumbliness,
 204                         dt_cuttability = tooldef.dt_cuttability,
 205                         basedurability = tooldef.basedurability,
 206                         dd_weight = tooldef.dd_weight,
 207                         dd_crackiness = tooldef.dd_crackiness,
 208                         dd_crumbliness = tooldef.dd_crumbliness,
 209                         dd_cuttability = tooldef.dd_cuttability,
 210                 }
 211         end
 212         -- END Legacy stuff
 213
 214         minetest.register_item(name, tooldef)
 215 end
 216
 217 function minetest.register_alias(name, convert_to)
 218         if forbidden_item_names[name] then
 219                 error("Unable to register alias: Name is forbidden: " .. name)
 220         end
 221         if minetest.registered_items[name] ~= nil then
 222                 minetest.log("WARNING: Not registering alias, item with same name" ..
 223                         " is already defined: " .. name .. " -> " .. convert_to)
 224         else
 225                 --minetest.log("Registering alias: " .. name .. " -> " .. convert_to)
 226                 minetest.registered_aliases[name] = convert_to
 227                 register_alias_raw(name, convert_to)
 228         end
 229 end
 230
 231 local register_biome_raw = minetest.register_biome
 232 minetest.registered_biomes = {}
 233 function minetest.register_biome(biome)
 234         minetest.registered_biomes[biome.name] = biome
 235         register_biome_raw(biome)
 236 end
 237
 238 function minetest.on_craft(itemstack, player, old_craft_list, craft_inv)
 239         for _, func in ipairs(minetest.registered_on_crafts) do
 240                 itemstack = func(itemstack, player, old_craft_list, craft_inv) or itemstack
 241         end
 242         return itemstack
 243 end
 244
 245 function minetest.craft_predict(itemstack, player, old_craft_list, craft_inv)
 246         for _, func in ipairs(minetest.registered_craft_predicts) do
 247                 itemstack = func(itemstack, player, old_craft_list, craft_inv) or itemstack
 248         end
 249         return itemstack
 250 end
 251
 252 -- Alias the forbidden item names to "" so they can't be
 253 -- created via itemstrings (e.g. /give)
 254 local name
 255 for name in pairs(forbidden_item_names) do
 256         minetest.registered_aliases[name] = ""
 257         register_alias_raw(name, "")
 258 end
 259
 260
 261 -- Deprecated:
 262 -- Aliases for minetest.register_alias (how ironic...)
 263 --minetest.alias_node = minetest.register_alias
 264 --minetest.alias_tool = minetest.register_alias
 265 --minetest.alias_craftitem = minetest.register_alias
 266
 267 --
 268 -- Built-in node definitions. Also defined in C.
 269 --
 270
 271 minetest.register_item(":unknown", {
 272         type = "none",
 273         description = "Unknown Item",
 274         inventory_image = "unknown_item.png",
 275         on_place = minetest.item_place,
 276         on_drop = minetest.item_drop,
 277         groups = {not_in_creative_inventory=1},
 278         diggable = true,
 279 })
 280
 281 minetest.register_node(":air", {
 282         description = "Air (you hacker you!)",
 283         inventory_image = "unknown_node.png",
 284         wield_image = "unknown_node.png",
 285         drawtype = "airlike",
 286         paramtype = "light",
 287         sunlight_propagates = true,
 288         walkable = false,
 289         pointable = false,
 290         diggable = false,
 291         buildable_to = true,
 292         air_equivalent = true,
 293         drop = "",
 294         groups = {not_in_creative_inventory=1},
 295 })
 296
 297 minetest.register_node(":ignore", {
 298         description = "Ignore (you hacker you!)",
 299         inventory_image = "unknown_node.png",
 300         wield_image = "unknown_node.png",
 301         drawtype = "airlike",
 302         paramtype = "none",
 303         sunlight_propagates = false,
 304         walkable = false,
 305         pointable = false,
 306         diggable = false,
 307         buildable_to = true, -- A way to remove accidentally placed ignores
 308         air_equivalent = true,
 309         drop = "",
 310         groups = {not_in_creative_inventory=1},
 311 })
 312
 313 -- The hand (bare definition)
 314 minetest.register_item(":", {
 315         type = "none",
 316         groups = {not_in_creative_inventory=1},
 317 })
 318
 319 --
 320 -- Callback registration
 321 --
 322
 323 local function make_registration()
 324         local t = {}
 325         local registerfunc = function(func) table.insert(t, func) end
 326         return t, registerfunc
 327 end
 328
 329 local function make_registration_reverse()
 330         local t = {}
 331         local registerfunc = function(func) table.insert(t, 1, func) end
 332         return t, registerfunc
 333 end
 334
 335 minetest.registered_on_chat_messages, minetest.register_on_chat_message = make_registration()
 336 minetest.registered_globalsteps, minetest.register_globalstep = make_registration()
 337 minetest.registered_on_mapgen_inits, minetest.register_on_mapgen_init = make_registration()
 338 minetest.registered_on_shutdown, minetest.register_on_shutdown = make_registration()
 339 minetest.registered_on_punchnodes, minetest.register_on_punchnode = make_registration()
 340 minetest.registered_on_placenodes, minetest.register_on_placenode = make_registration()
 341 minetest.registered_on_dignodes, minetest.register_on_dignode = make_registration()
 342 minetest.registered_on_generateds, minetest.register_on_generated = make_registration()
 343 minetest.registered_on_newplayers, minetest.register_on_newplayer = make_registration()
 344 minetest.registered_on_dieplayers, minetest.register_on_dieplayer = make_registration()
 345 minetest.registered_on_respawnplayers, minetest.register_on_respawnplayer = make_registration()
 346 minetest.registered_on_joinplayers, minetest.register_on_joinplayer = make_registration()
 347 minetest.registered_on_leaveplayers, minetest.register_on_leaveplayer = make_registration()
 348 minetest.registered_on_player_receive_fields, minetest.register_on_player_receive_fields = make_registration_reverse()
 349 minetest.registered_on_cheats, minetest.register_on_cheat = make_registration()
 350 minetest.registered_on_crafts, minetest.register_on_craft = make_registration()
 351 minetest.registered_craft_predicts, minetest.register_craft_predict = make_registration()
 352 minetest.registered_on_protection_violation, minetest.register_on_protection_violation = make_registration()
 353