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"},
405 legacy_facedir_simple = false,
406 legacy_wallmounted = false,
409 minetest.craftitemdef_default = {
411 -- name intentionally not defined here
414 inventory_image = "",
416 wield_scale = {x=1,y=1,z=1},
418 liquids_pointable = false,
419 tool_capabilities = nil,
421 -- Interaction callbacks
422 on_place = minetest.item_place,
423 on_drop = minetest.item_drop,
427 minetest.tooldef_default = {
429 -- name intentionally not defined here
432 inventory_image = "",
434 wield_scale = {x=1,y=1,z=1},
436 liquids_pointable = false,
437 tool_capabilities = nil,
439 -- Interaction callbacks
440 on_place = minetest.item_place,
441 on_drop = minetest.item_drop,
445 minetest.noneitemdef_default = { -- This is used for the hand and unknown items
447 -- name intentionally not defined here
450 inventory_image = "",
452 wield_scale = {x=1,y=1,z=1},
454 liquids_pointable = false,
455 tool_capabilities = nil,
457 -- Interaction callbacks
464 -- Make raw registration functions inaccessible to anyone except builtin.lua
467 local register_item_raw = minetest.register_item_raw
468 minetest.register_item_raw = nil
470 local register_alias_raw = minetest.register_alias_raw
471 minetest.register_item_raw = nil
474 -- Item / entity / ABM registration functions
477 minetest.registered_abms = {}
478 minetest.registered_entities = {}
479 minetest.registered_items = {}
480 minetest.registered_nodes = {}
481 minetest.registered_craftitems = {}
482 minetest.registered_tools = {}
483 minetest.registered_aliases = {}
485 -- For tables that are indexed by item name:
486 -- If table[X] does not exist, default to table[minetest.registered_aliases[X]]
487 local function set_alias_metatable(table)
488 setmetatable(table, {
489 __index = function(name)
490 return rawget(table, minetest.registered_aliases[name])
494 set_alias_metatable(minetest.registered_items)
495 set_alias_metatable(minetest.registered_nodes)
496 set_alias_metatable(minetest.registered_craftitems)
497 set_alias_metatable(minetest.registered_tools)
499 -- These item names may not be used because they would interfere
500 -- with legacy itemstrings
501 local forbidden_item_names = {
503 MaterialItem2 = true,
504 MaterialItem3 = true,
514 local function check_modname_prefix(name)
515 if name:sub(1,1) == ":" then
516 -- Escape the modname prefix enforcement mechanism
519 -- Modname prefix enforcement
520 local expected_prefix = minetest.get_current_modname() .. ":"
521 if name:sub(1, #expected_prefix) ~= expected_prefix then
522 error("Name " .. name .. " does not follow naming conventions: " ..
523 "\"modname:\" or \":\" prefix required")
525 local subname = name:sub(#expected_prefix+1)
526 if subname:find("[^abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_]") then
527 error("Name " .. name .. " does not follow naming conventions: " ..
528 "contains unallowed characters")
534 function minetest.register_abm(spec)
535 -- Add to minetest.registered_abms
536 minetest.registered_abms[#minetest.registered_abms+1] = spec
539 function minetest.register_entity(name, prototype)
542 error("Unable to register entity: Name is nil")
544 name = check_modname_prefix(tostring(name))
546 prototype.name = name
547 prototype.__index = prototype -- so that it can be used as a metatable
549 -- Add to minetest.registered_entities
550 minetest.registered_entities[name] = prototype
553 function minetest.register_item(name, itemdef)
556 error("Unable to register item: Name is nil")
558 name = check_modname_prefix(tostring(name))
559 if forbidden_item_names[name] then
560 error("Unable to register item: Name is forbidden: " .. name)
564 -- Apply defaults and add to registered_* table
565 if itemdef.type == "node" then
566 setmetatable(itemdef, {__index = minetest.nodedef_default})
567 minetest.registered_nodes[itemdef.name] = itemdef
568 elseif itemdef.type == "craft" then
569 setmetatable(itemdef, {__index = minetest.craftitemdef_default})
570 minetest.registered_craftitems[itemdef.name] = itemdef
571 elseif itemdef.type == "tool" then
572 setmetatable(itemdef, {__index = minetest.tooldef_default})
573 minetest.registered_tools[itemdef.name] = itemdef
574 elseif itemdef.type == "none" then
575 setmetatable(itemdef, {__index = minetest.noneitemdef_default})
577 error("Unable to register item: Type is invalid: " .. dump(itemdef))
580 -- Flowing liquid uses param2
581 if itemdef.type == "node" and itemdef.liquidtype == "flowing" then
582 itemdef.paramtype2 = "flowingliquid"
585 -- BEGIN Legacy stuff
586 if itemdef.cookresult_itemstring ~= nil and itemdef.cookresult_itemstring ~= "" then
587 minetest.register_craft({
589 output=itemdef.cookresult_itemstring,
591 cooktime=itemdef.furnace_cooktime
594 if itemdef.furnace_burntime ~= nil and itemdef.furnace_burntime >= 0 then
595 minetest.register_craft({
598 burntime=itemdef.furnace_burntime
603 -- Disable all further modifications
604 getmetatable(itemdef).__newindex = {}
606 --minetest.log("Registering item: " .. itemdef.name)
607 minetest.registered_items[itemdef.name] = itemdef
608 minetest.registered_aliases[itemdef.name] = nil
609 register_item_raw(itemdef)
612 function minetest.register_node(name, nodedef)
613 nodedef.type = "node"
614 minetest.register_item(name, nodedef)
617 function minetest.register_craftitem(name, craftitemdef)
618 craftitemdef.type = "craft"
620 -- BEGIN Legacy stuff
621 if craftitemdef.inventory_image == nil and craftitemdef.image ~= nil then
622 craftitemdef.inventory_image = craftitemdef.image
626 minetest.register_item(name, craftitemdef)
629 function minetest.register_tool(name, tooldef)
630 tooldef.type = "tool"
631 tooldef.stack_max = 1
633 -- BEGIN Legacy stuff
634 if tooldef.inventory_image == nil and tooldef.image ~= nil then
635 tooldef.inventory_image = tooldef.image
637 if tooldef.tool_capabilities == nil and
638 (tooldef.full_punch_interval ~= nil or
639 tooldef.basetime ~= nil or
640 tooldef.dt_weight ~= nil or
641 tooldef.dt_crackiness ~= nil or
642 tooldef.dt_crumbliness ~= nil or
643 tooldef.dt_cuttability ~= nil or
644 tooldef.basedurability ~= nil or
645 tooldef.dd_weight ~= nil or
646 tooldef.dd_crackiness ~= nil or
647 tooldef.dd_crumbliness ~= nil or
648 tooldef.dd_cuttability ~= nil) then
649 tooldef.tool_capabilities = {
650 full_punch_interval = tooldef.full_punch_interval,
651 basetime = tooldef.basetime,
652 dt_weight = tooldef.dt_weight,
653 dt_crackiness = tooldef.dt_crackiness,
654 dt_crumbliness = tooldef.dt_crumbliness,
655 dt_cuttability = tooldef.dt_cuttability,
656 basedurability = tooldef.basedurability,
657 dd_weight = tooldef.dd_weight,
658 dd_crackiness = tooldef.dd_crackiness,
659 dd_crumbliness = tooldef.dd_crumbliness,
660 dd_cuttability = tooldef.dd_cuttability,
665 minetest.register_item(name, tooldef)
668 function minetest.register_alias(name, convert_to)
669 if forbidden_item_names[name] then
670 error("Unable to register alias: Name is forbidden: " .. name)
672 if minetest.registered_items[name] ~= nil then
673 minetest.log("WARNING: Not registering alias, item with same name" ..
674 " is already defined: " .. name .. " -> " .. convert_to)
676 --minetest.log("Registering alias: " .. name .. " -> " .. convert_to)
677 minetest.registered_aliases[name] = convert_to
678 register_alias_raw(name, convert_to)
682 -- Alias the forbidden item names to "" so they can't be
683 -- created via itemstrings (e.g. /give)
685 for name in pairs(forbidden_item_names) do
686 minetest.registered_aliases[name] = ""
687 register_alias_raw(name, "")
692 -- Aliases for minetest.register_alias (how ironic...)
693 --minetest.alias_node = minetest.register_alias
694 --minetest.alias_tool = minetest.register_alias
695 --minetest.alias_craftitem = minetest.register_alias
698 -- Built-in node definitions. Also defined in C.
701 minetest.register_item(":", {
703 wield_image = "wieldhand.png",
704 wield_scale = {x=1,y=1,z=2.5},
705 tool_capabilities = {
706 full_punch_interval = 2.0,
709 fleshy = {times={[2]=2.00, [3]=1.00}, maxwear=0, maxlevel=1},
710 crumbly = {times={[3]=0.70}, maxwear=0, maxlevel=1},
711 snappy = {times={[3]=0.70}, maxwear=0, maxlevel=1},
716 minetest.register_item(":unknown", {
718 description = "Unknown Item",
719 inventory_image = "unknown_item.png",
720 on_place = minetest.item_place,
721 on_drop = minetest.item_drop,
724 minetest.register_node(":air", {
725 description = "Air (you hacker you!)",
726 inventory_image = "unknown_block.png",
727 wield_image = "unknown_block.png",
728 drawtype = "airlike",
730 sunlight_propagates = true,
735 air_equivalent = true,
738 minetest.register_node(":ignore", {
739 description = "Ignore (you hacker you!)",
740 inventory_image = "unknown_block.png",
741 wield_image = "unknown_block.png",
742 drawtype = "airlike",
744 sunlight_propagates = false,
748 buildable_to = true, -- A way to remove accidentally placed ignores
749 air_equivalent = true,
753 -- Default material types
756 function minetest.digprop_constanttime(time)
758 diggability = "constant",
759 constant_time = time,
763 function minetest.digprop_stonelike(toughness)
765 diggablity = "normal",
766 weight = toughness * 5,
773 function minetest.digprop_dirtlike(toughness)
775 diggablity = "normal",
776 weight = toughness * 1.2,
783 function minetest.digprop_gravellike(toughness)
785 diggablity = "normal",
786 weight = toughness * 2,
793 function minetest.digprop_woodlike(toughness)
795 diggablity = "normal",
796 weight = toughness * 1.0,
803 function minetest.digprop_leaveslike(toughness)
805 diggablity = "normal",
806 weight = toughness * (-0.5),
813 function minetest.digprop_glasslike(toughness)
815 diggablity = "normal",
816 weight = toughness * 0.1,
824 -- Creative inventory
827 minetest.creative_inventory = {}
829 minetest.add_to_creative_inventory = function(itemstring)
830 table.insert(minetest.creative_inventory, itemstring)
834 -- Callback registration
837 local function make_registration()
839 local registerfunc = function(func) table.insert(t, func) end
840 return t, registerfunc
843 minetest.registered_on_chat_messages, minetest.register_on_chat_message = make_registration()
844 minetest.registered_globalsteps, minetest.register_globalstep = make_registration()
845 minetest.registered_on_placenodes, minetest.register_on_placenode = make_registration()
846 minetest.registered_on_dignodes, minetest.register_on_dignode = make_registration()
847 minetest.registered_on_punchnodes, minetest.register_on_punchnode = make_registration()
848 minetest.registered_on_generateds, minetest.register_on_generated = make_registration()
849 minetest.registered_on_newplayers, minetest.register_on_newplayer = make_registration()
850 minetest.registered_on_dieplayers, minetest.register_on_dieplayer = make_registration()
851 minetest.registered_on_respawnplayers, minetest.register_on_respawnplayer = make_registration()
857 math.randomseed(os.time())