1 -- Minetest: builtin/item.lua
4 -- Item definition helpers
7 function minetest.inventorycube(img1, img2, img3)
10 return "[inventorycube"
11 .. "{" .. img1:gsub("%^", "&")
12 .. "{" .. img2:gsub("%^", "&")
13 .. "{" .. img3:gsub("%^", "&")
16 function minetest.get_pointed_thing_position(pointed_thing, above)
17 if pointed_thing.type == "node" then
19 -- The position where a node would be placed
20 return pointed_thing.above
22 -- The position where a node would be dug
23 return pointed_thing.under
25 elseif pointed_thing.type == "object" then
26 obj = pointed_thing.ref
37 function minetest.dir_to_facedir(dir, is6d)
38 --account for y if requested
39 if is6d and math.abs(dir.y) > math.abs(dir.x) and math.abs(dir.y) > math.abs(dir.z) then
43 if math.abs(dir.x) > math.abs(dir.z) then
59 if math.abs(dir.x) > math.abs(dir.z) then
74 --otherwise, place horizontally
75 elseif math.abs(dir.x) > math.abs(dir.z) then
90 function minetest.facedir_to_dir(facedir)
91 --a table of possible dirs
92 return ({{x=0, y=0, z=1},
99 --indexed into by a table of correlating facedirs
107 --indexed into by the facedir in question
111 function minetest.dir_to_wallmounted(dir)
112 if math.abs(dir.y) > math.max(math.abs(dir.x), math.abs(dir.z)) then
118 elseif math.abs(dir.x) > math.abs(dir.z) then
133 function minetest.get_node_drops(nodename, toolname)
134 local drop = ItemStack({name=nodename}):get_definition().drop
138 elseif type(drop) == "string" then
141 elseif drop.items == nil then
142 -- drop = {} to disable default drop
146 -- Extended drop table
150 for _, item in ipairs(drop.items) do
151 local good_rarity = true
152 local good_tool = true
153 if item.rarity ~= nil then
154 good_rarity = item.rarity < 1 or math.random(item.rarity) == 1
156 if item.tools ~= nil then
158 for _, tool in ipairs(item.tools) do
159 if tool:sub(1, 1) == '~' then
160 good_tool = toolname:find(tool:sub(2)) ~= nil
162 good_tool = toolname == tool
169 if good_rarity and good_tool then
170 got_count = got_count + 1
171 for _, add_item in ipairs(item.items) do
172 got_items[#got_items+1] = add_item
174 if drop.max_items ~= nil and got_count == drop.max_items then
182 function minetest.item_place_node(itemstack, placer, pointed_thing, param2)
183 local item = itemstack:peek_item()
184 local def = itemstack:get_definition()
185 if def.type ~= "node" or pointed_thing.type ~= "node" then
186 return itemstack, false
189 local under = pointed_thing.under
190 local oldnode_under = minetest.get_node_or_nil(under)
191 local above = pointed_thing.above
192 local oldnode_above = minetest.get_node_or_nil(above)
194 if not oldnode_under or not oldnode_above then
195 minetest.log("info", placer:get_player_name() .. " tried to place"
196 .. " node in unloaded position " .. minetest.pos_to_string(above))
197 return itemstack, false
200 local olddef_under = ItemStack({name=oldnode_under.name}):get_definition()
201 olddef_under = olddef_under or minetest.nodedef_default
202 local olddef_above = ItemStack({name=oldnode_above.name}):get_definition()
203 olddef_above = olddef_above or minetest.nodedef_default
205 if not olddef_above.buildable_to and not olddef_under.buildable_to then
206 minetest.log("info", placer:get_player_name() .. " tried to place"
207 .. " node in invalid position " .. minetest.pos_to_string(above)
208 .. ", replacing " .. oldnode_above.name)
209 return itemstack, false
212 -- Place above pointed node
213 local place_to = {x = above.x, y = above.y, z = above.z}
215 -- If node under is buildable_to, place into it instead (eg. snow)
216 if olddef_under.buildable_to then
217 minetest.log("info", "node under is buildable to")
218 place_to = {x = under.x, y = under.y, z = under.z}
221 minetest.log("action", placer:get_player_name() .. " places node "
222 .. def.name .. " at " .. minetest.pos_to_string(place_to))
224 local oldnode = minetest.get_node(place_to)
225 local newnode = {name = def.name, param1 = 0, param2 = param2}
227 -- Calculate direction for wall mounted stuff like torches and signs
228 if def.paramtype2 == 'wallmounted' and not param2 then
230 x = under.x - above.x,
231 y = under.y - above.y,
232 z = under.z - above.z
234 newnode.param2 = minetest.dir_to_wallmounted(dir)
235 -- Calculate the direction for furnaces and chests and stuff
236 elseif def.paramtype2 == 'facedir' and not param2 then
237 local placer_pos = placer:getpos()
240 x = above.x - placer_pos.x,
241 y = above.y - placer_pos.y,
242 z = above.z - placer_pos.z
244 newnode.param2 = minetest.dir_to_facedir(dir)
245 minetest.log("action", "facedir: " .. newnode.param2)
249 -- Check if the node is attached and if it can be placed there
250 if minetest.get_item_group(def.name, "attached_node") ~= 0 and
251 not check_attached_node(place_to, newnode) then
252 minetest.log("action", "attached node " .. def.name ..
253 " can not be placed at " .. minetest.pos_to_string(place_to))
254 return itemstack, false
257 -- Add node and update
258 minetest.add_node(place_to, newnode)
260 local take_item = true
263 if def.after_place_node then
264 -- Copy place_to because callback can modify it
265 local place_to_copy = {x=place_to.x, y=place_to.y, z=place_to.z}
266 if def.after_place_node(place_to_copy, placer, itemstack) then
273 for _, callback in ipairs(minetest.registered_on_placenodes) do
274 -- Copy pos and node because callback can modify them
275 local place_to_copy = {x=place_to.x, y=place_to.y, z=place_to.z}
276 local newnode_copy = {name=newnode.name, param1=newnode.param1, param2=newnode.param2}
277 local oldnode_copy = {name=oldnode.name, param1=oldnode.param1, param2=oldnode.param2}
278 if callback(place_to_copy, newnode_copy, placer, oldnode_copy, itemstack) then
284 itemstack:take_item()
286 return itemstack, true
289 function minetest.item_place_object(itemstack, placer, pointed_thing)
290 local pos = minetest.get_pointed_thing_position(pointed_thing, true)
292 local item = itemstack:take_item()
293 minetest.add_item(pos, item)
298 function minetest.item_place(itemstack, placer, pointed_thing, param2)
299 -- Call on_rightclick if the pointed node defines it
300 if pointed_thing.type == "node" and placer and
301 not placer:get_player_control().sneak then
302 local n = minetest.get_node(pointed_thing.under)
304 if minetest.registered_nodes[nn] and minetest.registered_nodes[nn].on_rightclick then
305 return minetest.registered_nodes[nn].on_rightclick(pointed_thing.under, n, placer, itemstack) or itemstack, false
309 if itemstack:get_definition().type == "node" then
310 return minetest.item_place_node(itemstack, placer, pointed_thing, param2)
315 function minetest.item_drop(itemstack, dropper, pos)
316 if dropper.get_player_name then
317 local v = dropper:get_look_dir()
318 local p = {x=pos.x+v.x, y=pos.y+1.5+v.y, z=pos.z+v.z}
319 local obj = minetest.add_item(p, itemstack)
327 minetest.add_item(pos, itemstack)
332 function minetest.item_eat(hp_change, replace_with_item)
333 return function(itemstack, user, pointed_thing) -- closure
334 if itemstack:take_item() ~= nil then
335 user:set_hp(user:get_hp() + hp_change)
336 itemstack:add_item(replace_with_item) -- note: replace_with_item is optional
342 function minetest.node_punch(pos, node, puncher)
345 for _, callback in ipairs(minetest.registered_on_punchnodes) do
346 -- Copy pos and node because callback can modify them
347 local pos_copy = {x=pos.x, y=pos.y, z=pos.z}
348 local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
349 callback(pos_copy, node_copy, puncher)
353 function minetest.handle_node_drops(pos, drops, digger)
354 -- Add dropped items to object's inventory
355 if digger:get_inventory() then
356 local _, dropped_item
357 for _, dropped_item in ipairs(drops) do
358 local left = digger:get_inventory():add_item("main", dropped_item)
359 if not left:is_empty() then
361 x = pos.x + math.random()/2-0.25,
362 y = pos.y + math.random()/2-0.25,
363 z = pos.z + math.random()/2-0.25,
365 minetest.add_item(p, left)
371 function minetest.node_dig(pos, node, digger)
372 local def = ItemStack({name=node.name}):get_definition()
373 -- Check if def ~= 0 because we always want to be able to remove unknown nodes
374 if #def ~= 0 and not def.diggable or (def.can_dig and not def.can_dig(pos,digger)) then
375 minetest.log("info", digger:get_player_name() .. " tried to dig "
376 .. node.name .. " which is not diggable "
377 .. minetest.pos_to_string(pos))
381 minetest.log('action', digger:get_player_name() .. " digs "
382 .. node.name .. " at " .. minetest.pos_to_string(pos))
384 local wielded = digger:get_wielded_item()
385 local drops = minetest.get_node_drops(node.name, wielded:get_name())
387 local wdef = wielded:get_definition()
388 local tp = wielded:get_tool_capabilities()
389 local dp = minetest.get_dig_params(def.groups, tp)
390 if wdef and wdef.after_use then
391 wielded = wdef.after_use(wielded, digger, node, dp) or wielded
394 if not minetest.setting_getbool("creative_mode") then
395 wielded:add_wear(dp.wear)
398 digger:set_wielded_item(wielded)
401 minetest.handle_node_drops(pos, drops, digger)
403 local oldmetadata = nil
404 if def.after_dig_node then
405 oldmetadata = minetest.get_meta(pos):to_table()
408 -- Remove node and update
409 minetest.remove_node(pos)
412 if def.after_dig_node then
413 -- Copy pos and node because callback can modify them
414 local pos_copy = {x=pos.x, y=pos.y, z=pos.z}
415 local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
416 def.after_dig_node(pos_copy, node_copy, oldmetadata, digger)
421 for _, callback in ipairs(minetest.registered_on_dignodes) do
422 -- Copy pos and node because callback can modify them
423 local pos_copy = {x=pos.x, y=pos.y, z=pos.z}
424 local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
425 callback(pos_copy, node_copy, digger)
429 -- This is used to allow mods to redefine minetest.item_place and so on
430 -- NOTE: This is not the preferred way. Preferred way is to provide enough
431 -- callbacks to not require redefining global functions. -celeron55
432 local function redef_wrapper(table, name)
434 return table[name](...)
439 -- Item definition defaults
442 minetest.nodedef_default = {
445 -- name intentionally not defined here
448 inventory_image = "",
450 wield_scale = {x=1,y=1,z=1},
453 liquids_pointable = false,
454 tool_capabilities = nil,
455 node_placement_prediction = nil,
457 -- Interaction callbacks
458 on_place = redef_wrapper(minetest, 'item_place'), -- minetest.item_place
459 on_drop = redef_wrapper(minetest, 'item_drop'), -- minetest.item_drop
463 on_punch = redef_wrapper(minetest, 'node_punch'), -- minetest.node_punch
465 on_dig = redef_wrapper(minetest, 'node_dig'), -- minetest.node_dig
467 on_receive_fields = nil,
469 on_metadata_inventory_move = minetest.node_metadata_inventory_move_allow_all,
470 on_metadata_inventory_offer = minetest.node_metadata_inventory_offer_allow_all,
471 on_metadata_inventory_take = minetest.node_metadata_inventory_take_allow_all,
476 -- Don't define these because otherwise the old tile_images and
477 -- special_materials wouldn't be read
480 -- {name="", backface_culling=true},
481 -- {name="", backface_culling=true},
484 post_effect_color = {a=0, r=0, g=0, b=0},
487 is_ground_content = false,
488 sunlight_propagates = false,
493 buildable_to = false,
495 liquid_alternative_flowing = "",
496 liquid_alternative_source = "",
497 liquid_viscosity = 0,
500 damage_per_second = 0,
501 selection_box = {type="regular"},
502 legacy_facedir_simple = false,
503 legacy_wallmounted = false,
506 minetest.craftitemdef_default = {
508 -- name intentionally not defined here
511 inventory_image = "",
513 wield_scale = {x=1,y=1,z=1},
515 liquids_pointable = false,
516 tool_capabilities = nil,
518 -- Interaction callbacks
519 on_place = redef_wrapper(minetest, 'item_place'), -- minetest.item_place
520 on_drop = redef_wrapper(minetest, 'item_drop'), -- minetest.item_drop
524 minetest.tooldef_default = {
526 -- name intentionally not defined here
529 inventory_image = "",
531 wield_scale = {x=1,y=1,z=1},
533 liquids_pointable = false,
534 tool_capabilities = nil,
536 -- Interaction callbacks
537 on_place = redef_wrapper(minetest, 'item_place'), -- minetest.item_place
538 on_drop = redef_wrapper(minetest, 'item_drop'), -- minetest.item_drop
542 minetest.noneitemdef_default = { -- This is used for the hand and unknown items
544 -- name intentionally not defined here
547 inventory_image = "",
549 wield_scale = {x=1,y=1,z=1},
551 liquids_pointable = false,
552 tool_capabilities = nil,
554 -- Interaction callbacks
555 on_place = redef_wrapper(minetest, 'item_place'),