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.
9 -- Override some Lua library functions
12 print = minetest.debug
18 function basic_dump2(o)
19 if type(o) == "number" then
21 elseif type(o) == "string" then
22 return string.format("%q", o)
23 elseif type(o) == "boolean" then
25 elseif type(o) == "function" then
27 elseif type(o) == "userdata" then
29 elseif type(o) == "nil" then
32 error("cannot dump a " .. type(o))
37 function dump2(o, name, dumped)
41 if type(o) == "number" or type(o) == "string" or type(o) == "boolean"
42 or type(o) == "function" or type(o) == "nil"
43 or type(o) == "userdata" then
44 io.write(basic_dump2(o), "\n")
45 elseif type(o) == "table" then
47 io.write(dumped[o], "\n")
50 io.write("{}\n") -- new table
51 for k,v in pairs(o) do
52 local fieldname = string.format("%s[%s]", name, basic_dump2(k))
53 dump2(v, fieldname, dumped)
57 error("cannot dump a " .. type(o))
62 function dump(o, dumped)
64 if type(o) == "number" then
66 elseif type(o) == "string" then
67 return string.format("%q", o)
68 elseif type(o) == "table" then
70 return "<circular reference>"
74 for k,v in pairs(o) do
75 t[#t+1] = "" .. k .. " = " .. dump(v, dumped)
77 return "{" .. table.concat(t, ", ") .. "}"
78 elseif type(o) == "boolean" then
80 elseif type(o) == "function" then
82 elseif type(o) == "userdata" then
84 elseif type(o) == "nil" then
87 error("cannot dump a " .. type(o))
93 -- Item definition helpers
96 function minetest.inventorycube(img1, img2, img3)
99 return "[inventorycube"
100 .. "{" .. img1:gsub("%^", "&")
101 .. "{" .. img2:gsub("%^", "&")
102 .. "{" .. img3:gsub("%^", "&")
105 function minetest.pos_to_string(pos)
106 return "(" .. pos.x .. "," .. pos.y .. "," .. pos.z .. ")"
109 function minetest.get_pointed_thing_position(pointed_thing, above)
110 if pointed_thing.type == "node" then
112 -- The position where a node would be placed
113 return pointed_thing.above
115 -- The position where a node would be dug
116 return pointed_thing.under
118 elseif pointed_thing.type == "object" then
119 obj = pointed_thing.ref
130 function minetest.dir_to_facedir(dir)
131 if math.abs(dir.x) > math.abs(dir.z) then
146 function minetest.dir_to_wallmounted(dir)
147 if math.abs(dir.y) > math.max(math.abs(dir.x), math.abs(dir.z)) then
153 elseif math.abs(dir.x) > math.abs(dir.z) then
168 function minetest.get_node_drops(nodename, toolname)
169 local drop = ItemStack({name=nodename}):get_definition().drop
172 return {ItemStack({name=nodename})}
173 elseif type(drop) == "string" then
175 return {ItemStack(drop)}
176 elseif drop.items == nil then
177 -- drop = {} to disable default drop
181 -- Extended drop table
185 for _, item in ipairs(drop.items) do
186 local good_rarity = true
187 local good_tool = true
188 if item.rarity ~= nil then
189 good_rarity = item.rarity < 1 or math.random(item.rarity) == 1
191 if item.tools ~= nil then
193 for _, tool in ipairs(item.tools) do
194 if tool:sub(1, 1) == '~' then
195 good_tool = toolname:find(tool:sub(2)) ~= nil
197 good_tool = toolname == tool
204 if good_rarity and good_tool then
205 got_count = got_count + 1
206 for _, add_item in ipairs(item.items) do
207 got_items[#got_items+1] = add_item
209 if drop.max_items ~= nil and got_count == drop.max_items then
217 function minetest.item_place_node(itemstack, placer, pointed_thing)
218 local item = itemstack:peek_item()
219 local def = itemstack:get_definition()
220 if def.type == "node" and pointed_thing.type == "node" then
221 local pos = pointed_thing.above
222 local oldnode = minetest.env:get_node(pos)
223 local olddef = ItemStack({name=oldnode.name}):get_definition()
225 if not olddef.buildable_to then
226 minetest.log("info", placer:get_player_name() .. " tried to place"
227 .. " node in invalid position " .. minetest.pos_to_string(pos)
228 .. ", replacing " .. oldnode.name)
232 minetest.log("action", placer:get_player_name() .. " places node "
233 .. def.name .. " at " .. minetest.pos_to_string(pos))
235 local newnode = {name = def.name, param1 = 0, param2 = 0}
237 -- Calculate direction for wall mounted stuff like torches and signs
238 if def.paramtype2 == 'wallmounted' then
239 local under = pointed_thing.under
240 local above = pointed_thing.above
241 local dir = {x = under.x - above.x, y = under.y - above.y, z = under.z - above.z}
242 newnode.param2 = minetest.dir_to_wallmounted(dir)
243 -- Calculate the direction for furnaces and chests and stuff
244 elseif def.paramtype2 == 'facedir' then
245 local playerpos = placer:getpos()
246 local dir = {x = pos.x - playerpos.x, y = pos.y - playerpos.y, z = pos.z - playerpos.z}
247 newnode.param2 = minetest.dir_to_facedir(dir)
248 minetest.log("action", "facedir: " .. newnode.param2)
251 -- Add node and update
252 minetest.env:add_node(pos, newnode)
254 -- Set metadata owner
255 if def.metadata_name ~= "" then
256 minetest.env:get_meta(pos):set_owner(placer:get_player_name())
261 for _, callback in ipairs(minetest.registered_on_placenodes) do
262 callback(pos, newnode, placer)
265 itemstack:take_item()
270 function minetest.item_place_object(itemstack, placer, pointed_thing)
271 local pos = minetest.get_pointed_thing_position(pointed_thing, true)
273 local item = itemstack:take_item()
274 minetest.env:add_item(pos, item)
279 function minetest.item_place(itemstack, placer, pointed_thing)
280 if itemstack:get_definition().type == "node" then
281 return minetest.item_place_node(itemstack, placer, pointed_thing)
283 return minetest.item_place_object(itemstack, placer, pointed_thing)
287 function minetest.item_drop(itemstack, dropper, pos)
288 minetest.env:add_item(pos, itemstack)
292 function minetest.item_eat(hp_change, replace_with_item)
293 return function(itemstack, user, pointed_thing) -- closure
294 if itemstack:take_item() ~= nil then
295 user:set_hp(user:get_hp() + hp_change)
296 itemstack:add_item(replace_with_item) -- note: replace_with_item is optional
302 function minetest.node_punch(pos, node, puncher)
305 for _, callback in ipairs(minetest.registered_on_punchnodes) do
306 callback(pos, node, puncher)
311 function minetest.node_dig(pos, node, digger)
312 minetest.debug("node_dig")
314 local def = ItemStack({name=node.name}):get_definition()
315 if not def.diggable then
316 minetest.debug("not diggable")
317 minetest.log("info", digger:get_player_name() .. " tried to dig "
318 .. node.name .. " which is not diggable "
319 .. minetest.pos_to_string(pos))
323 local meta = minetest.env:get_meta(pos)
324 if meta ~= nil and not meta:get_allow_removal() then
325 minetest.debug("dig prevented by metadata")
326 minetest.log("info", digger:get_player_name() .. " tried to dig "
327 .. node.name .. ", but removal is disabled by metadata "
328 .. minetest.pos_to_string(pos))
332 minetest.log('action', digger:get_player_name() .. " digs "
333 .. node.name .. " at " .. minetest.pos_to_string(pos))
335 if not minetest.setting_getbool("creative_mode") then
336 local wielded = digger:get_wielded_item()
337 local drops = minetest.get_node_drops(node.name, wielded:get_name())
340 tp = wielded:get_tool_capabilities()
341 dp = minetest.get_dig_params(def.groups, tp)
342 wielded:add_wear(dp.wear)
343 digger:set_wielded_item(wielded)
346 local _, dropped_item
347 for _, dropped_item in ipairs(drops) do
348 digger:get_inventory():add_item("main", dropped_item)
352 -- Remove node and update
353 minetest.env:remove_node(pos)
357 for _, callback in ipairs(minetest.registered_on_dignodes) do
358 callback(pos, node, digger)
363 -- Item definition defaults
366 minetest.nodedef_default = {
369 -- name intentionally not defined here
372 inventory_image = "",
374 wield_scale = {x=1,y=1,z=1},
377 liquids_pointable = false,
378 tool_capabilities = nil,
380 -- Interaction callbacks
381 on_place = minetest.item_place,
382 on_drop = minetest.item_drop,
385 on_punch = minetest.node_punch,
386 on_dig = minetest.node_dig,
392 special_materials = {
393 {image="", backface_culling=true},
394 {image="", backface_culling=true},
397 post_effect_color = {a=0, r=0, g=0, b=0},
400 is_ground_content = false,
401 sunlight_propagates = false,
406 buildable_to = false,
409 liquid_alternative_flowing = "",
410 liquid_alternative_source = "",
411 liquid_viscosity = 0,
413 damage_per_second = 0,
414 selection_box = {type="regular"},
415 legacy_facedir_simple = false,
416 legacy_wallmounted = false,
419 minetest.craftitemdef_default = {
421 -- name intentionally not defined here
424 inventory_image = "",
426 wield_scale = {x=1,y=1,z=1},
428 liquids_pointable = false,
429 tool_capabilities = nil,
431 -- Interaction callbacks
432 on_place = minetest.item_place,
433 on_drop = minetest.item_drop,
437 minetest.tooldef_default = {
439 -- name intentionally not defined here
442 inventory_image = "",
444 wield_scale = {x=1,y=1,z=1},
446 liquids_pointable = false,
447 tool_capabilities = nil,
449 -- Interaction callbacks
450 on_place = minetest.item_place,
451 on_drop = minetest.item_drop,
455 minetest.noneitemdef_default = { -- This is used for the hand and unknown items
457 -- name intentionally not defined here
460 inventory_image = "",
462 wield_scale = {x=1,y=1,z=1},
464 liquids_pointable = false,
465 tool_capabilities = nil,
467 -- Interaction callbacks
474 -- Make raw registration functions inaccessible to anyone except builtin.lua
477 local register_item_raw = minetest.register_item_raw
478 minetest.register_item_raw = nil
480 local register_alias_raw = minetest.register_alias_raw
481 minetest.register_item_raw = nil
484 -- Item / entity / ABM registration functions
487 minetest.registered_abms = {}
488 minetest.registered_entities = {}
489 minetest.registered_items = {}
490 minetest.registered_nodes = {}
491 minetest.registered_craftitems = {}
492 minetest.registered_tools = {}
493 minetest.registered_aliases = {}
495 -- For tables that are indexed by item name:
496 -- If table[X] does not exist, default to table[minetest.registered_aliases[X]]
497 local function set_alias_metatable(table)
498 setmetatable(table, {
499 __index = function(name)
500 return rawget(table, minetest.registered_aliases[name])
504 set_alias_metatable(minetest.registered_items)
505 set_alias_metatable(minetest.registered_nodes)
506 set_alias_metatable(minetest.registered_craftitems)
507 set_alias_metatable(minetest.registered_tools)
509 -- These item names may not be used because they would interfere
510 -- with legacy itemstrings
511 local forbidden_item_names = {
513 MaterialItem2 = true,
514 MaterialItem3 = true,
524 local function check_modname_prefix(name)
525 if name:sub(1,1) == ":" then
526 -- Escape the modname prefix enforcement mechanism
529 -- Modname prefix enforcement
530 local expected_prefix = minetest.get_current_modname() .. ":"
531 if name:sub(1, #expected_prefix) ~= expected_prefix then
532 error("Name " .. name .. " does not follow naming conventions: " ..
533 "\"modname:\" or \":\" prefix required")
535 local subname = name:sub(#expected_prefix+1)
536 if subname:find("[^abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_]") then
537 error("Name " .. name .. " does not follow naming conventions: " ..
538 "contains unallowed characters")
544 function minetest.register_abm(spec)
545 -- Add to minetest.registered_abms
546 minetest.registered_abms[#minetest.registered_abms+1] = spec
549 function minetest.register_entity(name, prototype)
552 error("Unable to register entity: Name is nil")
554 name = check_modname_prefix(tostring(name))
556 prototype.name = name
557 prototype.__index = prototype -- so that it can be used as a metatable
559 -- Add to minetest.registered_entities
560 minetest.registered_entities[name] = prototype
563 function minetest.register_item(name, itemdef)
566 error("Unable to register item: Name is nil")
568 name = check_modname_prefix(tostring(name))
569 if forbidden_item_names[name] then
570 error("Unable to register item: Name is forbidden: " .. name)
574 -- Apply defaults and add to registered_* table
575 if itemdef.type == "node" then
576 setmetatable(itemdef, {__index = minetest.nodedef_default})
577 minetest.registered_nodes[itemdef.name] = itemdef
578 elseif itemdef.type == "craft" then
579 setmetatable(itemdef, {__index = minetest.craftitemdef_default})
580 minetest.registered_craftitems[itemdef.name] = itemdef
581 elseif itemdef.type == "tool" then
582 setmetatable(itemdef, {__index = minetest.tooldef_default})
583 minetest.registered_tools[itemdef.name] = itemdef
584 elseif itemdef.type == "none" then
585 setmetatable(itemdef, {__index = minetest.noneitemdef_default})
587 error("Unable to register item: Type is invalid: " .. dump(itemdef))
590 -- Flowing liquid uses param2
591 if itemdef.type == "node" and itemdef.liquidtype == "flowing" then
592 itemdef.paramtype2 = "flowingliquid"
595 -- BEGIN Legacy stuff
596 if itemdef.cookresult_itemstring ~= nil and itemdef.cookresult_itemstring ~= "" then
597 minetest.register_craft({
599 output=itemdef.cookresult_itemstring,
601 cooktime=itemdef.furnace_cooktime
604 if itemdef.furnace_burntime ~= nil and itemdef.furnace_burntime >= 0 then
605 minetest.register_craft({
608 burntime=itemdef.furnace_burntime
613 -- Disable all further modifications
614 getmetatable(itemdef).__newindex = {}
616 --minetest.log("Registering item: " .. itemdef.name)
617 minetest.registered_items[itemdef.name] = itemdef
618 minetest.registered_aliases[itemdef.name] = nil
619 register_item_raw(itemdef)
622 function minetest.register_node(name, nodedef)
623 nodedef.type = "node"
624 minetest.register_item(name, nodedef)
627 function minetest.register_craftitem(name, craftitemdef)
628 craftitemdef.type = "craft"
630 -- BEGIN Legacy stuff
631 if craftitemdef.inventory_image == nil and craftitemdef.image ~= nil then
632 craftitemdef.inventory_image = craftitemdef.image
636 minetest.register_item(name, craftitemdef)
639 function minetest.register_tool(name, tooldef)
640 tooldef.type = "tool"
641 tooldef.stack_max = 1
643 -- BEGIN Legacy stuff
644 if tooldef.inventory_image == nil and tooldef.image ~= nil then
645 tooldef.inventory_image = tooldef.image
647 if tooldef.tool_capabilities == nil and
648 (tooldef.full_punch_interval ~= nil or
649 tooldef.basetime ~= nil or
650 tooldef.dt_weight ~= nil or
651 tooldef.dt_crackiness ~= nil or
652 tooldef.dt_crumbliness ~= nil or
653 tooldef.dt_cuttability ~= nil or
654 tooldef.basedurability ~= nil or
655 tooldef.dd_weight ~= nil or
656 tooldef.dd_crackiness ~= nil or
657 tooldef.dd_crumbliness ~= nil or
658 tooldef.dd_cuttability ~= nil) then
659 tooldef.tool_capabilities = {
660 full_punch_interval = tooldef.full_punch_interval,
661 basetime = tooldef.basetime,
662 dt_weight = tooldef.dt_weight,
663 dt_crackiness = tooldef.dt_crackiness,
664 dt_crumbliness = tooldef.dt_crumbliness,
665 dt_cuttability = tooldef.dt_cuttability,
666 basedurability = tooldef.basedurability,
667 dd_weight = tooldef.dd_weight,
668 dd_crackiness = tooldef.dd_crackiness,
669 dd_crumbliness = tooldef.dd_crumbliness,
670 dd_cuttability = tooldef.dd_cuttability,
675 minetest.register_item(name, tooldef)
678 function minetest.register_alias(name, convert_to)
679 if forbidden_item_names[name] then
680 error("Unable to register alias: Name is forbidden: " .. name)
682 if minetest.registered_items[name] ~= nil then
683 minetest.log("WARNING: Not registering alias, item with same name" ..
684 " is already defined: " .. name .. " -> " .. convert_to)
686 --minetest.log("Registering alias: " .. name .. " -> " .. convert_to)
687 minetest.registered_aliases[name] = convert_to
688 register_alias_raw(name, convert_to)
692 -- Alias the forbidden item names to "" so they can't be
693 -- created via itemstrings (e.g. /give)
695 for name in pairs(forbidden_item_names) do
696 minetest.registered_aliases[name] = ""
697 register_alias_raw(name, "")
702 -- Aliases for minetest.register_alias (how ironic...)
703 --minetest.alias_node = minetest.register_alias
704 --minetest.alias_tool = minetest.register_alias
705 --minetest.alias_craftitem = minetest.register_alias
708 -- Built-in node definitions. Also defined in C.
711 minetest.register_item(":unknown", {
713 description = "Unknown Item",
714 inventory_image = "unknown_item.png",
715 on_place = minetest.item_place,
716 on_drop = minetest.item_drop,
719 minetest.register_node(":air", {
720 description = "Air (you hacker you!)",
721 inventory_image = "unknown_block.png",
722 wield_image = "unknown_block.png",
723 drawtype = "airlike",
725 sunlight_propagates = true,
730 air_equivalent = true,
733 minetest.register_node(":ignore", {
734 description = "Ignore (you hacker you!)",
735 inventory_image = "unknown_block.png",
736 wield_image = "unknown_block.png",
737 drawtype = "airlike",
739 sunlight_propagates = false,
743 buildable_to = true, -- A way to remove accidentally placed ignores
744 air_equivalent = true,
747 -- The hand (bare definition)
748 minetest.register_item(":", {
753 -- Default material types
755 function digprop_err()
756 minetest.log("info", debug.traceback())
757 minetest.log("info", "WARNING: The minetest.digprop_* functions are obsolete and need to be replaced by item groups.")
760 minetest.digprop_constanttime = digprop_err
761 minetest.digprop_stonelike = digprop_err
762 minetest.digprop_dirtlike = digprop_err
763 minetest.digprop_gravellike = digprop_err
764 minetest.digprop_woodlike = digprop_err
765 minetest.digprop_leaveslike = digprop_err
766 minetest.digprop_glasslike = digprop_err
769 -- Creative inventory
772 minetest.creative_inventory = {}
774 minetest.add_to_creative_inventory = function(itemstring)
775 table.insert(minetest.creative_inventory, itemstring)
779 -- Callback registration
782 local function make_registration()
784 local registerfunc = function(func) table.insert(t, func) end
785 return t, registerfunc
788 minetest.registered_on_chat_messages, minetest.register_on_chat_message = make_registration()
789 minetest.registered_globalsteps, minetest.register_globalstep = make_registration()
790 minetest.registered_on_placenodes, minetest.register_on_placenode = make_registration()
791 minetest.registered_on_dignodes, minetest.register_on_dignode = make_registration()
792 minetest.registered_on_punchnodes, minetest.register_on_punchnode = make_registration()
793 minetest.registered_on_generateds, minetest.register_on_generated = make_registration()
794 minetest.registered_on_newplayers, minetest.register_on_newplayer = make_registration()
795 minetest.registered_on_dieplayers, minetest.register_on_dieplayer = make_registration()
796 minetest.registered_on_respawnplayers, minetest.register_on_respawnplayer = make_registration()
799 -- Misc. API functions
802 minetest.timers_to_add = {}
804 minetest.register_globalstep(function(dtime)
805 for _, timer in ipairs(minetest.timers_to_add) do
806 table.insert(minetest.timers, timer)
808 minetest.timers_to_add = {}
809 for index, timer in ipairs(minetest.timers) do
810 timer.time = timer.time - dtime
811 if timer.time <= 0 then
812 timer.func(timer.param)
813 table.remove(minetest.timers,index)
818 function minetest.after(time, func, param)
819 table.insert(minetest.timers_to_add, {time=time, func=func, param=param})
826 math.randomseed(os.time())