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:getpos()
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.get_node_drops(node, toolname)
159 -- Compatibility, if node is string
160 local nodename = node
162 -- New format, if node is table
163 if (type(node) == "table") then
167 local def = core.registered_nodes[nodename]
168 local drop = def and def.drop
171 local stack = ItemStack(nodename)
173 local type = def.paramtype2
174 if (type == "color") or (type == "colorfacedir") or
175 (type == "colorwallmounted") then
176 local meta = stack:get_meta()
177 local color_part = param2
178 if (type == "colorfacedir") then
179 color_part = math.floor(color_part / 32) * 32;
180 elseif (type == "colorwallmounted") then
181 color_part = math.floor(color_part / 8) * 8;
183 meta:set_int("palette_index", color_part)
186 return {stack:to_string()}
187 elseif type(drop) == "string" then
190 elseif drop.items == nil then
191 -- drop = {} to disable default drop
195 -- Extended drop table
199 for _, item in ipairs(drop.items) do
200 local good_rarity = true
201 local good_tool = true
202 if item.rarity ~= nil then
203 good_rarity = item.rarity < 1 or math.random(item.rarity) == 1
205 if item.tools ~= nil then
207 for _, tool in ipairs(item.tools) do
208 if tool:sub(1, 1) == '~' then
209 good_tool = toolname:find(tool:sub(2)) ~= nil
211 good_tool = toolname == tool
218 if good_rarity and good_tool then
219 got_count = got_count + 1
220 for _, add_item in ipairs(item.items) do
221 got_items[#got_items+1] = add_item
223 if drop.max_items ~= nil and got_count == drop.max_items then
231 function core.item_place_node(itemstack, placer, pointed_thing, param2)
232 local def = itemstack:get_definition()
233 if def.type ~= "node" or pointed_thing.type ~= "node" then
234 return itemstack, false
237 local under = pointed_thing.under
238 local oldnode_under = core.get_node_or_nil(under)
239 local above = pointed_thing.above
240 local oldnode_above = core.get_node_or_nil(above)
241 local playername = placer:get_player_name()
243 if not oldnode_under or not oldnode_above then
244 core.log("info", playername .. " tried to place"
245 .. " node in unloaded position " .. core.pos_to_string(above))
246 return itemstack, false
249 local olddef_under = core.registered_nodes[oldnode_under.name]
250 olddef_under = olddef_under or core.nodedef_default
251 local olddef_above = core.registered_nodes[oldnode_above.name]
252 olddef_above = olddef_above or core.nodedef_default
254 if not olddef_above.buildable_to and not olddef_under.buildable_to then
255 core.log("info", playername .. " tried to place"
256 .. " node in invalid position " .. core.pos_to_string(above)
257 .. ", replacing " .. oldnode_above.name)
258 return itemstack, false
261 -- Place above pointed node
262 local place_to = {x = above.x, y = above.y, z = above.z}
264 -- If node under is buildable_to, place into it instead (eg. snow)
265 if olddef_under.buildable_to then
266 core.log("info", "node under is buildable to")
267 place_to = {x = under.x, y = under.y, z = under.z}
270 if core.is_protected(place_to, playername) and
271 not minetest.check_player_privs(placer, "protection_bypass") then
272 core.log("action", playername
273 .. " tried to place " .. def.name
274 .. " at protected position "
275 .. core.pos_to_string(place_to))
276 core.record_protection_violation(place_to, playername)
280 core.log("action", playername .. " places node "
281 .. def.name .. " at " .. core.pos_to_string(place_to))
283 local oldnode = core.get_node(place_to)
284 local newnode = {name = def.name, param1 = 0, param2 = param2 or 0}
286 -- Calculate direction for wall mounted stuff like torches and signs
287 if def.place_param2 ~= nil then
288 newnode.param2 = def.place_param2
289 elseif (def.paramtype2 == "wallmounted" or
290 def.paramtype2 == "colorwallmounted") and not param2 then
292 x = under.x - above.x,
293 y = under.y - above.y,
294 z = under.z - above.z
296 newnode.param2 = core.dir_to_wallmounted(dir)
297 -- Calculate the direction for furnaces and chests and stuff
298 elseif (def.paramtype2 == "facedir" or
299 def.paramtype2 == "colorfacedir") and not param2 then
300 local placer_pos = placer:getpos()
303 x = above.x - placer_pos.x,
304 y = above.y - placer_pos.y,
305 z = above.z - placer_pos.z
307 newnode.param2 = core.dir_to_facedir(dir)
308 core.log("action", "facedir: " .. newnode.param2)
312 local metatable = itemstack:get_meta():to_table().fields
314 -- Transfer color information
315 if metatable.palette_index and not def.place_param2 then
316 local color_divisor = nil
317 if def.paramtype2 == "color" then
319 elseif def.paramtype2 == "colorwallmounted" then
321 elseif def.paramtype2 == "colorfacedir" then
324 if color_divisor then
325 local color = math.floor(metatable.palette_index / color_divisor)
326 local other = newnode.param2 % color_divisor
327 newnode.param2 = color * color_divisor + other
331 -- Check if the node is attached and if it can be placed there
332 if core.get_item_group(def.name, "attached_node") ~= 0 and
333 not builtin_shared.check_attached_node(place_to, newnode) then
334 core.log("action", "attached node " .. def.name ..
335 " can not be placed at " .. core.pos_to_string(place_to))
336 return itemstack, false
339 -- Add node and update
340 core.add_node(place_to, newnode)
342 local take_item = true
345 if def.after_place_node then
346 -- Deepcopy place_to and pointed_thing because callback can modify it
347 local place_to_copy = {x=place_to.x, y=place_to.y, z=place_to.z}
348 local pointed_thing_copy = copy_pointed_thing(pointed_thing)
349 if def.after_place_node(place_to_copy, placer, itemstack,
350 pointed_thing_copy) then
356 for _, callback in ipairs(core.registered_on_placenodes) do
357 -- Deepcopy pos, node and pointed_thing because callback can modify them
358 local place_to_copy = {x=place_to.x, y=place_to.y, z=place_to.z}
359 local newnode_copy = {name=newnode.name, param1=newnode.param1, param2=newnode.param2}
360 local oldnode_copy = {name=oldnode.name, param1=oldnode.param1, param2=oldnode.param2}
361 local pointed_thing_copy = copy_pointed_thing(pointed_thing)
362 if callback(place_to_copy, newnode_copy, placer, oldnode_copy, itemstack, pointed_thing_copy) then
368 itemstack:take_item()
370 return itemstack, true
373 function core.item_place_object(itemstack, placer, pointed_thing)
374 local pos = core.get_pointed_thing_position(pointed_thing, true)
376 local item = itemstack:take_item()
377 core.add_item(pos, item)
382 function core.item_place(itemstack, placer, pointed_thing, param2)
383 -- Call on_rightclick if the pointed node defines it
384 if pointed_thing.type == "node" and placer and
385 not placer:get_player_control().sneak then
386 local n = core.get_node(pointed_thing.under)
388 if core.registered_nodes[nn] and core.registered_nodes[nn].on_rightclick then
389 return core.registered_nodes[nn].on_rightclick(pointed_thing.under, n,
390 placer, itemstack, pointed_thing) or itemstack, false
394 if itemstack:get_definition().type == "node" then
395 return core.item_place_node(itemstack, placer, pointed_thing, param2)
400 function core.item_secondary_use(itemstack, placer)
404 function core.item_drop(itemstack, dropper, pos)
405 if dropper and dropper:is_player() then
406 local v = dropper:get_look_dir()
407 local p = {x=pos.x, y=pos.y+1.2, z=pos.z}
408 local cs = itemstack:get_count()
409 if dropper:get_player_control().sneak then
412 local item = itemstack:take_item(cs)
413 local obj = core.add_item(p, item)
419 obj:get_luaentity().dropped_by = dropper:get_player_name()
424 if core.add_item(pos, itemstack) then
428 -- If we reach this, adding the object to the
429 -- environment failed
432 function core.do_item_eat(hp_change, replace_with_item, itemstack, user, pointed_thing)
433 for _, callback in pairs(core.registered_on_item_eats) do
434 local result = callback(hp_change, replace_with_item, itemstack, user, pointed_thing)
439 if itemstack:take_item() ~= nil then
440 user:set_hp(user:get_hp() + hp_change)
442 if replace_with_item then
443 if itemstack:is_empty() then
444 itemstack:add_item(replace_with_item)
446 local inv = user:get_inventory()
447 if inv:room_for_item("main", {name=replace_with_item}) then
448 inv:add_item("main", replace_with_item)
450 local pos = user:getpos()
451 pos.y = math.floor(pos.y + 0.5)
452 core.add_item(pos, replace_with_item)
460 function core.item_eat(hp_change, replace_with_item)
461 return function(itemstack, user, pointed_thing) -- closure
462 return core.do_item_eat(hp_change, replace_with_item, itemstack, user, pointed_thing)
466 function core.node_punch(pos, node, puncher, pointed_thing)
468 for _, callback in ipairs(core.registered_on_punchnodes) do
469 -- Copy pos and node because callback can modify them
470 local pos_copy = vector.new(pos)
471 local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
472 local pointed_thing_copy = pointed_thing and copy_pointed_thing(pointed_thing) or nil
473 callback(pos_copy, node_copy, puncher, pointed_thing_copy)
477 function core.handle_node_drops(pos, drops, digger)
478 -- Add dropped items to object's inventory
479 if digger:get_inventory() then
480 local _, dropped_item
481 for _, dropped_item in ipairs(drops) do
482 local left = digger:get_inventory():add_item("main", dropped_item)
483 if not left:is_empty() then
485 x = pos.x + math.random()/2-0.25,
486 y = pos.y + math.random()/2-0.25,
487 z = pos.z + math.random()/2-0.25,
489 core.add_item(p, left)
495 function core.node_dig(pos, node, digger)
496 local def = core.registered_nodes[node.name]
497 if def and (not def.diggable or
498 (def.can_dig and not def.can_dig(pos, digger))) then
499 core.log("info", digger:get_player_name() .. " tried to dig "
500 .. node.name .. " which is not diggable "
501 .. core.pos_to_string(pos))
505 if core.is_protected(pos, digger:get_player_name()) and
506 not minetest.check_player_privs(digger, "protection_bypass") then
507 core.log("action", digger:get_player_name()
508 .. " tried to dig " .. node.name
509 .. " at protected position "
510 .. core.pos_to_string(pos))
511 core.record_protection_violation(pos, digger:get_player_name())
515 core.log('action', digger:get_player_name() .. " digs "
516 .. node.name .. " at " .. core.pos_to_string(pos))
518 local wielded = digger:get_wielded_item()
519 local drops = core.get_node_drops(node, wielded:get_name())
521 local wdef = wielded:get_definition()
522 local tp = wielded:get_tool_capabilities()
523 local dp = core.get_dig_params(def and def.groups, tp)
524 if wdef and wdef.after_use then
525 wielded = wdef.after_use(wielded, digger, node, dp) or wielded
528 if not core.settings:get_bool("creative_mode") then
529 wielded:add_wear(dp.wear)
530 if wielded:get_count() == 0 and wdef.sound and wdef.sound.breaks then
531 core.sound_play(wdef.sound.breaks, {pos = pos, gain = 0.5})
535 digger:set_wielded_item(wielded)
538 core.handle_node_drops(pos, drops, digger)
540 local oldmetadata = nil
541 if def and def.after_dig_node then
542 oldmetadata = core.get_meta(pos):to_table()
545 -- Remove node and update
546 core.remove_node(pos)
549 if def and def.after_dig_node then
550 -- Copy pos and node because callback can modify them
551 local pos_copy = {x=pos.x, y=pos.y, z=pos.z}
552 local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
553 def.after_dig_node(pos_copy, node_copy, oldmetadata, digger)
558 for _, callback in ipairs(core.registered_on_dignodes) do
559 local origin = core.callback_origins[callback]
561 core.set_last_run_mod(origin.mod)
562 --print("Running " .. tostring(callback) ..
563 -- " (a " .. origin.name .. " callback in " .. origin.mod .. ")")
565 --print("No data associated with callback")
568 -- Copy pos and node because callback can modify them
569 local pos_copy = {x=pos.x, y=pos.y, z=pos.z}
570 local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
571 callback(pos_copy, node_copy, digger)
575 function core.itemstring_with_palette(item, palette_index)
576 local stack = ItemStack(item) -- convert to ItemStack
577 stack:get_meta():set_int("palette_index", palette_index)
578 return stack:to_string()
581 function core.itemstring_with_color(item, colorstring)
582 local stack = ItemStack(item) -- convert to ItemStack
583 stack:get_meta():set_string("color", colorstring)
584 return stack:to_string()
587 -- This is used to allow mods to redefine core.item_place and so on
588 -- NOTE: This is not the preferred way. Preferred way is to provide enough
589 -- callbacks to not require redefining global functions. -celeron55
590 local function redef_wrapper(table, name)
592 return table[name](...)
597 -- Item definition defaults
600 core.nodedef_default = {
603 -- name intentionally not defined here
606 inventory_image = "",
608 wield_scale = {x=1,y=1,z=1},
611 liquids_pointable = false,
612 tool_capabilities = nil,
613 node_placement_prediction = nil,
615 -- Interaction callbacks
616 on_place = redef_wrapper(core, 'item_place'), -- core.item_place
617 on_drop = redef_wrapper(core, 'item_drop'), -- core.item_drop
621 on_punch = redef_wrapper(core, 'node_punch'), -- core.node_punch
623 on_dig = redef_wrapper(core, 'node_dig'), -- core.node_dig
625 on_receive_fields = nil,
627 on_metadata_inventory_move = core.node_metadata_inventory_move_allow_all,
628 on_metadata_inventory_offer = core.node_metadata_inventory_offer_allow_all,
629 on_metadata_inventory_take = core.node_metadata_inventory_take_allow_all,
634 -- Don't define these because otherwise the old tile_images and
635 -- special_materials wouldn't be read
638 -- {name="", backface_culling=true},
639 -- {name="", backface_culling=true},
642 post_effect_color = {a=0, r=0, g=0, b=0},
645 is_ground_content = true,
646 sunlight_propagates = false,
651 buildable_to = false,
654 liquid_alternative_flowing = "",
655 liquid_alternative_source = "",
656 liquid_viscosity = 0,
659 damage_per_second = 0,
660 selection_box = {type="regular"},
661 legacy_facedir_simple = false,
662 legacy_wallmounted = false,
665 core.craftitemdef_default = {
667 -- name intentionally not defined here
670 inventory_image = "",
672 wield_scale = {x=1,y=1,z=1},
674 liquids_pointable = false,
675 tool_capabilities = nil,
677 -- Interaction callbacks
678 on_place = redef_wrapper(core, 'item_place'), -- core.item_place
679 on_drop = redef_wrapper(core, 'item_drop'), -- core.item_drop
680 on_secondary_use = redef_wrapper(core, 'item_secondary_use'),
684 core.tooldef_default = {
686 -- name intentionally not defined here
689 inventory_image = "",
691 wield_scale = {x=1,y=1,z=1},
693 liquids_pointable = false,
694 tool_capabilities = nil,
696 -- Interaction callbacks
697 on_place = redef_wrapper(core, 'item_place'), -- core.item_place
698 on_secondary_use = redef_wrapper(core, 'item_secondary_use'),
699 on_drop = redef_wrapper(core, 'item_drop'), -- core.item_drop
703 core.noneitemdef_default = { -- This is used for the hand and unknown items
705 -- name intentionally not defined here
708 inventory_image = "",
710 wield_scale = {x=1,y=1,z=1},
712 liquids_pointable = false,
713 tool_capabilities = nil,
715 -- Interaction callbacks
716 on_place = redef_wrapper(core, 'item_place'),
717 on_secondary_use = redef_wrapper(core, 'item_secondary_use'),