2 -- This file contains built-in stuff in Minetest implemented in Lua.
4 -- It is always loaded and executed after registration of the C API,
5 -- before loading and running any mods.
8 function basic_dump2(o)
9 if type(o) == "number" then
11 elseif type(o) == "string" then
12 return string.format("%q", o)
13 elseif type(o) == "boolean" then
15 elseif type(o) == "function" then
17 elseif type(o) == "userdata" then
19 elseif type(o) == "nil" then
22 error("cannot dump a " .. type(o))
27 function dump2(o, name, dumped)
31 if type(o) == "number" or type(o) == "string" or type(o) == "boolean"
32 or type(o) == "function" or type(o) == "nil"
33 or type(o) == "userdata" then
34 io.write(basic_dump2(o), "\n")
35 elseif type(o) == "table" then
37 io.write(dumped[o], "\n")
40 io.write("{}\n") -- new table
41 for k,v in pairs(o) do
42 local fieldname = string.format("%s[%s]", name, basic_dump2(k))
43 dump2(v, fieldname, dumped)
47 error("cannot dump a " .. type(o))
52 function dump(o, dumped)
54 if type(o) == "number" then
56 elseif type(o) == "string" then
57 return string.format("%q", o)
58 elseif type(o) == "table" then
60 return "<circular reference>"
64 for k,v in pairs(o) do
65 t[#t+1] = "" .. k .. " = " .. dump(v, dumped)
67 return "{" .. table.concat(t, ", ") .. "}"
68 elseif type(o) == "boolean" then
70 elseif type(o) == "function" then
72 elseif type(o) == "userdata" then
74 elseif type(o) == "nil" then
77 error("cannot dump a " .. type(o))
83 -- Item definition helpers
86 function minetest.inventorycube(img1, img2, img3)
89 return "[inventorycube"
90 .. "{" .. img1:gsub("%^", "&")
91 .. "{" .. img2:gsub("%^", "&")
92 .. "{" .. img3:gsub("%^", "&")
95 function minetest.pos_to_string(pos)
96 return "(" .. pos.x .. "," .. pos.y .. "," .. pos.z .. ")"
99 function minetest.get_pointed_thing_position(pointed_thing, above)
100 if pointed_thing.type == "node" then
102 -- The position where a node would be placed
103 return pointed_thing.above
105 -- The position where a node would be dug
106 return pointed_thing.under
108 elseif pointed_thing.type == "object" then
109 obj = pointed_thing.ref
120 function minetest.dir_to_facedir(dir)
121 if math.abs(dir.x) > math.abs(dir.z) then
136 function minetest.dir_to_wallmounted(dir)
137 if math.abs(dir.y) > math.max(math.abs(dir.x), math.abs(dir.z)) then
143 elseif math.abs(dir.x) > math.abs(dir.z) then
158 function minetest.get_node_drops(nodename, toolname)
159 local drop = ItemStack({name=nodename}):get_definition().drop
162 return {ItemStack({name=nodename})}
163 elseif type(drop) == "string" then
165 return {ItemStack(drop)}
166 elseif drop.items == nil then
167 -- drop = {} to disable default drop
171 -- Extended drop table
175 for _, item in ipairs(drop.items) do
176 local good_rarity = true
177 local good_tool = true
178 if item.rarity ~= nil then
179 good_rarity = item.rarity < 1 or math.random(item.rarity) == 1
181 if item.tools ~= nil then
183 for _, tool in ipairs(item.tools) do
184 if tool:sub(1, 1) == '~' then
185 good_tool = toolname:find(tool:sub(2)) ~= nil
187 good_tool = toolname == tool
194 if good_rarity and good_tool then
195 got_count = got_count + 1
196 for _, add_item in ipairs(item.items) do
197 got_items[#got_items+1] = add_item
199 if drop.max_items ~= nil and got_count == drop.max_items then
207 function minetest.item_place_node(itemstack, placer, pointed_thing)
208 local item = itemstack:peek_item()
209 local def = itemstack:get_definition()
210 if def.type == "node" and pointed_thing.type == "node" then
211 local pos = pointed_thing.above
212 local oldnode = minetest.env:get_node(pos)
213 local olddef = ItemStack({name=oldnode.name}):get_definition()
215 if not olddef.buildable_to then
216 minetest.log("info", placer:get_player_name() .. " tried to place"
217 .. " node in invalid position " .. minetest.pos_to_string(pos)
218 .. ", replacing " .. oldnode.name)
222 minetest.log("action", placer:get_player_name() .. " places node "
223 .. def.name .. " at " .. minetest.pos_to_string(pos))
225 local newnode = {name = def.name, param1 = 0, param2 = 0}
227 -- Calculate direction for wall mounted stuff like torches and signs
228 if def.paramtype2 == 'wallmounted' then
229 local under = pointed_thing.under
230 local above = pointed_thing.above
231 local dir = {x = under.x - above.x, y = under.y - above.y, z = under.z - above.z}
232 newnode.param2 = minetest.dir_to_wallmounted(dir)
233 -- Calculate the direction for furnaces and chests and stuff
234 elseif def.paramtype2 == 'facedir' then
235 local playerpos = placer:getpos()
236 local dir = {x = pos.x - playerpos.x, y = pos.y - playerpos.y, z = pos.z - playerpos.z}
237 newnode.param2 = minetest.dir_to_facedir(dir)
238 minetest.log("action", "facedir: " .. newnode.param2)
241 -- Add node and update
242 minetest.env:add_node(pos, newnode)
244 -- Set metadata owner
245 if def.metadata_name ~= "" then
246 minetest.env:get_meta(pos):set_owner(placer:get_player_name())
251 for _, callback in ipairs(minetest.registered_on_placenodes) do
252 callback(pos, newnode, placer)
255 itemstack:take_item()
260 function minetest.item_place_object(itemstack, placer, pointed_thing)
261 local pos = minetest.get_pointed_thing_position(pointed_thing, true)
263 local item = itemstack:take_item()
264 minetest.env:add_item(pos, item)
269 function minetest.item_place(itemstack, placer, pointed_thing)
270 if itemstack:get_definition().type == "node" then
271 return minetest.item_place_node(itemstack, placer, pointed_thing)
273 return minetest.item_place_object(itemstack, placer, pointed_thing)
277 function minetest.item_drop(itemstack, dropper, pos)
278 minetest.env:add_item(pos, itemstack)
282 function minetest.item_eat(hp_change, replace_with_item)
283 return function(itemstack, user, pointed_thing) -- closure
284 if itemstack:take_item() ~= nil then
285 user:set_hp(user:get_hp() + hp_change)
286 itemstack:add_item(replace_with_item) -- note: replace_with_item is optional
292 function minetest.node_punch(pos, node, puncher)
295 for _, callback in ipairs(minetest.registered_on_punchnodes) do
296 callback(pos, node, puncher)
301 function minetest.node_dig(pos, node, digger)
302 minetest.debug("node_dig")
304 local def = ItemStack({name=node.name}):get_definition()
305 if not def.diggable then
306 minetest.debug("not diggable")
307 minetest.log("info", digger:get_player_name() .. " tried to dig "
308 .. node.name .. " which is not diggable "
309 .. minetest.pos_to_string(pos))
313 local meta = minetest.env:get_meta(pos)
314 if meta ~= nil and not meta:get_allow_removal() then
315 minetest.debug("dig prevented by metadata")
316 minetest.log("info", digger:get_player_name() .. " tried to dig "
317 .. node.name .. ", but removal is disabled by metadata "
318 .. minetest.pos_to_string(pos))
322 minetest.log('action', digger:get_player_name() .. " digs "
323 .. node.name .. " at " .. minetest.pos_to_string(pos))
325 if not minetest.setting_getbool("creative_mode") then
326 local wielded = digger:get_wielded_item()
327 local drops = minetest.get_node_drops(node.name, wielded:get_name())
331 tp = wielded:get_tool_digging_properties()
332 dp = minetest.get_digging_properties(mp, tp)
333 wielded:add_wear(dp.wear)
334 digger:set_wielded_item(wielded)
337 local _, dropped_item
338 for _, dropped_item in ipairs(drops) do
339 digger:get_inventory():add_item("main", dropped_item)
343 -- Remove node and update
344 minetest.env:remove_node(pos)
348 for _, callback in ipairs(minetest.registered_on_dignodes) do
349 callback(pos, node, digger)
354 -- Item definition defaults
357 minetest.nodedef_default = {
360 -- name intentionally not defined here
363 inventory_image = "",
365 wield_scale = {x=1,y=1,z=1},
368 liquids_pointable = false,
369 tool_digging_properties = nil,
371 -- Interaction callbacks
372 on_place = minetest.item_place,
373 on_drop = minetest.item_drop,
376 on_punch = minetest.node_punch,
377 on_dig = minetest.node_dig,
383 special_materials = {
384 {image="", backface_culling=true},
385 {image="", backface_culling=true},
388 post_effect_color = {a=0, r=0, g=0, b=0},
391 is_ground_content = false,
392 sunlight_propagates = false,
397 buildable_to = false,
400 liquid_alternative_flowing = "",
401 liquid_alternative_source = "",
402 liquid_viscosity = 0,
404 damage_per_second = 0,
405 selection_box = {type="regular"},
407 diggablity = "normal",
414 legacy_facedir_simple = false,
415 legacy_wallmounted = false,
418 minetest.craftitemdef_default = {
420 -- name intentionally not defined here
423 inventory_image = "",
425 wield_scale = {x=1,y=1,z=1},
427 liquids_pointable = false,
428 tool_digging_properties = nil,
430 -- Interaction callbacks
431 on_place = minetest.item_place,
432 on_drop = minetest.item_drop,
436 minetest.tooldef_default = {
438 -- name intentionally not defined here
441 inventory_image = "",
443 wield_scale = {x=1,y=1,z=1},
445 liquids_pointable = false,
446 tool_digging_properties = nil,
448 -- Interaction callbacks
449 on_place = minetest.item_place,
450 on_drop = minetest.item_drop,
454 minetest.noneitemdef_default = { -- This is used for the hand and unknown items
456 -- name intentionally not defined here
459 inventory_image = "",
461 wield_scale = {x=1,y=1,z=1},
463 liquids_pointable = false,
464 tool_digging_properties = nil,
466 -- Interaction callbacks
473 -- Make raw registration functions inaccessible to anyone except builtin.lua
476 local register_item_raw = minetest.register_item_raw
477 minetest.register_item_raw = nil
479 local register_alias_raw = minetest.register_alias_raw
480 minetest.register_item_raw = nil
483 -- Item / entity / ABM registration functions
486 minetest.registered_abms = {}
487 minetest.registered_entities = {}
488 minetest.registered_items = {}
489 minetest.registered_nodes = {}
490 minetest.registered_craftitems = {}
491 minetest.registered_tools = {}
492 minetest.registered_aliases = {}
494 -- For tables that are indexed by item name:
495 -- If table[X] does not exist, default to table[minetest.registered_aliases[X]]
496 local function set_alias_metatable(table)
497 setmetatable(table, {
498 __index = function(name)
499 return rawget(table, minetest.registered_aliases[name])
503 set_alias_metatable(minetest.registered_items)
504 set_alias_metatable(minetest.registered_nodes)
505 set_alias_metatable(minetest.registered_craftitems)
506 set_alias_metatable(minetest.registered_tools)
508 -- These item names may not be used because they would interfere
509 -- with legacy itemstrings
510 local forbidden_item_names = {
512 MaterialItem2 = true,
513 MaterialItem3 = true,
523 local function check_modname_prefix(name)
524 if name:sub(1,1) == ":" then
525 -- Escape the modname prefix enforcement mechanism
528 -- Modname prefix enforcement
529 local expected_prefix = minetest.get_current_modname() .. ":"
530 if name:sub(1, #expected_prefix) ~= expected_prefix then
531 error("Name " .. name .. " does not follow naming conventions: " ..
532 "\"modname:\" or \":\" prefix required")
534 local subname = name:sub(#expected_prefix+1)
535 if subname:find("[^abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_]") then
536 error("Name " .. name .. " does not follow naming conventions: " ..
537 "contains unallowed characters")
543 function minetest.register_abm(spec)
544 -- Add to minetest.registered_abms
545 minetest.registered_abms[#minetest.registered_abms+1] = spec
548 function minetest.register_entity(name, prototype)
551 error("Unable to register entity: Name is nil")
553 name = check_modname_prefix(tostring(name))
555 prototype.name = name
556 prototype.__index = prototype -- so that it can be used as a metatable
558 -- Add to minetest.registered_entities
559 minetest.registered_entities[name] = prototype
562 function minetest.register_item(name, itemdef)
565 error("Unable to register item: Name is nil")
567 name = check_modname_prefix(tostring(name))
568 if forbidden_item_names[name] then
569 error("Unable to register item: Name is forbidden: " .. name)
573 -- Apply defaults and add to registered_* table
574 if itemdef.type == "node" then
575 setmetatable(itemdef, {__index = minetest.nodedef_default})
576 minetest.registered_nodes[itemdef.name] = itemdef
577 elseif itemdef.type == "craft" then
578 setmetatable(itemdef, {__index = minetest.craftitemdef_default})
579 minetest.registered_craftitems[itemdef.name] = itemdef
580 elseif itemdef.type == "tool" then
581 setmetatable(itemdef, {__index = minetest.tooldef_default})
582 minetest.registered_tools[itemdef.name] = itemdef
583 elseif itemdef.type == "none" then
584 setmetatable(itemdef, {__index = minetest.noneitemdef_default})
586 error("Unable to register item: Type is invalid: " .. dump(itemdef))
589 -- Flowing liquid uses param2
590 if itemdef.type == "node" and itemdef.liquidtype == "flowing" then
591 itemdef.paramtype2 = "flowingliquid"
594 -- BEGIN Legacy stuff
595 if itemdef.cookresult_itemstring ~= nil and itemdef.cookresult_itemstring ~= "" then
596 minetest.register_craft({
598 output=itemdef.cookresult_itemstring,
600 cooktime=itemdef.furnace_cooktime
603 if itemdef.furnace_burntime ~= nil and itemdef.furnace_burntime >= 0 then
604 minetest.register_craft({
607 burntime=itemdef.furnace_burntime
612 -- Disable all further modifications
613 getmetatable(itemdef).__newindex = {}
615 --minetest.log("Registering item: " .. itemdef.name)
616 minetest.registered_items[itemdef.name] = itemdef
617 minetest.registered_aliases[itemdef.name] = nil
618 register_item_raw(itemdef)
621 function minetest.register_node(name, nodedef)
622 nodedef.type = "node"
623 minetest.register_item(name, nodedef)
626 function minetest.register_craftitem(name, craftitemdef)
627 craftitemdef.type = "craft"
629 -- BEGIN Legacy stuff
630 if craftitemdef.inventory_image == nil and craftitemdef.image ~= nil then
631 craftitemdef.inventory_image = craftitemdef.image
635 minetest.register_item(name, craftitemdef)
638 function minetest.register_tool(name, tooldef)
639 tooldef.type = "tool"
640 tooldef.stack_max = 1
642 -- BEGIN Legacy stuff
643 if tooldef.inventory_image == nil and tooldef.image ~= nil then
644 tooldef.inventory_image = tooldef.image
646 if tooldef.tool_digging_properties == nil and
647 (tooldef.full_punch_interval ~= nil or
648 tooldef.basetime ~= nil or
649 tooldef.dt_weight ~= nil or
650 tooldef.dt_crackiness ~= nil or
651 tooldef.dt_crumbliness ~= nil or
652 tooldef.dt_cuttability ~= nil or
653 tooldef.basedurability ~= nil or
654 tooldef.dd_weight ~= nil or
655 tooldef.dd_crackiness ~= nil or
656 tooldef.dd_crumbliness ~= nil or
657 tooldef.dd_cuttability ~= nil) then
658 tooldef.tool_digging_properties = {
659 full_punch_interval = tooldef.full_punch_interval,
660 basetime = tooldef.basetime,
661 dt_weight = tooldef.dt_weight,
662 dt_crackiness = tooldef.dt_crackiness,
663 dt_crumbliness = tooldef.dt_crumbliness,
664 dt_cuttability = tooldef.dt_cuttability,
665 basedurability = tooldef.basedurability,
666 dd_weight = tooldef.dd_weight,
667 dd_crackiness = tooldef.dd_crackiness,
668 dd_crumbliness = tooldef.dd_crumbliness,
669 dd_cuttability = tooldef.dd_cuttability,
674 minetest.register_item(name, tooldef)
677 function minetest.register_alias(name, convert_to)
678 if forbidden_item_names[name] then
679 error("Unable to register alias: Name is forbidden: " .. name)
681 if minetest.registered_items[name] ~= nil then
682 minetest.log("WARNING: Not registering alias, item with same name" ..
683 " is already defined: " .. name .. " -> " .. convert_to)
685 --minetest.log("Registering alias: " .. name .. " -> " .. convert_to)
686 minetest.registered_aliases[name] = convert_to
687 register_alias_raw(name, convert_to)
691 -- Alias the forbidden item names to "" so they can't be
692 -- created via itemstrings (e.g. /give)
694 for name in pairs(forbidden_item_names) do
695 minetest.registered_aliases[name] = ""
696 register_alias_raw(name, "")
701 -- Aliases for minetest.register_alias (how ironic...)
702 --minetest.alias_node = minetest.register_alias
703 --minetest.alias_tool = minetest.register_alias
704 --minetest.alias_craftitem = minetest.register_alias
707 -- Built-in node definitions. Also defined in C.
710 minetest.register_item(":", {
712 wield_image = "wieldhand.png",
713 wield_scale = {x=1,y=1,z=2.5},
714 tool_digging_properties = {
715 full_punch_interval = 2.0,
729 minetest.register_item(":unknown", {
731 description = "Unknown Item",
732 inventory_image = "unknown_item.png",
733 on_place = minetest.item_place,
734 on_drop = minetest.item_drop,
737 minetest.register_node(":air", {
738 description = "Air (you hacker you!)",
739 inventory_image = "unknown_block.png",
740 wield_image = "unknown_block.png",
741 drawtype = "airlike",
743 sunlight_propagates = true,
748 air_equivalent = true,
751 minetest.register_node(":ignore", {
752 description = "Ignore (you hacker you!)",
753 inventory_image = "unknown_block.png",
754 wield_image = "unknown_block.png",
755 drawtype = "airlike",
757 sunlight_propagates = false,
761 buildable_to = true, -- A way to remove accidentally placed ignores
762 air_equivalent = true,
766 -- Default material types
769 function minetest.digprop_constanttime(time)
771 diggability = "constant",
772 constant_time = time,
776 function minetest.digprop_stonelike(toughness)
778 diggablity = "normal",
779 weight = toughness * 5,
786 function minetest.digprop_dirtlike(toughness)
788 diggablity = "normal",
789 weight = toughness * 1.2,
796 function minetest.digprop_gravellike(toughness)
798 diggablity = "normal",
799 weight = toughness * 2,
806 function minetest.digprop_woodlike(toughness)
808 diggablity = "normal",
809 weight = toughness * 1.0,
816 function minetest.digprop_leaveslike(toughness)
818 diggablity = "normal",
819 weight = toughness * (-0.5),
826 function minetest.digprop_glasslike(toughness)
828 diggablity = "normal",
829 weight = toughness * 0.1,
837 -- Creative inventory
840 minetest.creative_inventory = {}
842 minetest.add_to_creative_inventory = function(itemstring)
843 table.insert(minetest.creative_inventory, itemstring)
847 -- Callback registration
850 local function make_registration()
852 local registerfunc = function(func) table.insert(t, func) end
853 return t, registerfunc
856 minetest.registered_on_chat_messages, minetest.register_on_chat_message = make_registration()
857 minetest.registered_globalsteps, minetest.register_globalstep = make_registration()
858 minetest.registered_on_placenodes, minetest.register_on_placenode = make_registration()
859 minetest.registered_on_dignodes, minetest.register_on_dignode = make_registration()
860 minetest.registered_on_punchnodes, minetest.register_on_punchnode = make_registration()
861 minetest.registered_on_generateds, minetest.register_on_generated = make_registration()
862 minetest.registered_on_newplayers, minetest.register_on_newplayer = make_registration()
863 minetest.registered_on_dieplayers, minetest.register_on_dieplayer = make_registration()
864 minetest.registered_on_respawnplayers, minetest.register_on_respawnplayer = make_registration()
870 math.randomseed(os.time())