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())
330 tp = wielded:get_tool_capabilities()
331 dp = minetest.get_dig_params(def.groups, tp)
332 wielded:add_wear(dp.wear)
333 digger:set_wielded_item(wielded)
336 local _, dropped_item
337 for _, dropped_item in ipairs(drops) do
338 digger:get_inventory():add_item("main", dropped_item)
342 -- Remove node and update
343 minetest.env:remove_node(pos)
347 for _, callback in ipairs(minetest.registered_on_dignodes) do
348 callback(pos, node, digger)
353 -- Item definition defaults
356 minetest.nodedef_default = {
359 -- name intentionally not defined here
362 inventory_image = "",
364 wield_scale = {x=1,y=1,z=1},
367 liquids_pointable = false,
368 tool_capabilities = nil,
370 -- Interaction callbacks
371 on_place = minetest.item_place,
372 on_drop = minetest.item_drop,
375 on_punch = minetest.node_punch,
376 on_dig = minetest.node_dig,
382 special_materials = {
383 {image="", backface_culling=true},
384 {image="", backface_culling=true},
387 post_effect_color = {a=0, r=0, g=0, b=0},
390 is_ground_content = false,
391 sunlight_propagates = false,
396 buildable_to = false,
399 liquid_alternative_flowing = "",
400 liquid_alternative_source = "",
401 liquid_viscosity = 0,
403 damage_per_second = 0,
404 selection_box = {type="regular"},
406 diggablity = "normal",
413 legacy_facedir_simple = false,
414 legacy_wallmounted = false,
417 minetest.craftitemdef_default = {
419 -- name intentionally not defined here
422 inventory_image = "",
424 wield_scale = {x=1,y=1,z=1},
426 liquids_pointable = false,
427 tool_capabilities = nil,
429 -- Interaction callbacks
430 on_place = minetest.item_place,
431 on_drop = minetest.item_drop,
435 minetest.tooldef_default = {
437 -- name intentionally not defined here
440 inventory_image = "",
442 wield_scale = {x=1,y=1,z=1},
444 liquids_pointable = false,
445 tool_capabilities = nil,
447 -- Interaction callbacks
448 on_place = minetest.item_place,
449 on_drop = minetest.item_drop,
453 minetest.noneitemdef_default = { -- This is used for the hand and unknown items
455 -- name intentionally not defined here
458 inventory_image = "",
460 wield_scale = {x=1,y=1,z=1},
462 liquids_pointable = false,
463 tool_capabilities = nil,
465 -- Interaction callbacks
472 -- Make raw registration functions inaccessible to anyone except builtin.lua
475 local register_item_raw = minetest.register_item_raw
476 minetest.register_item_raw = nil
478 local register_alias_raw = minetest.register_alias_raw
479 minetest.register_item_raw = nil
482 -- Item / entity / ABM registration functions
485 minetest.registered_abms = {}
486 minetest.registered_entities = {}
487 minetest.registered_items = {}
488 minetest.registered_nodes = {}
489 minetest.registered_craftitems = {}
490 minetest.registered_tools = {}
491 minetest.registered_aliases = {}
493 -- For tables that are indexed by item name:
494 -- If table[X] does not exist, default to table[minetest.registered_aliases[X]]
495 local function set_alias_metatable(table)
496 setmetatable(table, {
497 __index = function(name)
498 return rawget(table, minetest.registered_aliases[name])
502 set_alias_metatable(minetest.registered_items)
503 set_alias_metatable(minetest.registered_nodes)
504 set_alias_metatable(minetest.registered_craftitems)
505 set_alias_metatable(minetest.registered_tools)
507 -- These item names may not be used because they would interfere
508 -- with legacy itemstrings
509 local forbidden_item_names = {
511 MaterialItem2 = true,
512 MaterialItem3 = true,
522 local function check_modname_prefix(name)
523 if name:sub(1,1) == ":" then
524 -- Escape the modname prefix enforcement mechanism
527 -- Modname prefix enforcement
528 local expected_prefix = minetest.get_current_modname() .. ":"
529 if name:sub(1, #expected_prefix) ~= expected_prefix then
530 error("Name " .. name .. " does not follow naming conventions: " ..
531 "\"modname:\" or \":\" prefix required")
533 local subname = name:sub(#expected_prefix+1)
534 if subname:find("[^abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_]") then
535 error("Name " .. name .. " does not follow naming conventions: " ..
536 "contains unallowed characters")
542 function minetest.register_abm(spec)
543 -- Add to minetest.registered_abms
544 minetest.registered_abms[#minetest.registered_abms+1] = spec
547 function minetest.register_entity(name, prototype)
550 error("Unable to register entity: Name is nil")
552 name = check_modname_prefix(tostring(name))
554 prototype.name = name
555 prototype.__index = prototype -- so that it can be used as a metatable
557 -- Add to minetest.registered_entities
558 minetest.registered_entities[name] = prototype
561 function minetest.register_item(name, itemdef)
564 error("Unable to register item: Name is nil")
566 name = check_modname_prefix(tostring(name))
567 if forbidden_item_names[name] then
568 error("Unable to register item: Name is forbidden: " .. name)
572 -- Apply defaults and add to registered_* table
573 if itemdef.type == "node" then
574 setmetatable(itemdef, {__index = minetest.nodedef_default})
575 minetest.registered_nodes[itemdef.name] = itemdef
576 elseif itemdef.type == "craft" then
577 setmetatable(itemdef, {__index = minetest.craftitemdef_default})
578 minetest.registered_craftitems[itemdef.name] = itemdef
579 elseif itemdef.type == "tool" then
580 setmetatable(itemdef, {__index = minetest.tooldef_default})
581 minetest.registered_tools[itemdef.name] = itemdef
582 elseif itemdef.type == "none" then
583 setmetatable(itemdef, {__index = minetest.noneitemdef_default})
585 error("Unable to register item: Type is invalid: " .. dump(itemdef))
588 -- Flowing liquid uses param2
589 if itemdef.type == "node" and itemdef.liquidtype == "flowing" then
590 itemdef.paramtype2 = "flowingliquid"
593 -- BEGIN Legacy stuff
594 if itemdef.cookresult_itemstring ~= nil and itemdef.cookresult_itemstring ~= "" then
595 minetest.register_craft({
597 output=itemdef.cookresult_itemstring,
599 cooktime=itemdef.furnace_cooktime
602 if itemdef.furnace_burntime ~= nil and itemdef.furnace_burntime >= 0 then
603 minetest.register_craft({
606 burntime=itemdef.furnace_burntime
611 -- Disable all further modifications
612 getmetatable(itemdef).__newindex = {}
614 --minetest.log("Registering item: " .. itemdef.name)
615 minetest.registered_items[itemdef.name] = itemdef
616 minetest.registered_aliases[itemdef.name] = nil
617 register_item_raw(itemdef)
620 function minetest.register_node(name, nodedef)
621 nodedef.type = "node"
622 minetest.register_item(name, nodedef)
625 function minetest.register_craftitem(name, craftitemdef)
626 craftitemdef.type = "craft"
628 -- BEGIN Legacy stuff
629 if craftitemdef.inventory_image == nil and craftitemdef.image ~= nil then
630 craftitemdef.inventory_image = craftitemdef.image
634 minetest.register_item(name, craftitemdef)
637 function minetest.register_tool(name, tooldef)
638 tooldef.type = "tool"
639 tooldef.stack_max = 1
641 -- BEGIN Legacy stuff
642 if tooldef.inventory_image == nil and tooldef.image ~= nil then
643 tooldef.inventory_image = tooldef.image
645 if tooldef.tool_capabilities == nil and
646 (tooldef.full_punch_interval ~= nil or
647 tooldef.basetime ~= nil or
648 tooldef.dt_weight ~= nil or
649 tooldef.dt_crackiness ~= nil or
650 tooldef.dt_crumbliness ~= nil or
651 tooldef.dt_cuttability ~= nil or
652 tooldef.basedurability ~= nil or
653 tooldef.dd_weight ~= nil or
654 tooldef.dd_crackiness ~= nil or
655 tooldef.dd_crumbliness ~= nil or
656 tooldef.dd_cuttability ~= nil) then
657 tooldef.tool_capabilities = {
658 full_punch_interval = tooldef.full_punch_interval,
659 basetime = tooldef.basetime,
660 dt_weight = tooldef.dt_weight,
661 dt_crackiness = tooldef.dt_crackiness,
662 dt_crumbliness = tooldef.dt_crumbliness,
663 dt_cuttability = tooldef.dt_cuttability,
664 basedurability = tooldef.basedurability,
665 dd_weight = tooldef.dd_weight,
666 dd_crackiness = tooldef.dd_crackiness,
667 dd_crumbliness = tooldef.dd_crumbliness,
668 dd_cuttability = tooldef.dd_cuttability,
673 minetest.register_item(name, tooldef)
676 function minetest.register_alias(name, convert_to)
677 if forbidden_item_names[name] then
678 error("Unable to register alias: Name is forbidden: " .. name)
680 if minetest.registered_items[name] ~= nil then
681 minetest.log("WARNING: Not registering alias, item with same name" ..
682 " is already defined: " .. name .. " -> " .. convert_to)
684 --minetest.log("Registering alias: " .. name .. " -> " .. convert_to)
685 minetest.registered_aliases[name] = convert_to
686 register_alias_raw(name, convert_to)
690 -- Alias the forbidden item names to "" so they can't be
691 -- created via itemstrings (e.g. /give)
693 for name in pairs(forbidden_item_names) do
694 minetest.registered_aliases[name] = ""
695 register_alias_raw(name, "")
700 -- Aliases for minetest.register_alias (how ironic...)
701 --minetest.alias_node = minetest.register_alias
702 --minetest.alias_tool = minetest.register_alias
703 --minetest.alias_craftitem = minetest.register_alias
706 -- Built-in node definitions. Also defined in C.
709 minetest.register_item(":", {
711 wield_image = "wieldhand.png",
712 wield_scale = {x=1,y=1,z=2.5},
713 tool_capabilities = {
714 full_punch_interval = 2.0,
717 fleshy = {times={[2]=2.00, [3]=1.00}, maxwear=0, maxlevel=1},
718 crumbly = {times={[3]=0.70}, maxwear=0, maxlevel=1},
719 snappy = {times={[3]=0.70}, maxwear=0, maxlevel=1},
724 minetest.register_item(":unknown", {
726 description = "Unknown Item",
727 inventory_image = "unknown_item.png",
728 on_place = minetest.item_place,
729 on_drop = minetest.item_drop,
732 minetest.register_node(":air", {
733 description = "Air (you hacker you!)",
734 inventory_image = "unknown_block.png",
735 wield_image = "unknown_block.png",
736 drawtype = "airlike",
738 sunlight_propagates = true,
743 air_equivalent = true,
746 minetest.register_node(":ignore", {
747 description = "Ignore (you hacker you!)",
748 inventory_image = "unknown_block.png",
749 wield_image = "unknown_block.png",
750 drawtype = "airlike",
752 sunlight_propagates = false,
756 buildable_to = true, -- A way to remove accidentally placed ignores
757 air_equivalent = true,
761 -- Default material types
764 function minetest.digprop_constanttime(time)
766 diggability = "constant",
767 constant_time = time,
771 function minetest.digprop_stonelike(toughness)
773 diggablity = "normal",
774 weight = toughness * 5,
781 function minetest.digprop_dirtlike(toughness)
783 diggablity = "normal",
784 weight = toughness * 1.2,
791 function minetest.digprop_gravellike(toughness)
793 diggablity = "normal",
794 weight = toughness * 2,
801 function minetest.digprop_woodlike(toughness)
803 diggablity = "normal",
804 weight = toughness * 1.0,
811 function minetest.digprop_leaveslike(toughness)
813 diggablity = "normal",
814 weight = toughness * (-0.5),
821 function minetest.digprop_glasslike(toughness)
823 diggablity = "normal",
824 weight = toughness * 0.1,
832 -- Creative inventory
835 minetest.creative_inventory = {}
837 minetest.add_to_creative_inventory = function(itemstring)
838 table.insert(minetest.creative_inventory, itemstring)
842 -- Callback registration
845 local function make_registration()
847 local registerfunc = function(func) table.insert(t, func) end
848 return t, registerfunc
851 minetest.registered_on_chat_messages, minetest.register_on_chat_message = make_registration()
852 minetest.registered_globalsteps, minetest.register_globalstep = make_registration()
853 minetest.registered_on_placenodes, minetest.register_on_placenode = make_registration()
854 minetest.registered_on_dignodes, minetest.register_on_dignode = make_registration()
855 minetest.registered_on_punchnodes, minetest.register_on_punchnode = make_registration()
856 minetest.registered_on_generateds, minetest.register_on_generated = make_registration()
857 minetest.registered_on_newplayers, minetest.register_on_newplayer = make_registration()
858 minetest.registered_on_dieplayers, minetest.register_on_dieplayer = make_registration()
859 minetest.registered_on_respawnplayers, minetest.register_on_respawnplayer = make_registration()
865 math.randomseed(os.time())