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.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
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
218 for _, tool in ipairs(item.tools) do
219 if tool:sub(1, 1) == '~' then
220 good_tool = toolname:find(tool:sub(2)) ~= nil
222 good_tool = toolname == tool
229 if good_rarity and good_tool then
230 got_count = got_count + 1
231 for _, add_item in ipairs(item.items) do
232 -- add color, if necessary
233 if item.inherit_color and palette_index then
234 local stack = ItemStack(add_item)
235 stack:get_meta():set_int("palette_index", palette_index)
236 add_item = stack:to_string()
238 got_items[#got_items+1] = add_item
240 if drop.max_items ~= nil and got_count == drop.max_items then
248 function core.item_place_node(itemstack, placer, pointed_thing, param2)
249 local def = itemstack:get_definition()
250 if def.type ~= "node" or pointed_thing.type ~= "node" then
251 return itemstack, false
254 local under = pointed_thing.under
255 local oldnode_under = core.get_node_or_nil(under)
256 local above = pointed_thing.above
257 local oldnode_above = core.get_node_or_nil(above)
258 local playername = placer:get_player_name()
260 if not oldnode_under or not oldnode_above then
261 core.log("info", playername .. " tried to place"
262 .. " node in unloaded position " .. core.pos_to_string(above))
263 return itemstack, false
266 local olddef_under = core.registered_nodes[oldnode_under.name]
267 olddef_under = olddef_under or core.nodedef_default
268 local olddef_above = core.registered_nodes[oldnode_above.name]
269 olddef_above = olddef_above or core.nodedef_default
271 if not olddef_above.buildable_to and not olddef_under.buildable_to then
272 core.log("info", playername .. " tried to place"
273 .. " node in invalid position " .. core.pos_to_string(above)
274 .. ", replacing " .. oldnode_above.name)
275 return itemstack, false
278 -- Place above pointed node
279 local place_to = {x = above.x, y = above.y, z = above.z}
281 -- If node under is buildable_to, place into it instead (eg. snow)
282 if olddef_under.buildable_to then
283 core.log("info", "node under is buildable to")
284 place_to = {x = under.x, y = under.y, z = under.z}
287 if core.is_protected(place_to, playername) and
288 not minetest.check_player_privs(placer, "protection_bypass") then
289 core.log("action", playername
290 .. " tried to place " .. def.name
291 .. " at protected position "
292 .. core.pos_to_string(place_to))
293 core.record_protection_violation(place_to, playername)
297 core.log("action", playername .. " places node "
298 .. def.name .. " at " .. core.pos_to_string(place_to))
300 local oldnode = core.get_node(place_to)
301 local newnode = {name = def.name, param1 = 0, param2 = param2 or 0}
303 -- Calculate direction for wall mounted stuff like torches and signs
304 if def.place_param2 ~= nil then
305 newnode.param2 = def.place_param2
306 elseif (def.paramtype2 == "wallmounted" or
307 def.paramtype2 == "colorwallmounted") and not param2 then
309 x = under.x - above.x,
310 y = under.y - above.y,
311 z = under.z - above.z
313 newnode.param2 = core.dir_to_wallmounted(dir)
314 -- Calculate the direction for furnaces and chests and stuff
315 elseif (def.paramtype2 == "facedir" or
316 def.paramtype2 == "colorfacedir") and not param2 then
317 local placer_pos = placer:getpos()
320 x = above.x - placer_pos.x,
321 y = above.y - placer_pos.y,
322 z = above.z - placer_pos.z
324 newnode.param2 = core.dir_to_facedir(dir)
325 core.log("action", "facedir: " .. newnode.param2)
329 local metatable = itemstack:get_meta():to_table().fields
331 -- Transfer color information
332 if metatable.palette_index and not def.place_param2 then
333 local color_divisor = nil
334 if def.paramtype2 == "color" then
336 elseif def.paramtype2 == "colorwallmounted" then
338 elseif def.paramtype2 == "colorfacedir" then
341 if color_divisor then
342 local color = math.floor(metatable.palette_index / color_divisor)
343 local other = newnode.param2 % color_divisor
344 newnode.param2 = color * color_divisor + other
348 -- Check if the node is attached and if it can be placed there
349 if core.get_item_group(def.name, "attached_node") ~= 0 and
350 not builtin_shared.check_attached_node(place_to, newnode) then
351 core.log("action", "attached node " .. def.name ..
352 " can not be placed at " .. core.pos_to_string(place_to))
353 return itemstack, false
356 -- Add node and update
357 core.add_node(place_to, newnode)
359 local take_item = true
362 if def.after_place_node then
363 -- Deepcopy place_to and pointed_thing because callback can modify it
364 local place_to_copy = {x=place_to.x, y=place_to.y, z=place_to.z}
365 local pointed_thing_copy = copy_pointed_thing(pointed_thing)
366 if def.after_place_node(place_to_copy, placer, itemstack,
367 pointed_thing_copy) then
373 for _, callback in ipairs(core.registered_on_placenodes) do
374 -- Deepcopy pos, node and pointed_thing because callback can modify them
375 local place_to_copy = {x=place_to.x, y=place_to.y, z=place_to.z}
376 local newnode_copy = {name=newnode.name, param1=newnode.param1, param2=newnode.param2}
377 local oldnode_copy = {name=oldnode.name, param1=oldnode.param1, param2=oldnode.param2}
378 local pointed_thing_copy = copy_pointed_thing(pointed_thing)
379 if callback(place_to_copy, newnode_copy, placer, oldnode_copy, itemstack, pointed_thing_copy) then
385 itemstack:take_item()
387 return itemstack, true
390 function core.item_place_object(itemstack, placer, pointed_thing)
391 local pos = core.get_pointed_thing_position(pointed_thing, true)
393 local item = itemstack:take_item()
394 core.add_item(pos, item)
399 function core.item_place(itemstack, placer, pointed_thing, param2)
400 -- Call on_rightclick if the pointed node defines it
401 if pointed_thing.type == "node" and placer and
402 not placer:get_player_control().sneak then
403 local n = core.get_node(pointed_thing.under)
405 if core.registered_nodes[nn] and core.registered_nodes[nn].on_rightclick then
406 return core.registered_nodes[nn].on_rightclick(pointed_thing.under, n,
407 placer, itemstack, pointed_thing) or itemstack, false
411 if itemstack:get_definition().type == "node" then
412 return core.item_place_node(itemstack, placer, pointed_thing, param2)
417 function core.item_secondary_use(itemstack, placer)
421 function core.item_drop(itemstack, dropper, pos)
422 if dropper and dropper:is_player() then
423 local dir = dropper:get_look_dir()
424 local p = {x = pos.x, y = pos.y + 1.2, z = pos.z}
425 local cnt = itemstack:get_count()
426 local item = itemstack:take_item(cnt)
427 local obj = core.add_item(p, item)
430 dir.y = dir.y * 2 + 2
432 obj:set_velocity(dir)
433 obj:get_luaentity().dropped_by = dropper:get_player_name()
438 if core.add_item(pos, itemstack) then
442 -- If we reach this, adding the object to the
443 -- environment failed
446 function core.do_item_eat(hp_change, replace_with_item, itemstack, user, pointed_thing)
447 for _, callback in pairs(core.registered_on_item_eats) do
448 local result = callback(hp_change, replace_with_item, itemstack, user, pointed_thing)
453 if itemstack:take_item() ~= nil then
454 user:set_hp(user:get_hp() + hp_change)
456 if replace_with_item then
457 if itemstack:is_empty() then
458 itemstack:add_item(replace_with_item)
460 local inv = user:get_inventory()
461 if inv:room_for_item("main", {name=replace_with_item}) then
462 inv:add_item("main", replace_with_item)
464 local pos = user:getpos()
465 pos.y = math.floor(pos.y + 0.5)
466 core.add_item(pos, replace_with_item)
474 function core.item_eat(hp_change, replace_with_item)
475 return function(itemstack, user, pointed_thing) -- closure
476 return core.do_item_eat(hp_change, replace_with_item, itemstack, user, pointed_thing)
480 function core.node_punch(pos, node, puncher, pointed_thing)
482 for _, callback in ipairs(core.registered_on_punchnodes) do
483 -- Copy pos and node because callback can modify them
484 local pos_copy = vector.new(pos)
485 local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
486 local pointed_thing_copy = pointed_thing and copy_pointed_thing(pointed_thing) or nil
487 callback(pos_copy, node_copy, puncher, pointed_thing_copy)
491 function core.handle_node_drops(pos, drops, digger)
492 -- Add dropped items to object's inventory
493 if digger:get_inventory() then
494 local _, dropped_item
495 for _, dropped_item in ipairs(drops) do
496 local left = digger:get_inventory():add_item("main", dropped_item)
497 if not left:is_empty() then
499 x = pos.x + math.random()/2-0.25,
500 y = pos.y + math.random()/2-0.25,
501 z = pos.z + math.random()/2-0.25,
503 core.add_item(p, left)
509 function core.node_dig(pos, node, digger)
510 local def = core.registered_nodes[node.name]
511 if def and (not def.diggable or
512 (def.can_dig and not def.can_dig(pos, digger))) then
513 core.log("info", digger:get_player_name() .. " tried to dig "
514 .. node.name .. " which is not diggable "
515 .. core.pos_to_string(pos))
519 if core.is_protected(pos, digger:get_player_name()) and
520 not minetest.check_player_privs(digger, "protection_bypass") then
521 core.log("action", digger:get_player_name()
522 .. " tried to dig " .. node.name
523 .. " at protected position "
524 .. core.pos_to_string(pos))
525 core.record_protection_violation(pos, digger:get_player_name())
529 core.log('action', digger:get_player_name() .. " digs "
530 .. node.name .. " at " .. core.pos_to_string(pos))
532 local wielded = digger:get_wielded_item()
533 local drops = core.get_node_drops(node, wielded:get_name())
535 local wdef = wielded:get_definition()
536 local tp = wielded:get_tool_capabilities()
537 local dp = core.get_dig_params(def and def.groups, tp)
538 if wdef and wdef.after_use then
539 wielded = wdef.after_use(wielded, digger, node, dp) or wielded
542 if not core.settings:get_bool("creative_mode") then
543 wielded:add_wear(dp.wear)
544 if wielded:get_count() == 0 and wdef.sound and wdef.sound.breaks then
545 core.sound_play(wdef.sound.breaks, {pos = pos, gain = 0.5})
549 digger:set_wielded_item(wielded)
552 core.handle_node_drops(pos, drops, digger)
554 local oldmetadata = nil
555 if def and def.after_dig_node then
556 oldmetadata = core.get_meta(pos):to_table()
559 -- Remove node and update
560 core.remove_node(pos)
563 if def and def.after_dig_node then
564 -- Copy pos and node because callback can modify them
565 local pos_copy = {x=pos.x, y=pos.y, z=pos.z}
566 local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
567 def.after_dig_node(pos_copy, node_copy, oldmetadata, digger)
572 for _, callback in ipairs(core.registered_on_dignodes) do
573 local origin = core.callback_origins[callback]
575 core.set_last_run_mod(origin.mod)
576 --print("Running " .. tostring(callback) ..
577 -- " (a " .. origin.name .. " callback in " .. origin.mod .. ")")
579 --print("No data associated with callback")
582 -- Copy pos and node because callback can modify them
583 local pos_copy = {x=pos.x, y=pos.y, z=pos.z}
584 local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
585 callback(pos_copy, node_copy, digger)
589 function core.itemstring_with_palette(item, palette_index)
590 local stack = ItemStack(item) -- convert to ItemStack
591 stack:get_meta():set_int("palette_index", palette_index)
592 return stack:to_string()
595 function core.itemstring_with_color(item, colorstring)
596 local stack = ItemStack(item) -- convert to ItemStack
597 stack:get_meta():set_string("color", colorstring)
598 return stack:to_string()
601 -- This is used to allow mods to redefine core.item_place and so on
602 -- NOTE: This is not the preferred way. Preferred way is to provide enough
603 -- callbacks to not require redefining global functions. -celeron55
604 local function redef_wrapper(table, name)
606 return table[name](...)
611 -- Item definition defaults
614 core.nodedef_default = {
617 -- name intentionally not defined here
620 inventory_image = "",
622 wield_scale = {x=1,y=1,z=1},
625 liquids_pointable = false,
626 tool_capabilities = nil,
627 node_placement_prediction = nil,
629 -- Interaction callbacks
630 on_place = redef_wrapper(core, 'item_place'), -- core.item_place
631 on_drop = redef_wrapper(core, 'item_drop'), -- core.item_drop
635 on_punch = redef_wrapper(core, 'node_punch'), -- core.node_punch
637 on_dig = redef_wrapper(core, 'node_dig'), -- core.node_dig
639 on_receive_fields = nil,
641 on_metadata_inventory_move = core.node_metadata_inventory_move_allow_all,
642 on_metadata_inventory_offer = core.node_metadata_inventory_offer_allow_all,
643 on_metadata_inventory_take = core.node_metadata_inventory_take_allow_all,
648 -- Don't define these because otherwise the old tile_images and
649 -- special_materials wouldn't be read
652 -- {name="", backface_culling=true},
653 -- {name="", backface_culling=true},
656 post_effect_color = {a=0, r=0, g=0, b=0},
659 is_ground_content = true,
660 sunlight_propagates = false,
665 buildable_to = false,
668 liquid_alternative_flowing = "",
669 liquid_alternative_source = "",
670 liquid_viscosity = 0,
673 damage_per_second = 0,
674 selection_box = {type="regular"},
675 legacy_facedir_simple = false,
676 legacy_wallmounted = false,
679 core.craftitemdef_default = {
681 -- name intentionally not defined here
684 inventory_image = "",
686 wield_scale = {x=1,y=1,z=1},
688 liquids_pointable = false,
689 tool_capabilities = nil,
691 -- Interaction callbacks
692 on_place = redef_wrapper(core, 'item_place'), -- core.item_place
693 on_drop = redef_wrapper(core, 'item_drop'), -- core.item_drop
694 on_secondary_use = redef_wrapper(core, 'item_secondary_use'),
698 core.tooldef_default = {
700 -- name intentionally not defined here
703 inventory_image = "",
705 wield_scale = {x=1,y=1,z=1},
707 liquids_pointable = false,
708 tool_capabilities = nil,
710 -- Interaction callbacks
711 on_place = redef_wrapper(core, 'item_place'), -- core.item_place
712 on_secondary_use = redef_wrapper(core, 'item_secondary_use'),
713 on_drop = redef_wrapper(core, 'item_drop'), -- core.item_drop
717 core.noneitemdef_default = { -- This is used for the hand and unknown items
719 -- name intentionally not defined here
722 inventory_image = "",
724 wield_scale = {x=1,y=1,z=1},
726 liquids_pointable = false,
727 tool_capabilities = nil,
729 -- Interaction callbacks
730 on_place = redef_wrapper(core, 'item_place'),
731 on_secondary_use = redef_wrapper(core, 'item_secondary_use'),