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
79 return {ItemStack({name=nodename})}
80 elseif type(drop) == "string" then
82 return {ItemStack(drop)}
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" and pointed_thing.type == "node" then
128 local pos = pointed_thing.above
129 local oldnode = minetest.env:get_node(pos)
130 local olddef = ItemStack({name=oldnode.name}):get_definition()
132 if not olddef.buildable_to then
133 minetest.log("info", placer:get_player_name() .. " tried to place"
134 .. " node in invalid position " .. minetest.pos_to_string(pos)
135 .. ", replacing " .. oldnode.name)
139 minetest.log("action", placer:get_player_name() .. " places node "
140 .. def.name .. " at " .. minetest.pos_to_string(pos))
142 local newnode = {name = def.name, param1 = 0, param2 = 0}
144 -- Calculate direction for wall mounted stuff like torches and signs
145 if def.paramtype2 == 'wallmounted' then
146 local under = pointed_thing.under
147 local above = pointed_thing.above
148 local dir = {x = under.x - above.x, y = under.y - above.y, z = under.z - above.z}
149 newnode.param2 = minetest.dir_to_wallmounted(dir)
150 -- Calculate the direction for furnaces and chests and stuff
151 elseif def.paramtype2 == 'facedir' then
152 local playerpos = placer:getpos()
153 local dir = {x = pos.x - playerpos.x, y = pos.y - playerpos.y, z = pos.z - playerpos.z}
154 newnode.param2 = minetest.dir_to_facedir(dir)
155 minetest.log("action", "facedir: " .. newnode.param2)
158 -- Add node and update
159 minetest.env:add_node(pos, newnode)
162 if def.after_place_node then
163 def.after_place_node(pos, placer)
166 -- Run script hook (deprecated)
168 for _, callback in ipairs(minetest.registered_on_placenodes) do
169 callback(pos, newnode, placer)
172 itemstack:take_item()
177 function minetest.item_place_object(itemstack, placer, pointed_thing)
178 local pos = minetest.get_pointed_thing_position(pointed_thing, true)
180 local item = itemstack:take_item()
181 minetest.env:add_item(pos, item)
186 function minetest.item_place(itemstack, placer, pointed_thing)
187 if itemstack:get_definition().type == "node" then
188 return minetest.item_place_node(itemstack, placer, pointed_thing)
190 return minetest.item_place_object(itemstack, placer, pointed_thing)
194 function minetest.item_drop(itemstack, dropper, pos)
195 if dropper.get_player_name then
196 local v = dropper:get_look_dir()
197 local p = {x=pos.x+v.x, y=pos.y+1.5+v.y, z=pos.z+v.z}
198 local obj = minetest.env:add_item(p, itemstack)
204 minetest.env:add_item(pos, itemstack)
209 function minetest.item_eat(hp_change, replace_with_item)
210 return function(itemstack, user, pointed_thing) -- closure
211 if itemstack:take_item() ~= nil then
212 user:set_hp(user:get_hp() + hp_change)
213 itemstack:add_item(replace_with_item) -- note: replace_with_item is optional
219 function minetest.node_punch(pos, node, puncher)
222 for _, callback in ipairs(minetest.registered_on_punchnodes) do
223 callback(pos, node, puncher)
228 function minetest.node_dig(pos, node, digger)
229 minetest.debug("node_dig")
231 local def = ItemStack({name=node.name}):get_definition()
232 if not def.diggable or (def.can_dig and not def.can_dig(pos,digger)) then
233 minetest.debug("not diggable")
234 minetest.log("info", digger:get_player_name() .. " tried to dig "
235 .. node.name .. " which is not diggable "
236 .. minetest.pos_to_string(pos))
240 minetest.log('action', digger:get_player_name() .. " digs "
241 .. node.name .. " at " .. minetest.pos_to_string(pos))
243 if not minetest.setting_getbool("creative_mode") then
244 local wielded = digger:get_wielded_item()
245 local drops = minetest.get_node_drops(node.name, wielded:get_name())
248 tp = wielded:get_tool_capabilities()
249 dp = minetest.get_dig_params(def.groups, tp)
250 wielded:add_wear(dp.wear)
251 digger:set_wielded_item(wielded)
253 -- Add dropped items to object's inventory
254 if digger:get_inventory() then
255 local _, dropped_item
256 for _, dropped_item in ipairs(drops) do
257 digger:get_inventory():add_item("main", dropped_item)
263 local oldmetadata = nil
264 if def.after_dig_node then
266 oldmetadata = minetest.env:get_meta(pos):to_table()
269 -- Remove node and update
270 minetest.env:remove_node(pos)
273 if def.after_dig_node then
274 def.after_dig_node(pos, oldnode, oldmetadata, digger)
277 -- Run script hook (deprecated)
279 for _, callback in ipairs(minetest.registered_on_dignodes) do
280 callback(pos, node, digger)
284 function minetest.node_metadata_inventory_move_allow_all(pos, from_list,
285 from_index, to_list, to_index, count, player)
286 minetest.log("verbose", "node_metadata_inventory_move_allow_all")
287 local meta = minetest.env:get_meta(pos)
288 local inv = meta:get_inventory()
290 local from_stack = inv:get_stack(from_list, from_index)
291 local taken_items = from_stack:take_item(count)
292 inv:set_stack(from_list, from_index, from_stack)
294 local to_stack = inv:get_stack(to_list, to_index)
295 to_stack:add_item(taken_items)
296 inv:set_stack(to_list, to_index, to_stack)
299 function minetest.node_metadata_inventory_offer_allow_all(pos, listname, index, stack, player)
300 minetest.log("verbose", "node_metadata_inventory_offer_allow_all")
301 local meta = minetest.env:get_meta(pos)
302 local inv = meta:get_inventory()
303 local the_stack = inv:get_stack(listname, index)
304 the_stack:add_item(stack)
305 inv:set_stack(listname, index, the_stack)
309 function minetest.node_metadata_inventory_take_allow_all(pos, listname, index, count, player)
310 minetest.log("verbose", "node_metadata_inventory_take_allow_all")
311 local meta = minetest.env:get_meta(pos)
312 local inv = meta:get_inventory()
313 local the_stack = inv:get_stack(listname, index)
314 local taken_items = the_stack:take_item(count)
315 inv:set_stack(listname, index, the_stack)
319 -- This is used to allow mods to redefine minetest.item_place and so on
320 -- NOTE: This is not the preferred way. Preferred way is to provide enough
321 -- callbacks to not require redefining global functions. -celeron55
322 local function redef_wrapper(table, name)
324 return table[name](...)
329 -- Item definition defaults
332 minetest.nodedef_default = {
335 -- name intentionally not defined here
338 inventory_image = "",
340 wield_scale = {x=1,y=1,z=1},
343 liquids_pointable = false,
344 tool_capabilities = nil,
345 node_placement_prediction = nil,
347 -- Interaction callbacks
348 on_place = redef_wrapper(minetest, 'item_place'), -- minetest.item_place
349 on_drop = redef_wrapper(minetest, 'item_drop'), -- minetest.item_drop
353 on_punch = redef_wrapper(minetest, 'node_punch'), -- minetest.node_punch
354 on_dig = redef_wrapper(minetest, 'node_dig'), -- minetest.node_dig
356 on_receive_fields = nil,
358 on_metadata_inventory_move = minetest.node_metadata_inventory_move_allow_all,
359 on_metadata_inventory_offer = minetest.node_metadata_inventory_offer_allow_all,
360 on_metadata_inventory_take = minetest.node_metadata_inventory_take_allow_all,
365 -- Don't define these because otherwise the old tile_images and
366 -- special_materials wouldn't be read
369 -- {name="", backface_culling=true},
370 -- {name="", backface_culling=true},
373 post_effect_color = {a=0, r=0, g=0, b=0},
376 is_ground_content = false,
377 sunlight_propagates = false,
382 buildable_to = false,
384 liquid_alternative_flowing = "",
385 liquid_alternative_source = "",
386 liquid_viscosity = 0,
388 damage_per_second = 0,
389 selection_box = {type="regular"},
390 legacy_facedir_simple = false,
391 legacy_wallmounted = false,
394 minetest.craftitemdef_default = {
396 -- name intentionally not defined here
399 inventory_image = "",
401 wield_scale = {x=1,y=1,z=1},
403 liquids_pointable = false,
404 tool_capabilities = nil,
406 -- Interaction callbacks
407 on_place = redef_wrapper(minetest, 'item_place'), -- minetest.item_place
408 on_drop = redef_wrapper(minetest, 'item_drop'), -- minetest.item_drop
412 minetest.tooldef_default = {
414 -- name intentionally not defined here
417 inventory_image = "",
419 wield_scale = {x=1,y=1,z=1},
421 liquids_pointable = false,
422 tool_capabilities = nil,
424 -- Interaction callbacks
425 on_place = redef_wrapper(minetest, 'item_place'), -- minetest.item_place
426 on_drop = redef_wrapper(minetest, 'item_drop'), -- minetest.item_drop
430 minetest.noneitemdef_default = { -- This is used for the hand and unknown items
432 -- name intentionally not defined here
435 inventory_image = "",
437 wield_scale = {x=1,y=1,z=1},
439 liquids_pointable = false,
440 tool_capabilities = nil,
442 -- Interaction callbacks