1 -- Minetest: builtin/item.lua
3 local function copy_pointed_thing(pointed_thing)
5 type = pointed_thing.type,
6 above = vector.new(pointed_thing.above),
7 under = vector.new(pointed_thing.under),
8 ref = pointed_thing.ref,
13 -- Item definition helpers
16 function core.inventorycube(img1, img2, img3)
19 return "[inventorycube"
20 .. "{" .. img1:gsub("%^", "&")
21 .. "{" .. img2:gsub("%^", "&")
22 .. "{" .. img3:gsub("%^", "&")
25 function core.get_pointed_thing_position(pointed_thing, above)
26 if pointed_thing.type == "node" then
28 -- The position where a node would be placed
29 return pointed_thing.above
31 -- The position where a node would be dug
32 return pointed_thing.under
33 elseif pointed_thing.type == "object" then
34 return pointed_thing.ref and pointed_thing.ref:getpos()
38 function core.dir_to_facedir(dir, is6d)
39 --account for y if requested
40 if is6d and math.abs(dir.y) > math.abs(dir.x) and math.abs(dir.y) > math.abs(dir.z) then
44 if math.abs(dir.x) > math.abs(dir.z) then
60 if math.abs(dir.x) > math.abs(dir.z) then
75 --otherwise, place horizontally
76 elseif math.abs(dir.x) > math.abs(dir.z) then
91 -- Table of possible dirs
92 local facedir_to_dir = {
100 -- Mapping from facedir value to index in facedir_to_dir.
101 local facedir_to_dir_map = {
109 function core.facedir_to_dir(facedir)
110 return facedir_to_dir[facedir_to_dir_map[facedir]]
113 function core.dir_to_wallmounted(dir)
114 if math.abs(dir.y) > math.max(math.abs(dir.x), math.abs(dir.z)) then
120 elseif math.abs(dir.x) > math.abs(dir.z) then
135 -- table of dirs in wallmounted order
136 local wallmounted_to_dir = {
137 [0] = {x = 0, y = 1, z = 0},
138 {x = 0, y = -1, z = 0},
139 {x = 1, y = 0, z = 0},
140 {x = -1, y = 0, z = 0},
141 {x = 0, y = 0, z = 1},
142 {x = 0, y = 0, z = -1},
144 function core.wallmounted_to_dir(wallmounted)
145 return wallmounted_to_dir[wallmounted]
148 function core.get_node_drops(nodename, toolname)
149 local drop = ItemStack({name=nodename}):get_definition().drop
153 elseif type(drop) == "string" then
156 elseif drop.items == nil then
157 -- drop = {} to disable default drop
161 -- Extended drop table
165 for _, item in ipairs(drop.items) do
166 local good_rarity = true
167 local good_tool = true
168 if item.rarity ~= nil then
169 good_rarity = item.rarity < 1 or math.random(item.rarity) == 1
171 if item.tools ~= nil then
173 for _, tool in ipairs(item.tools) do
174 if tool:sub(1, 1) == '~' then
175 good_tool = toolname:find(tool:sub(2)) ~= nil
177 good_tool = toolname == tool
184 if good_rarity and good_tool then
185 got_count = got_count + 1
186 for _, add_item in ipairs(item.items) do
187 got_items[#got_items+1] = add_item
189 if drop.max_items ~= nil and got_count == drop.max_items then
197 function core.item_place_node(itemstack, placer, pointed_thing, param2)
198 local item = itemstack:peek_item()
199 local def = itemstack:get_definition()
200 if def.type ~= "node" or pointed_thing.type ~= "node" then
201 return itemstack, false
204 local under = pointed_thing.under
205 local oldnode_under = core.get_node_or_nil(under)
206 local above = pointed_thing.above
207 local oldnode_above = core.get_node_or_nil(above)
209 if not oldnode_under or not oldnode_above then
210 core.log("info", placer:get_player_name() .. " tried to place"
211 .. " node in unloaded position " .. core.pos_to_string(above))
212 return itemstack, false
215 local olddef_under = ItemStack({name=oldnode_under.name}):get_definition()
216 olddef_under = olddef_under or core.nodedef_default
217 local olddef_above = ItemStack({name=oldnode_above.name}):get_definition()
218 olddef_above = olddef_above or core.nodedef_default
220 if not olddef_above.buildable_to and not olddef_under.buildable_to then
221 core.log("info", placer:get_player_name() .. " tried to place"
222 .. " node in invalid position " .. core.pos_to_string(above)
223 .. ", replacing " .. oldnode_above.name)
224 return itemstack, false
227 -- Place above pointed node
228 local place_to = {x = above.x, y = above.y, z = above.z}
230 -- If node under is buildable_to, place into it instead (eg. snow)
231 if olddef_under.buildable_to then
232 core.log("info", "node under is buildable to")
233 place_to = {x = under.x, y = under.y, z = under.z}
236 if core.is_protected(place_to, placer:get_player_name()) then
237 core.log("action", placer:get_player_name()
238 .. " tried to place " .. def.name
239 .. " at protected position "
240 .. core.pos_to_string(place_to))
241 core.record_protection_violation(place_to, placer:get_player_name())
245 core.log("action", placer:get_player_name() .. " places node "
246 .. def.name .. " at " .. core.pos_to_string(place_to))
248 local oldnode = core.get_node(place_to)
249 local newnode = {name = def.name, param1 = 0, param2 = param2}
251 -- Calculate direction for wall mounted stuff like torches and signs
252 if def.paramtype2 == 'wallmounted' and not param2 then
254 x = under.x - above.x,
255 y = under.y - above.y,
256 z = under.z - above.z
258 newnode.param2 = core.dir_to_wallmounted(dir)
259 -- Calculate the direction for furnaces and chests and stuff
260 elseif def.paramtype2 == 'facedir' and not param2 then
261 local placer_pos = placer:getpos()
264 x = above.x - placer_pos.x,
265 y = above.y - placer_pos.y,
266 z = above.z - placer_pos.z
268 newnode.param2 = core.dir_to_facedir(dir)
269 core.log("action", "facedir: " .. newnode.param2)
273 -- Check if the node is attached and if it can be placed there
274 if core.get_item_group(def.name, "attached_node") ~= 0 and
275 not check_attached_node(place_to, newnode) then
276 core.log("action", "attached node " .. def.name ..
277 " can not be placed at " .. core.pos_to_string(place_to))
278 return itemstack, false
281 -- Add node and update
282 core.add_node(place_to, newnode)
284 local take_item = true
287 if def.after_place_node then
288 -- Deepcopy place_to and pointed_thing because callback can modify it
289 local place_to_copy = {x=place_to.x, y=place_to.y, z=place_to.z}
290 local pointed_thing_copy = copy_pointed_thing(pointed_thing)
291 if def.after_place_node(place_to_copy, placer, itemstack,
292 pointed_thing_copy) then
299 for _, callback in ipairs(core.registered_on_placenodes) do
300 -- Deepcopy pos, node and pointed_thing because callback can modify them
301 local place_to_copy = {x=place_to.x, y=place_to.y, z=place_to.z}
302 local newnode_copy = {name=newnode.name, param1=newnode.param1, param2=newnode.param2}
303 local oldnode_copy = {name=oldnode.name, param1=oldnode.param1, param2=oldnode.param2}
304 local pointed_thing_copy = copy_pointed_thing(pointed_thing)
305 if callback(place_to_copy, newnode_copy, placer, oldnode_copy, itemstack, pointed_thing_copy) then
311 itemstack:take_item()
313 return itemstack, true
316 function core.item_place_object(itemstack, placer, pointed_thing)
317 local pos = core.get_pointed_thing_position(pointed_thing, true)
319 local item = itemstack:take_item()
320 core.add_item(pos, item)
325 function core.item_place(itemstack, placer, pointed_thing, param2)
326 -- Call on_rightclick if the pointed node defines it
327 if pointed_thing.type == "node" and placer and
328 not placer:get_player_control().sneak then
329 local n = core.get_node(pointed_thing.under)
331 if core.registered_nodes[nn] and core.registered_nodes[nn].on_rightclick then
332 return core.registered_nodes[nn].on_rightclick(pointed_thing.under, n,
333 placer, itemstack, pointed_thing) or itemstack, false
337 if itemstack:get_definition().type == "node" then
338 return core.item_place_node(itemstack, placer, pointed_thing, param2)
343 function core.item_secondary_use(itemstack, placer)
347 function core.item_drop(itemstack, dropper, pos)
348 if dropper and dropper:is_player() then
349 local v = dropper:get_look_dir()
350 local p = {x=pos.x, y=pos.y+1.2, z=pos.z}
351 local cs = itemstack:get_count()
352 if dropper:get_player_control().sneak then
355 local item = itemstack:take_item(cs)
356 local obj = core.add_item(p, item)
362 obj:get_luaentity().dropped_by = dropper:get_player_name()
367 if core.add_item(pos, itemstack) then
371 -- If we reach this, adding the object to the
372 -- environment failed
375 function core.do_item_eat(hp_change, replace_with_item, itemstack, user, pointed_thing)
376 for _, callback in pairs(core.registered_on_item_eats) do
377 local result = callback(hp_change, replace_with_item, itemstack, user, pointed_thing)
382 if itemstack:take_item() ~= nil then
383 user:set_hp(user:get_hp() + hp_change)
385 if replace_with_item then
386 if itemstack:is_empty() then
387 itemstack:add_item(replace_with_item)
389 local inv = user:get_inventory()
390 if inv:room_for_item("main", {name=replace_with_item}) then
391 inv:add_item("main", replace_with_item)
393 local pos = user:getpos()
394 pos.y = math.floor(pos.y + 0.5)
395 core.add_item(pos, replace_with_item)
403 function core.item_eat(hp_change, replace_with_item)
404 return function(itemstack, user, pointed_thing) -- closure
405 return core.do_item_eat(hp_change, replace_with_item, itemstack, user, pointed_thing)
409 function core.node_punch(pos, node, puncher, pointed_thing)
411 for _, callback in ipairs(core.registered_on_punchnodes) do
412 -- Copy pos and node because callback can modify them
413 local pos_copy = vector.new(pos)
414 local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
415 local pointed_thing_copy = pointed_thing and copy_pointed_thing(pointed_thing) or nil
416 callback(pos_copy, node_copy, puncher, pointed_thing_copy)
420 function core.handle_node_drops(pos, drops, digger)
421 -- Add dropped items to object's inventory
422 if digger:get_inventory() then
423 local _, dropped_item
424 for _, dropped_item in ipairs(drops) do
425 local left = digger:get_inventory():add_item("main", dropped_item)
426 if not left:is_empty() then
428 x = pos.x + math.random()/2-0.25,
429 y = pos.y + math.random()/2-0.25,
430 z = pos.z + math.random()/2-0.25,
432 core.add_item(p, left)
438 function core.node_dig(pos, node, digger)
439 local def = ItemStack({name=node.name}):get_definition()
440 if not def.diggable or (def.can_dig and not def.can_dig(pos,digger)) then
441 core.log("info", digger:get_player_name() .. " tried to dig "
442 .. node.name .. " which is not diggable "
443 .. core.pos_to_string(pos))
447 if core.is_protected(pos, digger:get_player_name()) then
448 core.log("action", digger:get_player_name()
449 .. " tried to dig " .. node.name
450 .. " at protected position "
451 .. core.pos_to_string(pos))
452 core.record_protection_violation(pos, digger:get_player_name())
456 core.log('action', digger:get_player_name() .. " digs "
457 .. node.name .. " at " .. core.pos_to_string(pos))
459 local wielded = digger:get_wielded_item()
460 local drops = core.get_node_drops(node.name, wielded:get_name())
462 local wdef = wielded:get_definition()
463 local tp = wielded:get_tool_capabilities()
464 local dp = core.get_dig_params(def.groups, tp)
465 if wdef and wdef.after_use then
466 wielded = wdef.after_use(wielded, digger, node, dp) or wielded
469 if not core.setting_getbool("creative_mode") then
470 wielded:add_wear(dp.wear)
473 digger:set_wielded_item(wielded)
476 core.handle_node_drops(pos, drops, digger)
478 local oldmetadata = nil
479 if def.after_dig_node then
480 oldmetadata = core.get_meta(pos):to_table()
483 -- Remove node and update
484 core.remove_node(pos)
487 if def.after_dig_node then
488 -- Copy pos and node because callback can modify them
489 local pos_copy = {x=pos.x, y=pos.y, z=pos.z}
490 local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
491 def.after_dig_node(pos_copy, node_copy, oldmetadata, digger)
496 for _, callback in ipairs(core.registered_on_dignodes) do
497 local origin = core.callback_origins[callback]
499 core.set_last_run_mod(origin.mod)
500 --print("Running " .. tostring(callback) ..
501 -- " (a " .. origin.name .. " callback in " .. origin.mod .. ")")
503 --print("No data associated with callback")
506 -- Copy pos and node because callback can modify them
507 local pos_copy = {x=pos.x, y=pos.y, z=pos.z}
508 local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
509 callback(pos_copy, node_copy, digger)
513 -- This is used to allow mods to redefine core.item_place and so on
514 -- NOTE: This is not the preferred way. Preferred way is to provide enough
515 -- callbacks to not require redefining global functions. -celeron55
516 local function redef_wrapper(table, name)
518 return table[name](...)
523 -- Item definition defaults
526 core.nodedef_default = {
529 -- name intentionally not defined here
532 inventory_image = "",
534 wield_scale = {x=1,y=1,z=1},
537 liquids_pointable = false,
538 tool_capabilities = nil,
539 node_placement_prediction = nil,
541 -- Interaction callbacks
542 on_place = redef_wrapper(core, 'item_place'), -- core.item_place
543 on_drop = redef_wrapper(core, 'item_drop'), -- core.item_drop
547 on_punch = redef_wrapper(core, 'node_punch'), -- core.node_punch
549 on_dig = redef_wrapper(core, 'node_dig'), -- core.node_dig
551 on_receive_fields = nil,
553 on_metadata_inventory_move = core.node_metadata_inventory_move_allow_all,
554 on_metadata_inventory_offer = core.node_metadata_inventory_offer_allow_all,
555 on_metadata_inventory_take = core.node_metadata_inventory_take_allow_all,
560 -- Don't define these because otherwise the old tile_images and
561 -- special_materials wouldn't be read
564 -- {name="", backface_culling=true},
565 -- {name="", backface_culling=true},
568 post_effect_color = {a=0, r=0, g=0, b=0},
571 is_ground_content = true,
572 sunlight_propagates = false,
577 buildable_to = false,
580 liquid_alternative_flowing = "",
581 liquid_alternative_source = "",
582 liquid_viscosity = 0,
585 damage_per_second = 0,
586 selection_box = {type="regular"},
587 legacy_facedir_simple = false,
588 legacy_wallmounted = false,
591 core.craftitemdef_default = {
593 -- name intentionally not defined here
596 inventory_image = "",
598 wield_scale = {x=1,y=1,z=1},
600 liquids_pointable = false,
601 tool_capabilities = nil,
603 -- Interaction callbacks
604 on_place = redef_wrapper(core, 'item_place'), -- core.item_place
605 on_drop = redef_wrapper(core, 'item_drop'), -- core.item_drop
606 on_secondary_use = redef_wrapper(core, 'item_secondary_use'),
610 core.tooldef_default = {
612 -- name intentionally not defined here
615 inventory_image = "",
617 wield_scale = {x=1,y=1,z=1},
619 liquids_pointable = false,
620 tool_capabilities = nil,
622 -- Interaction callbacks
623 on_place = redef_wrapper(core, 'item_place'), -- core.item_place
624 on_secondary_use = redef_wrapper(core, 'item_secondary_use'),
625 on_drop = redef_wrapper(core, 'item_drop'), -- core.item_drop
629 core.noneitemdef_default = { -- This is used for the hand and unknown items
631 -- name intentionally not defined here
634 inventory_image = "",
636 wield_scale = {x=1,y=1,z=1},
638 liquids_pointable = false,
639 tool_capabilities = nil,
641 -- Interaction callbacks
642 on_place = redef_wrapper(core, 'item_place'),
643 on_secondary_use = redef_wrapper(core, 'item_secondary_use'),