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                 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})
 116         else
 117                 error("Unable to register item: Type is invalid: " .. dump(itemdef))
 118         end
 119
 120         -- Flowing liquid uses param2
 121         if itemdef.type == "node" and itemdef.liquidtype == "flowing" then
 122                 itemdef.paramtype2 = "flowingliquid"
 123         end
 124
 125         -- BEGIN Legacy stuff
 126         if itemdef.cookresult_itemstring ~= nil and itemdef.cookresult_itemstring ~= "" then
 127                 minetest.register_craft({
 128                         type="cooking",
 129                         output=itemdef.cookresult_itemstring,
 130                         recipe=itemdef.name,
 131                         cooktime=itemdef.furnace_cooktime
 132                 })
 133         end
 134         if itemdef.furnace_burntime ~= nil and itemdef.furnace_burntime >= 0 then
 135                 minetest.register_craft({
 136                         type="fuel",
 137                         recipe=itemdef.name,
 138                         burntime=itemdef.furnace_burntime
 139                 })
 140         end
 141         -- END Legacy stuff
 142
 143         -- Disable all further modifications
 144         getmetatable(itemdef).__newindex = {}
 145
 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)
 150 end
 151
 152 function minetest.register_node(name, nodedef)
 153         nodedef.type = "node"
 154         minetest.register_item(name, nodedef)
 155 end
 156
 157 function minetest.register_craftitem(name, craftitemdef)
 158         craftitemdef.type = "craft"
 159
 160         -- BEGIN Legacy stuff
 161         if craftitemdef.inventory_image == nil and craftitemdef.image ~= nil then
 162                 craftitemdef.inventory_image = craftitemdef.image
 163         end
 164         -- END Legacy stuff
 165
 166         minetest.register_item(name, craftitemdef)
 167 end
 168
 169 function minetest.register_tool(name, tooldef)
 170         tooldef.type = "tool"
 171         tooldef.stack_max = 1
 172
 173         -- BEGIN Legacy stuff
 174         if tooldef.inventory_image == nil and tooldef.image ~= nil then
 175                 tooldef.inventory_image = tooldef.image
 176         end
 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,
 201                 }
 202         end
 203         -- END Legacy stuff
 204
 205         minetest.register_item(name, tooldef)
 206 end
 207
 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)
 211         end
 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)
 215         else
 216                 --minetest.log("Registering alias: " .. name .. " -> " .. convert_to)
 217                 minetest.registered_aliases[name] = convert_to
 218                 register_alias_raw(name, convert_to)
 219         end
 220 end
 221
 222 -- Alias the forbidden item names to "" so they can't be
 223 -- created via itemstrings (e.g. /give)
 224 local name
 225 for name in pairs(forbidden_item_names) do
 226         minetest.registered_aliases[name] = ""
 227         register_alias_raw(name, "")
 228 end
 229
 230
 231 -- Deprecated:
 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
 236
 237 --
 238 -- Built-in node definitions. Also defined in C.
 239 --
 240
 241 minetest.register_item(":unknown", {
 242         type = "none",
 243         description = "Unknown Item",
 244         inventory_image = "unknown_item.png",
 245         on_place = minetest.item_place,
 246         on_drop = minetest.item_drop,
 247 })
 248
 249 minetest.register_node(":air", {
 250         description = "Air (you hacker you!)",
 251         inventory_image = "unknown_block.png",
 252         wield_image = "unknown_block.png",
 253         drawtype = "airlike",
 254         paramtype = "light",
 255         sunlight_propagates = true,
 256         walkable = false,
 257         pointable = false,
 258         diggable = false,
 259         buildable_to = true,
 260         air_equivalent = true,
 261 })
 262
 263 minetest.register_node(":ignore", {
 264         description = "Ignore (you hacker you!)",
 265         inventory_image = "unknown_block.png",
 266         wield_image = "unknown_block.png",
 267         drawtype = "airlike",
 268         paramtype = "none",
 269         sunlight_propagates = false,
 270         walkable = false,
 271         pointable = false,
 272         diggable = false,
 273         buildable_to = true, -- A way to remove accidentally placed ignores
 274         air_equivalent = true,
 275 })
 276
 277 -- The hand (bare definition)
 278 minetest.register_item(":", {
 279         type = "none",
 280 })
 281
 282 --
 283 -- Creative inventory
 284 --
 285
 286 minetest.creative_inventory = {}
 287
 288 minetest.add_to_creative_inventory = function(itemstring)
 289         table.insert(minetest.creative_inventory, itemstring)
 290 end
 291
 292 --
 293 -- Callback registration
 294 --
 295
 296 local function make_registration()
 297         local t = {}
 298         local registerfunc = function(func) table.insert(t, func) end
 299         return t, registerfunc
 300 end
 301
 302 minetest.registered_on_chat_messages, minetest.register_on_chat_message = make_registration()
 303 minetest.registered_globalsteps, minetest.register_globalstep = make_registration()
 304 minetest.registered_on_placenodes, minetest.register_on_placenode = make_registration()
 305 minetest.registered_on_dignodes, minetest.register_on_dignode = make_registration()
 306 minetest.registered_on_punchnodes, minetest.register_on_punchnode = make_registration()
 307 minetest.registered_on_generateds, minetest.register_on_generated = make_registration()
 308 minetest.registered_on_newplayers, minetest.register_on_newplayer = make_registration()
 309 minetest.registered_on_dieplayers, minetest.register_on_dieplayer = make_registration()
 310 minetest.registered_on_respawnplayers, minetest.register_on_respawnplayer = make_registration()
 311 minetest.registered_on_joinplayers, minetest.register_on_joinplayer = make_registration()
 312 minetest.registered_on_leaveplayers, minetest.register_on_leaveplayer = make_registration()
 313
 314