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)
38 if math.abs(dir.x) > math.abs(dir.z) then
53 function minetest.dir_to_wallmounted(dir)
54 if math.abs(dir.y) > math.max(math.abs(dir.x), math.abs(dir.z)) then
60 elseif math.abs(dir.x) > math.abs(dir.z) then
75 function minetest.get_node_drops(nodename, toolname)
76 local drop = ItemStack({name=nodename}):get_definition().drop
80 elseif type(drop) == "string" then
83 elseif drop.items == nil then
84 -- drop = {} to disable default drop
88 -- Extended drop table
92 for _, item in ipairs(drop.items) do
93 local good_rarity = true
94 local good_tool = true
95 if item.rarity ~= nil then
96 good_rarity = item.rarity < 1 or math.random(item.rarity) == 1
98 if item.tools ~= nil then
100 for _, tool in ipairs(item.tools) do
101 if tool:sub(1, 1) == '~' then
102 good_tool = toolname:find(tool:sub(2)) ~= nil
104 good_tool = toolname == tool
111 if good_rarity and good_tool then
112 got_count = got_count + 1
113 for _, add_item in ipairs(item.items) do
114 got_items[#got_items+1] = add_item
116 if drop.max_items ~= nil and got_count == drop.max_items then
124 function minetest.item_place_node(itemstack, placer, pointed_thing)
125 local item = itemstack:peek_item()
126 local def = itemstack:get_definition()
127 if def.type ~= "node" or pointed_thing.type ~= "node" then
131 local under = pointed_thing.under
132 local oldnode_under = minetest.env:get_node(under)
133 local olddef_under = ItemStack({name=oldnode_under.name}):get_definition()
134 olddef_under = olddef_under or minetest.nodedef_default
135 local above = pointed_thing.above
136 local oldnode_above = minetest.env:get_node(above)
137 local olddef_above = ItemStack({name=oldnode_above.name}):get_definition()
138 olddef_above = olddef_above or minetest.nodedef_default
140 if not olddef_above.buildable_to and not olddef_under.buildable_to then
141 minetest.log("info", placer:get_player_name() .. " tried to place"
142 .. " node in invalid position " .. minetest.pos_to_string(above)
143 .. ", replacing " .. oldnode_above.name)
147 -- Place above pointed node
148 local place_to = {x = above.x, y = above.y, z = above.z}
150 -- If node under is buildable_to, place into it instead (eg. snow)
151 if olddef_under.buildable_to then
152 minetest.log("info", "node under is buildable to")
153 place_to = {x = under.x, y = under.y, z = under.z}
156 minetest.log("action", placer:get_player_name() .. " places node "
157 .. def.name .. " at " .. minetest.pos_to_string(place_to))
159 local oldnode = minetest.env:get_node(place_to)
160 local newnode = {name = def.name, param1 = 0, param2 = 0}
162 -- Calculate direction for wall mounted stuff like torches and signs
163 if def.paramtype2 == 'wallmounted' then
165 x = under.x - above.x,
166 y = under.y - above.y,
167 z = under.z - above.z
169 newnode.param2 = minetest.dir_to_wallmounted(dir)
170 -- Calculate the direction for furnaces and chests and stuff
171 elseif def.paramtype2 == 'facedir' then
172 local placer_pos = placer:getpos()
175 x = above.x - placer_pos.x,
176 y = above.y - placer_pos.y,
177 z = above.z - placer_pos.z
179 newnode.param2 = minetest.dir_to_facedir(dir)
180 minetest.log("action", "facedir: " .. newnode.param2)
184 -- Check if the node is attached and if it can be placed there
185 if minetest.get_item_group(def.name, "attached_node") ~= 0 and
186 not check_attached_node(place_to, newnode) then
187 minetest.log("action", "attached node " .. def.name ..
188 " can not be placed at " .. minetest.pos_to_string(place_to))
192 -- Add node and update
193 minetest.env:add_node(place_to, newnode)
195 local take_item = true
198 if def.after_place_node then
199 -- Copy place_to because callback can modify it
200 local place_to_copy = {x=place_to.x, y=place_to.y, z=place_to.z}
201 if def.after_place_node(place_to_copy, placer, itemstack) then
208 for _, callback in ipairs(minetest.registered_on_placenodes) do
209 -- Copy pos and node because callback can modify them
210 local place_to_copy = {x=place_to.x, y=place_to.y, z=place_to.z}
211 local newnode_copy = {name=newnode.name, param1=newnode.param1, param2=newnode.param2}
212 local oldnode_copy = {name=oldnode.name, param1=oldnode.param1, param2=oldnode.param2}
213 if callback(place_to_copy, newnode_copy, placer, oldnode_copy, itemstack) then
219 itemstack:take_item()
224 function minetest.item_place_object(itemstack, placer, pointed_thing)
225 local pos = minetest.get_pointed_thing_position(pointed_thing, true)
227 local item = itemstack:take_item()
228 minetest.env:add_item(pos, item)
233 function minetest.item_place(itemstack, placer, pointed_thing)
234 -- Call on_rightclick if the pointed node defines it
235 if pointed_thing.type == "node" and placer and
236 not placer:get_player_control().sneak then
237 local n = minetest.env:get_node(pointed_thing.under)
239 if minetest.registered_nodes[nn] and minetest.registered_nodes[nn].on_rightclick then
240 return minetest.registered_nodes[nn].on_rightclick(pointed_thing.under, n, placer, itemstack)
244 if itemstack:get_definition().type == "node" then
245 return minetest.item_place_node(itemstack, placer, pointed_thing)
246 elseif itemstack:get_definition().type ~= "none" then
247 return minetest.item_place_object(itemstack, placer, pointed_thing)
251 function minetest.item_drop(itemstack, dropper, pos)
252 if dropper.get_player_name then
253 local v = dropper:get_look_dir()
254 local p = {x=pos.x+v.x, y=pos.y+1.5+v.y, z=pos.z+v.z}
255 local obj = minetest.env:add_item(p, itemstack)
263 minetest.env:add_item(pos, itemstack)
268 function minetest.item_eat(hp_change, replace_with_item)
269 return function(itemstack, user, pointed_thing) -- closure
270 if itemstack:take_item() ~= nil then
271 user:set_hp(user:get_hp() + hp_change)
272 itemstack:add_item(replace_with_item) -- note: replace_with_item is optional
278 function minetest.node_punch(pos, node, puncher)
281 for _, callback in ipairs(minetest.registered_on_punchnodes) do
282 -- Copy pos and node because callback can modify them
283 local pos_copy = {x=pos.x, y=pos.y, z=pos.z}
284 local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
285 callback(pos_copy, node_copy, puncher)
289 function minetest.handle_node_drops(pos, drops, digger)
290 -- Add dropped items to object's inventory
291 if digger:get_inventory() then
292 local _, dropped_item
293 for _, dropped_item in ipairs(drops) do
294 digger:get_inventory():add_item("main", dropped_item)
299 function minetest.node_dig(pos, node, digger)
300 minetest.debug("node_dig")
302 local def = ItemStack({name=node.name}):get_definition()
303 -- Check if def ~= 0 because we always want to be able to remove unknown nodes
304 if #def ~= 0 and not def.diggable or (def.can_dig and not def.can_dig(pos,digger)) then
305 minetest.debug("not diggable")
306 minetest.log("info", digger:get_player_name() .. " tried to dig "
307 .. node.name .. " which is not diggable "
308 .. minetest.pos_to_string(pos))
312 minetest.log('action', digger:get_player_name() .. " digs "
313 .. node.name .. " at " .. minetest.pos_to_string(pos))
315 local wielded = digger:get_wielded_item()
316 local drops = minetest.get_node_drops(node.name, wielded:get_name())
319 local tp = wielded:get_tool_capabilities()
320 local dp = minetest.get_dig_params(def.groups, tp)
321 wielded:add_wear(dp.wear)
322 digger:set_wielded_item(wielded)
325 minetest.handle_node_drops(pos, drops, digger)
327 local oldmetadata = nil
328 if def.after_dig_node then
329 oldmetadata = minetest.env:get_meta(pos):to_table()
332 -- Remove node and update
333 minetest.env:remove_node(pos)
336 if def.after_dig_node then
337 -- Copy pos and node because callback can modify them
338 local pos_copy = {x=pos.x, y=pos.y, z=pos.z}
339 local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
340 def.after_dig_node(pos_copy, node_copy, oldmetadata, digger)
345 for _, callback in ipairs(minetest.registered_on_dignodes) 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, digger)
353 -- This is used to allow mods to redefine minetest.item_place and so on
354 -- NOTE: This is not the preferred way. Preferred way is to provide enough
355 -- callbacks to not require redefining global functions. -celeron55
356 local function redef_wrapper(table, name)
358 return table[name](...)
363 -- Item definition defaults
366 minetest.nodedef_default = {
369 -- name intentionally not defined here
372 inventory_image = "",
374 wield_scale = {x=1,y=1,z=1},
377 liquids_pointable = false,
378 tool_capabilities = nil,
379 node_placement_prediction = nil,
381 -- Interaction callbacks
382 on_place = redef_wrapper(minetest, 'item_place'), -- minetest.item_place
383 on_drop = redef_wrapper(minetest, 'item_drop'), -- minetest.item_drop
387 on_punch = redef_wrapper(minetest, 'node_punch'), -- minetest.node_punch
389 on_dig = redef_wrapper(minetest, 'node_dig'), -- minetest.node_dig
391 on_receive_fields = nil,
393 on_metadata_inventory_move = minetest.node_metadata_inventory_move_allow_all,
394 on_metadata_inventory_offer = minetest.node_metadata_inventory_offer_allow_all,
395 on_metadata_inventory_take = minetest.node_metadata_inventory_take_allow_all,
400 -- Don't define these because otherwise the old tile_images and
401 -- special_materials wouldn't be read
404 -- {name="", backface_culling=true},
405 -- {name="", backface_culling=true},
408 post_effect_color = {a=0, r=0, g=0, b=0},
411 is_ground_content = false,
412 sunlight_propagates = false,
417 buildable_to = false,
419 liquid_alternative_flowing = "",
420 liquid_alternative_source = "",
421 liquid_viscosity = 0,
423 damage_per_second = 0,
424 selection_box = {type="regular"},
425 legacy_facedir_simple = false,
426 legacy_wallmounted = false,
429 minetest.craftitemdef_default = {
431 -- name intentionally not defined here
434 inventory_image = "",
436 wield_scale = {x=1,y=1,z=1},
438 liquids_pointable = false,
439 tool_capabilities = nil,
441 -- Interaction callbacks
442 on_place = redef_wrapper(minetest, 'item_place'), -- minetest.item_place
443 on_drop = redef_wrapper(minetest, 'item_drop'), -- minetest.item_drop
447 minetest.tooldef_default = {
449 -- name intentionally not defined here
452 inventory_image = "",
454 wield_scale = {x=1,y=1,z=1},
456 liquids_pointable = false,
457 tool_capabilities = nil,
459 -- Interaction callbacks
460 on_place = redef_wrapper(minetest, 'item_place'), -- minetest.item_place
461 on_drop = redef_wrapper(minetest, 'item_drop'), -- minetest.item_drop
465 minetest.noneitemdef_default = { -- This is used for the hand and unknown items
467 -- name intentionally not defined here
470 inventory_image = "",
472 wield_scale = {x=1,y=1,z=1},
474 liquids_pointable = false,
475 tool_capabilities = nil,
477 -- Interaction callbacks
478 on_place = redef_wrapper(minetest, 'item_place'),