1 -- Minetest: builtin/item.lua
3 local builtin_shared = ...
5 local function copy_pointed_thing(pointed_thing)
7 type = pointed_thing.type,
8 above = vector.new(pointed_thing.above),
9 under = vector.new(pointed_thing.under),
10 ref = pointed_thing.ref,
15 -- Item definition helpers
18 function core.inventorycube(img1, img2, img3)
21 return "[inventorycube"
22 .. "{" .. img1:gsub("%^", "&")
23 .. "{" .. img2:gsub("%^", "&")
24 .. "{" .. img3:gsub("%^", "&")
27 function core.get_pointed_thing_position(pointed_thing, above)
28 if pointed_thing.type == "node" then
30 -- The position where a node would be placed
31 return pointed_thing.above
33 -- The position where a node would be dug
34 return pointed_thing.under
35 elseif pointed_thing.type == "object" then
36 return pointed_thing.ref and pointed_thing.ref:get_pos()
40 function core.dir_to_facedir(dir, is6d)
41 --account for y if requested
42 if is6d and math.abs(dir.y) > math.abs(dir.x) and math.abs(dir.y) > math.abs(dir.z) then
46 if math.abs(dir.x) > math.abs(dir.z) then
62 if math.abs(dir.x) > math.abs(dir.z) then
77 --otherwise, place horizontally
78 elseif math.abs(dir.x) > math.abs(dir.z) then
93 -- Table of possible dirs
94 local facedir_to_dir = {
102 -- Mapping from facedir value to index in facedir_to_dir.
103 local facedir_to_dir_map = {
111 function core.facedir_to_dir(facedir)
112 return facedir_to_dir[facedir_to_dir_map[facedir % 32]]
115 function core.dir_to_wallmounted(dir)
116 if math.abs(dir.y) > math.max(math.abs(dir.x), math.abs(dir.z)) then
122 elseif math.abs(dir.x) > math.abs(dir.z) then
137 -- table of dirs in wallmounted order
138 local wallmounted_to_dir = {
139 [0] = {x = 0, y = 1, z = 0},
140 {x = 0, y = -1, z = 0},
141 {x = 1, y = 0, z = 0},
142 {x = -1, y = 0, z = 0},
143 {x = 0, y = 0, z = 1},
144 {x = 0, y = 0, z = -1},
146 function core.wallmounted_to_dir(wallmounted)
147 return wallmounted_to_dir[wallmounted % 8]
150 function core.dir_to_yaw(dir)
151 return -math.atan2(dir.x, dir.z)
154 function core.yaw_to_dir(yaw)
155 return {x = -math.sin(yaw), y = 0, z = math.cos(yaw)}
158 function core.is_colored_paramtype(ptype)
159 return (ptype == "color") or (ptype == "colorfacedir") or
160 (ptype == "colorwallmounted")
163 function core.strip_param2_color(param2, paramtype2)
164 if not core.is_colored_paramtype(paramtype2) then
167 if paramtype2 == "colorfacedir" then
168 param2 = math.floor(param2 / 32) * 32
169 elseif paramtype2 == "colorwallmounted" then
170 param2 = math.floor(param2 / 8) * 8
172 -- paramtype2 == "color" requires no modification.
176 function core.get_node_drops(node, toolname)
177 -- Compatibility, if node is string
178 local nodename = node
180 -- New format, if node is table
181 if (type(node) == "table") then
185 local def = core.registered_nodes[nodename]
186 local drop = def and def.drop
187 local ptype = def and def.paramtype2
188 -- get color, if there is color (otherwise nil)
189 local palette_index = core.strip_param2_color(param2, ptype)
192 if palette_index then
193 local stack = ItemStack(nodename)
194 stack:get_meta():set_int("palette_index", palette_index)
195 return {stack:to_string()}
198 elseif type(drop) == "string" then
200 return drop ~= "" and {drop} or {}
201 elseif drop.items == nil then
202 -- drop = {} to disable default drop
206 -- Extended drop table
210 for _, item in ipairs(drop.items) do
211 local good_rarity = true
212 local good_tool = true
213 if item.rarity ~= nil then
214 good_rarity = item.rarity < 1 or math.random(item.rarity) == 1
216 if item.tools ~= nil then
219 if item.tools ~= nil and toolname then
220 for _, tool in ipairs(item.tools) do
221 if tool:sub(1, 1) == '~' then
222 good_tool = toolname:find(tool:sub(2)) ~= nil
224 good_tool = toolname == tool
231 if good_rarity and good_tool then
232 got_count = got_count + 1
233 for _, add_item in ipairs(item.items) do
234 -- add color, if necessary
235 if item.inherit_color and palette_index then
236 local stack = ItemStack(add_item)
237 stack:get_meta():set_int("palette_index", palette_index)
238 add_item = stack:to_string()
240 got_items[#got_items+1] = add_item
242 if drop.max_items ~= nil and got_count == drop.max_items then
250 local function user_name(user)
251 return user and user:get_player_name() or ""
254 -- Returns a logging function. For empty names, does not log.
255 local function make_log(name)
256 return name ~= "" and core.log or function() end
259 function core.item_place_node(itemstack, placer, pointed_thing, param2,
261 local def = itemstack:get_definition()
262 if def.type ~= "node" or pointed_thing.type ~= "node" then
263 return itemstack, false
266 local under = pointed_thing.under
267 local oldnode_under = core.get_node_or_nil(under)
268 local above = pointed_thing.above
269 local oldnode_above = core.get_node_or_nil(above)
270 local playername = user_name(placer)
271 local log = make_log(playername)
273 if not oldnode_under or not oldnode_above then
274 log("info", playername .. " tried to place"
275 .. " node in unloaded position " .. core.pos_to_string(above))
276 return itemstack, false
279 local olddef_under = core.registered_nodes[oldnode_under.name]
280 olddef_under = olddef_under or core.nodedef_default
281 local olddef_above = core.registered_nodes[oldnode_above.name]
282 olddef_above = olddef_above or core.nodedef_default
284 if not olddef_above.buildable_to and not olddef_under.buildable_to then
285 log("info", playername .. " tried to place"
286 .. " node in invalid position " .. core.pos_to_string(above)
287 .. ", replacing " .. oldnode_above.name)
288 return itemstack, false
291 -- Place above pointed node
292 local place_to = {x = above.x, y = above.y, z = above.z}
294 -- If node under is buildable_to, place into it instead (eg. snow)
295 if olddef_under.buildable_to then
296 log("info", "node under is buildable to")
297 place_to = {x = under.x, y = under.y, z = under.z}
300 if core.is_protected(place_to, playername) then
301 log("action", playername
302 .. " tried to place " .. def.name
303 .. " at protected position "
304 .. core.pos_to_string(place_to))
305 core.record_protection_violation(place_to, playername)
309 log("action", playername .. " places node "
310 .. def.name .. " at " .. core.pos_to_string(place_to))
312 local oldnode = core.get_node(place_to)
313 local newnode = {name = def.name, param1 = 0, param2 = param2 or 0}
315 -- Calculate direction for wall mounted stuff like torches and signs
316 if def.place_param2 ~= nil then
317 newnode.param2 = def.place_param2
318 elseif (def.paramtype2 == "wallmounted" or
319 def.paramtype2 == "colorwallmounted") and not param2 then
321 x = under.x - above.x,
322 y = under.y - above.y,
323 z = under.z - above.z
325 newnode.param2 = core.dir_to_wallmounted(dir)
326 -- Calculate the direction for furnaces and chests and stuff
327 elseif (def.paramtype2 == "facedir" or
328 def.paramtype2 == "colorfacedir") and not param2 then
329 local placer_pos = placer and placer:get_pos()
332 x = above.x - placer_pos.x,
333 y = above.y - placer_pos.y,
334 z = above.z - placer_pos.z
336 newnode.param2 = core.dir_to_facedir(dir)
337 log("action", "facedir: " .. newnode.param2)
341 local metatable = itemstack:get_meta():to_table().fields
343 -- Transfer color information
344 if metatable.palette_index and not def.place_param2 then
345 local color_divisor = nil
346 if def.paramtype2 == "color" then
348 elseif def.paramtype2 == "colorwallmounted" then
350 elseif def.paramtype2 == "colorfacedir" then
353 if color_divisor then
354 local color = math.floor(metatable.palette_index / color_divisor)
355 local other = newnode.param2 % color_divisor
356 newnode.param2 = color * color_divisor + other
360 -- Check if the node is attached and if it can be placed there
361 if core.get_item_group(def.name, "attached_node") ~= 0 and
362 not builtin_shared.check_attached_node(place_to, newnode) then
363 log("action", "attached node " .. def.name ..
364 " can not be placed at " .. core.pos_to_string(place_to))
365 return itemstack, false
368 -- Add node and update
369 core.add_node(place_to, newnode)
371 local take_item = true
374 if def.after_place_node and not prevent_after_place then
375 -- Deepcopy place_to and pointed_thing because callback can modify it
376 local place_to_copy = {x=place_to.x, y=place_to.y, z=place_to.z}
377 local pointed_thing_copy = copy_pointed_thing(pointed_thing)
378 if def.after_place_node(place_to_copy, placer, itemstack,
379 pointed_thing_copy) then
385 for _, callback in ipairs(core.registered_on_placenodes) do
386 -- Deepcopy pos, node and pointed_thing because callback can modify them
387 local place_to_copy = {x=place_to.x, y=place_to.y, z=place_to.z}
388 local newnode_copy = {name=newnode.name, param1=newnode.param1, param2=newnode.param2}
389 local oldnode_copy = {name=oldnode.name, param1=oldnode.param1, param2=oldnode.param2}
390 local pointed_thing_copy = copy_pointed_thing(pointed_thing)
391 if callback(place_to_copy, newnode_copy, placer, oldnode_copy, itemstack, pointed_thing_copy) then
397 itemstack:take_item()
399 return itemstack, true
402 function core.item_place_object(itemstack, placer, pointed_thing)
403 local pos = core.get_pointed_thing_position(pointed_thing, true)
405 local item = itemstack:take_item()
406 core.add_item(pos, item)
411 function core.item_place(itemstack, placer, pointed_thing, param2)
412 -- Call on_rightclick if the pointed node defines it
413 if pointed_thing.type == "node" and placer and
414 not placer:get_player_control().sneak then
415 local n = core.get_node(pointed_thing.under)
417 if core.registered_nodes[nn] and core.registered_nodes[nn].on_rightclick then
418 return core.registered_nodes[nn].on_rightclick(pointed_thing.under, n,
419 placer, itemstack, pointed_thing) or itemstack, false
423 if itemstack:get_definition().type == "node" then
424 return core.item_place_node(itemstack, placer, pointed_thing, param2)
429 function core.item_secondary_use(itemstack, placer)
433 function core.item_drop(itemstack, dropper, pos)
434 local dropper_is_player = dropper and dropper:is_player()
435 local p = table.copy(pos)
436 local cnt = itemstack:get_count()
437 if dropper_is_player then
440 local item = itemstack:take_item(cnt)
441 local obj = core.add_item(p, item)
443 if dropper_is_player then
444 local dir = dropper:get_look_dir()
446 dir.y = dir.y * 2.9 + 2
448 obj:set_velocity(dir)
449 obj:get_luaentity().dropped_by = dropper:get_player_name()
453 -- If we reach this, adding the object to the
454 -- environment failed
457 function core.do_item_eat(hp_change, replace_with_item, itemstack, user, pointed_thing)
458 for _, callback in pairs(core.registered_on_item_eats) do
459 local result = callback(hp_change, replace_with_item, itemstack, user, pointed_thing)
464 if itemstack:take_item() ~= nil then
465 user:set_hp(user:get_hp() + hp_change)
467 local def = itemstack:get_definition()
468 if def and def.sound and def.sound.eat then
469 minetest.sound_play(def.sound.eat, { pos = user:get_pos(), max_hear_distance = 16 })
472 if replace_with_item then
473 if itemstack:is_empty() then
474 itemstack:add_item(replace_with_item)
476 local inv = user:get_inventory()
477 -- Check if inv is null, since non-players don't have one
478 if inv and inv:room_for_item("main", {name=replace_with_item}) then
479 inv:add_item("main", replace_with_item)
481 local pos = user:get_pos()
482 pos.y = math.floor(pos.y + 0.5)
483 core.add_item(pos, replace_with_item)
491 function core.item_eat(hp_change, replace_with_item)
492 return function(itemstack, user, pointed_thing) -- closure
494 return core.do_item_eat(hp_change, replace_with_item, itemstack, user, pointed_thing)
499 function core.node_punch(pos, node, puncher, pointed_thing)
501 for _, callback in ipairs(core.registered_on_punchnodes) do
502 -- Copy pos and node because callback can modify them
503 local pos_copy = vector.new(pos)
504 local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
505 local pointed_thing_copy = pointed_thing and copy_pointed_thing(pointed_thing) or nil
506 callback(pos_copy, node_copy, puncher, pointed_thing_copy)
510 function core.handle_node_drops(pos, drops, digger)
511 -- Add dropped items to object's inventory
512 local inv = digger and digger:get_inventory()
515 give_item = function(item)
516 return inv:add_item("main", item)
519 give_item = function(item)
520 -- itemstring to ItemStack for left:is_empty()
521 return ItemStack(item)
525 for _, dropped_item in pairs(drops) do
526 local left = give_item(dropped_item)
527 if not left:is_empty() then
529 x = pos.x + math.random()/2-0.25,
530 y = pos.y + math.random()/2-0.25,
531 z = pos.z + math.random()/2-0.25,
533 core.add_item(p, left)
538 function core.node_dig(pos, node, digger)
539 local diggername = user_name(digger)
540 local log = make_log(diggername)
541 local def = core.registered_nodes[node.name]
542 if def and (not def.diggable or
543 (def.can_dig and not def.can_dig(pos, digger))) then
544 log("info", diggername .. " tried to dig "
545 .. node.name .. " which is not diggable "
546 .. core.pos_to_string(pos))
550 if core.is_protected(pos, diggername) then
551 log("action", diggername
552 .. " tried to dig " .. node.name
553 .. " at protected position "
554 .. core.pos_to_string(pos))
555 core.record_protection_violation(pos, diggername)
559 log('action', diggername .. " digs "
560 .. node.name .. " at " .. core.pos_to_string(pos))
562 local wielded = digger and digger:get_wielded_item()
563 local drops = core.get_node_drops(node, wielded and wielded:get_name())
566 local wdef = wielded:get_definition()
567 local tp = wielded:get_tool_capabilities()
568 local dp = core.get_dig_params(def and def.groups, tp)
569 if wdef and wdef.after_use then
570 wielded = wdef.after_use(wielded, digger, node, dp) or wielded
573 if not core.settings:get_bool("creative_mode") then
574 wielded:add_wear(dp.wear)
575 if wielded:get_count() == 0 and wdef.sound and wdef.sound.breaks then
576 core.sound_play(wdef.sound.breaks, {pos = pos, gain = 0.5})
580 digger:set_wielded_item(wielded)
583 -- Check to see if metadata should be preserved.
584 if def and def.preserve_metadata then
585 local oldmeta = core.get_meta(pos):to_table().fields
586 -- Copy pos and node because the callback can modify them.
587 local pos_copy = {x=pos.x, y=pos.y, z=pos.z}
588 local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
589 local drop_stacks = {}
590 for k, v in pairs(drops) do
591 drop_stacks[k] = ItemStack(v)
594 def.preserve_metadata(pos_copy, node_copy, oldmeta, drops)
598 core.handle_node_drops(pos, drops, digger)
600 local oldmetadata = nil
601 if def and def.after_dig_node then
602 oldmetadata = core.get_meta(pos):to_table()
605 -- Remove node and update
606 core.remove_node(pos)
609 if def and def.after_dig_node then
610 -- Copy pos and node because callback can modify them
611 local pos_copy = {x=pos.x, y=pos.y, z=pos.z}
612 local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
613 def.after_dig_node(pos_copy, node_copy, oldmetadata, digger)
618 for _, callback in ipairs(core.registered_on_dignodes) do
619 local origin = core.callback_origins[callback]
621 core.set_last_run_mod(origin.mod)
622 --print("Running " .. tostring(callback) ..
623 -- " (a " .. origin.name .. " callback in " .. origin.mod .. ")")
625 --print("No data associated with callback")
628 -- Copy pos and node because callback can modify them
629 local pos_copy = {x=pos.x, y=pos.y, z=pos.z}
630 local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
631 callback(pos_copy, node_copy, digger)
635 function core.itemstring_with_palette(item, palette_index)
636 local stack = ItemStack(item) -- convert to ItemStack
637 stack:get_meta():set_int("palette_index", palette_index)
638 return stack:to_string()
641 function core.itemstring_with_color(item, colorstring)
642 local stack = ItemStack(item) -- convert to ItemStack
643 stack:get_meta():set_string("color", colorstring)
644 return stack:to_string()
647 -- This is used to allow mods to redefine core.item_place and so on
648 -- NOTE: This is not the preferred way. Preferred way is to provide enough
649 -- callbacks to not require redefining global functions. -celeron55
650 local function redef_wrapper(table, name)
652 return table[name](...)
657 -- Item definition defaults
660 core.nodedef_default = {
663 -- name intentionally not defined here
666 inventory_image = "",
668 wield_scale = {x=1,y=1,z=1},
671 liquids_pointable = false,
672 tool_capabilities = nil,
673 node_placement_prediction = nil,
675 -- Interaction callbacks
676 on_place = redef_wrapper(core, 'item_place'), -- core.item_place
677 on_drop = redef_wrapper(core, 'item_drop'), -- core.item_drop
681 on_punch = redef_wrapper(core, 'node_punch'), -- core.node_punch
683 on_dig = redef_wrapper(core, 'node_dig'), -- core.node_dig
685 on_receive_fields = nil,
687 on_metadata_inventory_move = core.node_metadata_inventory_move_allow_all,
688 on_metadata_inventory_offer = core.node_metadata_inventory_offer_allow_all,
689 on_metadata_inventory_take = core.node_metadata_inventory_take_allow_all,
694 -- Don't define these because otherwise the old tile_images and
695 -- special_materials wouldn't be read
698 -- {name="", backface_culling=true},
699 -- {name="", backface_culling=true},
702 post_effect_color = {a=0, r=0, g=0, b=0},
705 is_ground_content = true,
706 sunlight_propagates = false,
711 buildable_to = false,
714 liquid_alternative_flowing = "",
715 liquid_alternative_source = "",
716 liquid_viscosity = 0,
719 damage_per_second = 0,
720 selection_box = {type="regular"},
721 legacy_facedir_simple = false,
722 legacy_wallmounted = false,
725 core.craftitemdef_default = {
727 -- name intentionally not defined here
730 inventory_image = "",
732 wield_scale = {x=1,y=1,z=1},
734 liquids_pointable = false,
735 tool_capabilities = nil,
737 -- Interaction callbacks
738 on_place = redef_wrapper(core, 'item_place'), -- core.item_place
739 on_drop = redef_wrapper(core, 'item_drop'), -- core.item_drop
740 on_secondary_use = redef_wrapper(core, 'item_secondary_use'),
744 core.tooldef_default = {
746 -- name intentionally not defined here
749 inventory_image = "",
751 wield_scale = {x=1,y=1,z=1},
753 liquids_pointable = false,
754 tool_capabilities = nil,
756 -- Interaction callbacks
757 on_place = redef_wrapper(core, 'item_place'), -- core.item_place
758 on_secondary_use = redef_wrapper(core, 'item_secondary_use'),
759 on_drop = redef_wrapper(core, 'item_drop'), -- core.item_drop
763 core.noneitemdef_default = { -- This is used for the hand and unknown items
765 -- name intentionally not defined here
768 inventory_image = "",
770 wield_scale = {x=1,y=1,z=1},
772 liquids_pointable = false,
773 tool_capabilities = nil,
775 -- Interaction callbacks
776 on_place = redef_wrapper(core, 'item_place'),
777 on_secondary_use = redef_wrapper(core, 'item_secondary_use'),