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 function core.facedir_to_dir(facedir)
92 --a table of possible dirs
93 return ({{x=0, y=0, z=1},
100 --indexed into by a table of correlating facedirs
108 --indexed into by the facedir in question
112 function core.dir_to_wallmounted(dir)
113 if math.abs(dir.y) > math.max(math.abs(dir.x), math.abs(dir.z)) then
119 elseif math.abs(dir.x) > math.abs(dir.z) then
134 function core.wallmounted_to_dir(wallmounted)
135 -- table of dirs in wallmounted order
136 return ({[0] = {x = 0, y = 1, z = 0},
137 {x = 0, y = -1, z = 0},
138 {x = 1, y = 0, z = 0},
139 {x = -1, y = 0, z = 0},
140 {x = 0, y = 0, z = 1},
141 {x = 0, y = 0, z = -1}})
143 --indexed into by the wallmounted in question
147 function core.get_node_drops(nodename, toolname)
148 local drop = ItemStack({name=nodename}):get_definition().drop
152 elseif type(drop) == "string" then
155 elseif drop.items == nil then
156 -- drop = {} to disable default drop
160 -- Extended drop table
164 for _, item in ipairs(drop.items) do
165 local good_rarity = true
166 local good_tool = true
167 if item.rarity ~= nil then
168 good_rarity = item.rarity < 1 or math.random(item.rarity) == 1
170 if item.tools ~= nil then
172 for _, tool in ipairs(item.tools) do
173 if tool:sub(1, 1) == '~' then
174 good_tool = toolname:find(tool:sub(2)) ~= nil
176 good_tool = toolname == tool
183 if good_rarity and good_tool then
184 got_count = got_count + 1
185 for _, add_item in ipairs(item.items) do
186 got_items[#got_items+1] = add_item
188 if drop.max_items ~= nil and got_count == drop.max_items then
196 function core.item_place_node(itemstack, placer, pointed_thing, param2)
197 local item = itemstack:peek_item()
198 local def = itemstack:get_definition()
199 if def.type ~= "node" or pointed_thing.type ~= "node" then
200 return itemstack, false
203 local under = pointed_thing.under
204 local oldnode_under = core.get_node_or_nil(under)
205 local above = pointed_thing.above
206 local oldnode_above = core.get_node_or_nil(above)
208 if not oldnode_under or not oldnode_above then
209 core.log("info", placer:get_player_name() .. " tried to place"
210 .. " node in unloaded position " .. core.pos_to_string(above))
211 return itemstack, false
214 local olddef_under = ItemStack({name=oldnode_under.name}):get_definition()
215 olddef_under = olddef_under or core.nodedef_default
216 local olddef_above = ItemStack({name=oldnode_above.name}):get_definition()
217 olddef_above = olddef_above or core.nodedef_default
219 if not olddef_above.buildable_to and not olddef_under.buildable_to then
220 core.log("info", placer:get_player_name() .. " tried to place"
221 .. " node in invalid position " .. core.pos_to_string(above)
222 .. ", replacing " .. oldnode_above.name)
223 return itemstack, false
226 -- Place above pointed node
227 local place_to = {x = above.x, y = above.y, z = above.z}
229 -- If node under is buildable_to, place into it instead (eg. snow)
230 if olddef_under.buildable_to then
231 core.log("info", "node under is buildable to")
232 place_to = {x = under.x, y = under.y, z = under.z}
235 if core.is_protected(place_to, placer:get_player_name()) then
236 core.log("action", placer:get_player_name()
237 .. " tried to place " .. def.name
238 .. " at protected position "
239 .. core.pos_to_string(place_to))
240 core.record_protection_violation(place_to, placer:get_player_name())
244 core.log("action", placer:get_player_name() .. " places node "
245 .. def.name .. " at " .. core.pos_to_string(place_to))
247 local oldnode = core.get_node(place_to)
248 local newnode = {name = def.name, param1 = 0, param2 = param2}
250 -- Calculate direction for wall mounted stuff like torches and signs
251 if def.paramtype2 == 'wallmounted' and not param2 then
253 x = under.x - above.x,
254 y = under.y - above.y,
255 z = under.z - above.z
257 newnode.param2 = core.dir_to_wallmounted(dir)
258 -- Calculate the direction for furnaces and chests and stuff
259 elseif def.paramtype2 == 'facedir' and not param2 then
260 local placer_pos = placer:getpos()
263 x = above.x - placer_pos.x,
264 y = above.y - placer_pos.y,
265 z = above.z - placer_pos.z
267 newnode.param2 = core.dir_to_facedir(dir)
268 core.log("action", "facedir: " .. newnode.param2)
272 -- Check if the node is attached and if it can be placed there
273 if core.get_item_group(def.name, "attached_node") ~= 0 and
274 not check_attached_node(place_to, newnode) then
275 core.log("action", "attached node " .. def.name ..
276 " can not be placed at " .. core.pos_to_string(place_to))
277 return itemstack, false
280 -- Add node and update
281 core.add_node(place_to, newnode)
283 local take_item = true
286 if def.after_place_node then
287 -- Deepcopy place_to and pointed_thing because callback can modify it
288 local place_to_copy = {x=place_to.x, y=place_to.y, z=place_to.z}
289 local pointed_thing_copy = copy_pointed_thing(pointed_thing)
290 if def.after_place_node(place_to_copy, placer, itemstack,
291 pointed_thing_copy) then
298 for _, callback in ipairs(core.registered_on_placenodes) do
299 -- Deepcopy pos, node and pointed_thing because callback can modify them
300 local place_to_copy = {x=place_to.x, y=place_to.y, z=place_to.z}
301 local newnode_copy = {name=newnode.name, param1=newnode.param1, param2=newnode.param2}
302 local oldnode_copy = {name=oldnode.name, param1=oldnode.param1, param2=oldnode.param2}
303 local pointed_thing_copy = copy_pointed_thing(pointed_thing)
304 if callback(place_to_copy, newnode_copy, placer, oldnode_copy, itemstack, pointed_thing_copy) then
310 itemstack:take_item()
312 return itemstack, true
315 function core.item_place_object(itemstack, placer, pointed_thing)
316 local pos = core.get_pointed_thing_position(pointed_thing, true)
318 local item = itemstack:take_item()
319 core.add_item(pos, item)
324 function core.item_place(itemstack, placer, pointed_thing, param2)
325 -- Call on_rightclick if the pointed node defines it
326 if pointed_thing.type == "node" and placer and
327 not placer:get_player_control().sneak then
328 local n = core.get_node(pointed_thing.under)
330 if core.registered_nodes[nn] and core.registered_nodes[nn].on_rightclick then
331 return core.registered_nodes[nn].on_rightclick(pointed_thing.under, n,
332 placer, itemstack, pointed_thing) or itemstack, false
336 if itemstack:get_definition().type == "node" then
337 return core.item_place_node(itemstack, placer, pointed_thing, param2)
342 function core.item_secondary_use(itemstack, placer)
346 function core.item_drop(itemstack, dropper, pos)
347 if dropper and dropper:is_player() then
348 local v = dropper:get_look_dir()
349 local p = {x=pos.x, y=pos.y+1.2, z=pos.z}
350 local cs = itemstack:get_count()
351 if dropper:get_player_control().sneak then
354 local item = itemstack:take_item(cs)
355 local obj = core.add_item(p, item)
361 obj:get_luaentity().dropped_by = dropper:get_player_name()
366 if core.add_item(pos, itemstack) then
370 -- If we reach this, adding the object to the
371 -- environment failed
374 function core.do_item_eat(hp_change, replace_with_item, itemstack, user, pointed_thing)
375 for _, callback in pairs(core.registered_on_item_eats) do
376 local result = callback(hp_change, replace_with_item, itemstack, user, pointed_thing)
381 if itemstack:take_item() ~= nil then
382 user:set_hp(user:get_hp() + hp_change)
384 if replace_with_item then
385 if itemstack:is_empty() then
386 itemstack:add_item(replace_with_item)
388 local inv = user:get_inventory()
389 if inv:room_for_item("main", {name=replace_with_item}) then
390 inv:add_item("main", replace_with_item)
392 local pos = user:getpos()
393 pos.y = math.floor(pos.y + 0.5)
394 core.add_item(pos, replace_with_item)
402 function core.item_eat(hp_change, replace_with_item)
403 return function(itemstack, user, pointed_thing) -- closure
404 return core.do_item_eat(hp_change, replace_with_item, itemstack, user, pointed_thing)
408 function core.node_punch(pos, node, puncher, pointed_thing)
410 for _, callback in ipairs(core.registered_on_punchnodes) do
411 -- Copy pos and node because callback can modify them
412 local pos_copy = vector.new(pos)
413 local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
414 local pointed_thing_copy = pointed_thing and copy_pointed_thing(pointed_thing) or nil
415 callback(pos_copy, node_copy, puncher, pointed_thing_copy)
419 function core.handle_node_drops(pos, drops, digger)
420 -- Add dropped items to object's inventory
421 if digger:get_inventory() then
422 local _, dropped_item
423 for _, dropped_item in ipairs(drops) do
424 local left = digger:get_inventory():add_item("main", dropped_item)
425 if not left:is_empty() then
427 x = pos.x + math.random()/2-0.25,
428 y = pos.y + math.random()/2-0.25,
429 z = pos.z + math.random()/2-0.25,
431 core.add_item(p, left)
437 function core.node_dig(pos, node, digger)
438 local def = ItemStack({name=node.name}):get_definition()
439 if not def.diggable or (def.can_dig and not def.can_dig(pos,digger)) then
440 core.log("info", digger:get_player_name() .. " tried to dig "
441 .. node.name .. " which is not diggable "
442 .. core.pos_to_string(pos))
446 if core.is_protected(pos, digger:get_player_name()) then
447 core.log("action", digger:get_player_name()
448 .. " tried to dig " .. node.name
449 .. " at protected position "
450 .. core.pos_to_string(pos))
451 core.record_protection_violation(pos, digger:get_player_name())
455 core.log('action', digger:get_player_name() .. " digs "
456 .. node.name .. " at " .. core.pos_to_string(pos))
458 local wielded = digger:get_wielded_item()
459 local drops = core.get_node_drops(node.name, wielded:get_name())
461 local wdef = wielded:get_definition()
462 local tp = wielded:get_tool_capabilities()
463 local dp = core.get_dig_params(def.groups, tp)
464 if wdef and wdef.after_use then
465 wielded = wdef.after_use(wielded, digger, node, dp) or wielded
468 if not core.setting_getbool("creative_mode") then
469 wielded:add_wear(dp.wear)
472 digger:set_wielded_item(wielded)
475 core.handle_node_drops(pos, drops, digger)
477 local oldmetadata = nil
478 if def.after_dig_node then
479 oldmetadata = core.get_meta(pos):to_table()
482 -- Remove node and update
483 core.remove_node(pos)
486 if def.after_dig_node then
487 -- Copy pos and node because callback can modify them
488 local pos_copy = {x=pos.x, y=pos.y, z=pos.z}
489 local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
490 def.after_dig_node(pos_copy, node_copy, oldmetadata, digger)
495 for _, callback in ipairs(core.registered_on_dignodes) do
496 local origin = core.callback_origins[callback]
498 core.set_last_run_mod(origin.mod)
499 --print("Running " .. tostring(callback) ..
500 -- " (a " .. origin.name .. " callback in " .. origin.mod .. ")")
502 --print("No data associated with callback")
505 -- Copy pos and node because callback can modify them
506 local pos_copy = {x=pos.x, y=pos.y, z=pos.z}
507 local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
508 callback(pos_copy, node_copy, digger)
512 -- This is used to allow mods to redefine core.item_place and so on
513 -- NOTE: This is not the preferred way. Preferred way is to provide enough
514 -- callbacks to not require redefining global functions. -celeron55
515 local function redef_wrapper(table, name)
517 return table[name](...)
522 -- Item definition defaults
525 core.nodedef_default = {
528 -- name intentionally not defined here
531 inventory_image = "",
533 wield_scale = {x=1,y=1,z=1},
536 liquids_pointable = false,
537 tool_capabilities = nil,
538 node_placement_prediction = nil,
540 -- Interaction callbacks
541 on_place = redef_wrapper(core, 'item_place'), -- core.item_place
542 on_drop = redef_wrapper(core, 'item_drop'), -- core.item_drop
546 on_punch = redef_wrapper(core, 'node_punch'), -- core.node_punch
548 on_dig = redef_wrapper(core, 'node_dig'), -- core.node_dig
550 on_receive_fields = nil,
552 on_metadata_inventory_move = core.node_metadata_inventory_move_allow_all,
553 on_metadata_inventory_offer = core.node_metadata_inventory_offer_allow_all,
554 on_metadata_inventory_take = core.node_metadata_inventory_take_allow_all,
559 -- Don't define these because otherwise the old tile_images and
560 -- special_materials wouldn't be read
563 -- {name="", backface_culling=true},
564 -- {name="", backface_culling=true},
567 post_effect_color = {a=0, r=0, g=0, b=0},
570 is_ground_content = true,
571 sunlight_propagates = false,
576 buildable_to = false,
579 liquid_alternative_flowing = "",
580 liquid_alternative_source = "",
581 liquid_viscosity = 0,
584 damage_per_second = 0,
585 selection_box = {type="regular"},
586 legacy_facedir_simple = false,
587 legacy_wallmounted = false,
590 core.craftitemdef_default = {
592 -- name intentionally not defined here
595 inventory_image = "",
597 wield_scale = {x=1,y=1,z=1},
599 liquids_pointable = false,
600 tool_capabilities = nil,
602 -- Interaction callbacks
603 on_place = redef_wrapper(core, 'item_place'), -- core.item_place
604 on_drop = redef_wrapper(core, 'item_drop'), -- core.item_drop
605 on_secondary_use = redef_wrapper(core, 'item_secondary_use'),
609 core.tooldef_default = {
611 -- name intentionally not defined here
614 inventory_image = "",
616 wield_scale = {x=1,y=1,z=1},
618 liquids_pointable = false,
619 tool_capabilities = nil,
621 -- Interaction callbacks
622 on_place = redef_wrapper(core, 'item_place'), -- core.item_place
623 on_secondary_use = redef_wrapper(core, 'item_secondary_use'),
624 on_drop = redef_wrapper(core, 'item_drop'), -- core.item_drop
628 core.noneitemdef_default = { -- This is used for the hand and unknown items
630 -- name intentionally not defined here
633 inventory_image = "",
635 wield_scale = {x=1,y=1,z=1},
637 liquids_pointable = false,
638 tool_capabilities = nil,
640 -- Interaction callbacks
641 on_place = redef_wrapper(core, 'item_place'),
642 on_secondary_use = redef_wrapper(core, 'item_secondary_use'),