]> git.lizzy.rs Git - minetest.git/blobdiff - builtin/item.lua
Add tool callback
[minetest.git] / builtin / item.lua
index 678a5cdac9a64722ee499b352fde497a52c61c98..7f20d30c583aa8939af7aa8442d490c55da0b46c 100644 (file)
@@ -34,8 +34,45 @@ function minetest.get_pointed_thing_position(pointed_thing, above)
        end
 end
 
-function minetest.dir_to_facedir(dir)
-       if math.abs(dir.x) > math.abs(dir.z) then
+function minetest.dir_to_facedir(dir, is6d)
+       --account for y if requested
+       if is6d and math.abs(dir.y) > math.abs(dir.x) and math.abs(dir.y) > math.abs(dir.z) then
+
+               --from above
+               if dir.y < 0 then
+                       if math.abs(dir.x) > math.abs(dir.z) then
+                               if dir.x < 0 then
+                                       return 19
+                               else
+                                       return 13
+                               end
+                       else
+                               if dir.z < 0 then
+                                       return 10
+                               else
+                                       return 4
+                               end
+                       end
+
+               --from below
+               else
+                       if math.abs(dir.x) > math.abs(dir.z) then
+                               if dir.x < 0 then
+                                       return 15
+                               else
+                                       return 17
+                               end
+                       else
+                               if dir.z < 0 then
+                                       return 6
+                               else
+                                       return 8
+                               end
+                       end
+               end
+
+       --otherwise, place horizontally
+       elseif math.abs(dir.x) > math.abs(dir.z) then
                if dir.x < 0 then
                        return 3
                else
@@ -50,6 +87,27 @@ function minetest.dir_to_facedir(dir)
        end
 end
 
+function minetest.facedir_to_dir(facedir)
+       --a table of possible dirs
+       return ({{x=0, y=0, z=1},
+                                       {x=1, y=0, z=0},
+                                       {x=0, y=0, z=-1},
+                                       {x=-1, y=0, z=0},
+                                       {x=0, y=-1, z=0},
+                                       {x=0, y=1, z=0}})
+
+                                       --indexed into by a table of correlating facedirs
+                                       [({[0]=1, 2, 3, 4, 
+                                               5, 4, 6, 2,
+                                               6, 2, 5, 4,
+                                               1, 5, 3, 6,
+                                               1, 6, 3, 5,
+                                               1, 4, 3, 2})
+
+                                               --indexed into by the facedir in question
+                                               [facedir]]
+end
+
 function minetest.dir_to_wallmounted(dir)
        if math.abs(dir.y) > math.max(math.abs(dir.x), math.abs(dir.z)) then
                if dir.y < 0 then
@@ -76,10 +134,10 @@ function minetest.get_node_drops(nodename, toolname)
        local drop = ItemStack({name=nodename}):get_definition().drop
        if drop == nil then
                -- default drop
-               return {ItemStack({name=nodename})}
+               return {nodename}
        elseif type(drop) == "string" then
                -- itemstring drop
-               return {ItemStack(drop)}
+               return {drop}
        elseif drop.items == nil then
                -- drop = {} to disable default drop
                return {}
@@ -121,89 +179,154 @@ function minetest.get_node_drops(nodename, toolname)
        return got_items
 end
 
-function minetest.item_place_node(itemstack, placer, pointed_thing)
+function minetest.item_place_node(itemstack, placer, pointed_thing, param2)
        local item = itemstack:peek_item()
        local def = itemstack:get_definition()
-       if def.type == "node" and pointed_thing.type == "node" then
-               local pos = pointed_thing.above
-               local oldnode = minetest.env:get_node(pos)
-               local olddef = ItemStack({name=oldnode.name}):get_definition()
-
-               if not olddef.buildable_to then
-                       minetest.log("info", placer:get_player_name() .. " tried to place"
-                               .. " node in invalid position " .. minetest.pos_to_string(pos)
-                               .. ", replacing " .. oldnode.name)
-                       return
-               end
+       if def.type ~= "node" or pointed_thing.type ~= "node" then
+               return itemstack, false
+       end
+
+       local under = pointed_thing.under
+       local oldnode_under = minetest.get_node_or_nil(under)
+       local above = pointed_thing.above
+       local oldnode_above = minetest.get_node_or_nil(above)
 
-               minetest.log("action", placer:get_player_name() .. " places node "
-                       .. def.name .. " at " .. minetest.pos_to_string(pos))
-
-               local newnode = {name = def.name, param1 = 0, param2 = 0}
-
-               -- Calculate direction for wall mounted stuff like torches and signs
-               if def.paramtype2 == 'wallmounted' then
-                       local under = pointed_thing.under
-                       local above = pointed_thing.above
-                       local dir = {x = under.x - above.x, y = under.y - above.y, z = under.z - above.z}
-                       newnode.param2 = minetest.dir_to_wallmounted(dir)
-               -- Calculate the direction for furnaces and chests and stuff
-               elseif def.paramtype2 == 'facedir' then
-                       local playerpos = placer:getpos()
-                       local dir = {x = pos.x - playerpos.x, y = pos.y - playerpos.y, z = pos.z - playerpos.z}
+       if not oldnode_under or not oldnode_above then
+               minetest.log("info", placer:get_player_name() .. " tried to place"
+                       .. " node in unloaded position " .. minetest.pos_to_string(above))
+               return itemstack, false
+       end
+
+       local olddef_under = ItemStack({name=oldnode_under.name}):get_definition()
+       olddef_under = olddef_under or minetest.nodedef_default
+       local olddef_above = ItemStack({name=oldnode_above.name}):get_definition()
+       olddef_above = olddef_above or minetest.nodedef_default
+
+       if not olddef_above.buildable_to and not olddef_under.buildable_to then
+               minetest.log("info", placer:get_player_name() .. " tried to place"
+                       .. " node in invalid position " .. minetest.pos_to_string(above)
+                       .. ", replacing " .. oldnode_above.name)
+               return itemstack, false
+       end
+
+       -- Place above pointed node
+       local place_to = {x = above.x, y = above.y, z = above.z}
+
+       -- If node under is buildable_to, place into it instead (eg. snow)
+       if olddef_under.buildable_to then
+               minetest.log("info", "node under is buildable to")
+               place_to = {x = under.x, y = under.y, z = under.z}
+       end
+
+       minetest.log("action", placer:get_player_name() .. " places node "
+               .. def.name .. " at " .. minetest.pos_to_string(place_to))
+       
+       local oldnode = minetest.get_node(place_to)
+       local newnode = {name = def.name, param1 = 0, param2 = param2}
+
+       -- Calculate direction for wall mounted stuff like torches and signs
+       if def.paramtype2 == 'wallmounted' and not param2 then
+               local dir = {
+                       x = under.x - above.x,
+                       y = under.y - above.y,
+                       z = under.z - above.z
+               }
+               newnode.param2 = minetest.dir_to_wallmounted(dir)
+       -- Calculate the direction for furnaces and chests and stuff
+       elseif def.paramtype2 == 'facedir' and not param2 then
+               local placer_pos = placer:getpos()
+               if placer_pos then
+                       local dir = {
+                               x = above.x - placer_pos.x,
+                               y = above.y - placer_pos.y,
+                               z = above.z - placer_pos.z
+                       }
                        newnode.param2 = minetest.dir_to_facedir(dir)
                        minetest.log("action", "facedir: " .. newnode.param2)
                end
+       end
+
+       -- Check if the node is attached and if it can be placed there
+       if minetest.get_item_group(def.name, "attached_node") ~= 0 and
+               not check_attached_node(place_to, newnode) then
+               minetest.log("action", "attached node " .. def.name ..
+                       " can not be placed at " .. minetest.pos_to_string(place_to))
+               return itemstack, false
+       end
+
+       -- Add node and update
+       minetest.add_node(place_to, newnode)
 
-               -- Add node and update
-               minetest.env:add_node(pos, newnode)
+       local take_item = true
 
-               -- Set metadata owner
-               if def.metadata_name ~= "" then
-                       minetest.env:get_meta(pos):set_owner(placer:get_player_name())
+       -- Run callback
+       if def.after_place_node then
+               -- Copy place_to because callback can modify it
+               local place_to_copy = {x=place_to.x, y=place_to.y, z=place_to.z}
+               if def.after_place_node(place_to_copy, placer, itemstack) then
+                       take_item = false
                end
+       end
 
-               -- Run script hook
-               local _, callback
-               for _, callback in ipairs(minetest.registered_on_placenodes) do
-                       callback(pos, newnode, placer)
+       -- Run script hook
+       local _, callback
+       for _, callback in ipairs(minetest.registered_on_placenodes) do
+               -- Copy pos and node because callback can modify them
+               local place_to_copy = {x=place_to.x, y=place_to.y, z=place_to.z}
+               local newnode_copy = {name=newnode.name, param1=newnode.param1, param2=newnode.param2}
+               local oldnode_copy = {name=oldnode.name, param1=oldnode.param1, param2=oldnode.param2}
+               if callback(place_to_copy, newnode_copy, placer, oldnode_copy, itemstack) then
+                       take_item = false
                end
+       end
 
+       if take_item then
                itemstack:take_item()
        end
-       return itemstack
+       return itemstack, true
 end
 
 function minetest.item_place_object(itemstack, placer, pointed_thing)
        local pos = minetest.get_pointed_thing_position(pointed_thing, true)
        if pos ~= nil then
                local item = itemstack:take_item()
-               minetest.env:add_item(pos, item)
+               minetest.add_item(pos, item)
        end
        return itemstack
 end
 
-function minetest.item_place(itemstack, placer, pointed_thing)
+function minetest.item_place(itemstack, placer, pointed_thing, param2)
+       -- Call on_rightclick if the pointed node defines it
+       if pointed_thing.type == "node" and placer and
+                       not placer:get_player_control().sneak then
+               local n = minetest.get_node(pointed_thing.under)
+               local nn = n.name
+               if minetest.registered_nodes[nn] and minetest.registered_nodes[nn].on_rightclick then
+                       return minetest.registered_nodes[nn].on_rightclick(pointed_thing.under, n, placer, itemstack) or itemstack, false
+               end
+       end
+
        if itemstack:get_definition().type == "node" then
-               return minetest.item_place_node(itemstack, placer, pointed_thing)
-       else
-               return minetest.item_place_object(itemstack, placer, pointed_thing)
+               return minetest.item_place_node(itemstack, placer, pointed_thing, param2)
        end
+       return itemstack
 end
 
 function minetest.item_drop(itemstack, dropper, pos)
        if dropper.get_player_name then
                local v = dropper:get_look_dir()
                local p = {x=pos.x+v.x, y=pos.y+1.5+v.y, z=pos.z+v.z}
-               local obj = minetest.env:add_item(p, itemstack)
-               v.x = v.x*2
-               v.y = v.y*2 + 1
-               v.z = v.z*2
-               obj:setvelocity(v)
+               local obj = minetest.add_item(p, itemstack)
+               if obj then
+                       v.x = v.x*2
+                       v.y = v.y*2 + 1
+                       v.z = v.z*2
+                       obj:setvelocity(v)
+               end
        else
-               minetest.env:add_item(pos, itemstack)
+               minetest.add_item(pos, itemstack)
        end
-       return ""
+       return ItemStack("")
 end
 
 function minetest.item_eat(hp_change, replace_with_item)
@@ -220,59 +343,95 @@ function minetest.node_punch(pos, node, puncher)
        -- Run script hook
        local _, callback
        for _, callback in ipairs(minetest.registered_on_punchnodes) do
-               callback(pos, node, puncher)
+               -- Copy pos and node because callback can modify them
+               local pos_copy = {x=pos.x, y=pos.y, z=pos.z}
+               local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
+               callback(pos_copy, node_copy, puncher)
        end
+end
 
+function minetest.handle_node_drops(pos, drops, digger)
+       -- Add dropped items to object's inventory
+       if digger:get_inventory() then
+               local _, dropped_item
+               for _, dropped_item in ipairs(drops) do
+                       local left = digger:get_inventory():add_item("main", dropped_item)
+                       if not left:is_empty() then
+                               local p = {
+                                       x = pos.x + math.random()/2-0.25,
+                                       y = pos.y + math.random()/2-0.25,
+                                       z = pos.z + math.random()/2-0.25,
+                               }
+                               minetest.add_item(p, left)
+                       end
+               end
+       end
 end
 
 function minetest.node_dig(pos, node, digger)
-       minetest.debug("node_dig")
-
        local def = ItemStack({name=node.name}):get_definition()
-       if not def.diggable then
-               minetest.debug("not diggable")
+       -- Check if def ~= 0 because we always want to be able to remove unknown nodes
+       if #def ~= 0 and not def.diggable or (def.can_dig and not def.can_dig(pos,digger)) then
                minetest.log("info", digger:get_player_name() .. " tried to dig "
                        .. node.name .. " which is not diggable "
                        .. minetest.pos_to_string(pos))
                return
        end
 
-       local meta = minetest.env:get_meta(pos)
-       if meta ~= nil and not meta:get_allow_removal() then
-               minetest.debug("dig prevented by metadata")
-               minetest.log("info", digger:get_player_name() .. " tried to dig "
-                       .. node.name .. ", but removal is disabled by metadata "
-                       .. minetest.pos_to_string(pos))
-               return
-       end
-
        minetest.log('action', digger:get_player_name() .. " digs "
                .. node.name .. " at " .. minetest.pos_to_string(pos))
 
-       if not minetest.setting_getbool("creative_mode") then
-               local wielded = digger:get_wielded_item()
-               local drops = minetest.get_node_drops(node.name, wielded:get_name())
-
+       local wielded = digger:get_wielded_item()
+       local drops = minetest.get_node_drops(node.name, wielded:get_name())
+       
+       local wdef = wielded:get_definition()
+       local tp = wielded:get_tool_capabilities()
+       local dp = minetest.get_dig_params(def.groups, tp)
+       if wdef and wdef.after_use then
+               wielded = wdef.after_use(wielded, digger, node, dp) or wielded
+       else
                -- Wear out tool
-               tp = wielded:get_tool_capabilities()
-               dp = minetest.get_dig_params(def.groups, tp)
-               wielded:add_wear(dp.wear)
-               digger:set_wielded_item(wielded)
-
-               -- Add dropped items
-               local _, dropped_item
-               for _, dropped_item in ipairs(drops) do
-                       digger:get_inventory():add_item("main", dropped_item)
+               if not minetest.setting_getbool("creative_mode") then
+                       wielded:add_wear(dp.wear)
                end
        end
+       digger:set_wielded_item(wielded)
+       
+       -- Handle drops
+       minetest.handle_node_drops(pos, drops, digger)
+
+       local oldmetadata = nil
+       if def.after_dig_node then
+               oldmetadata = minetest.get_meta(pos):to_table()
+       end
 
        -- Remove node and update
-       minetest.env:remove_node(pos)
+       minetest.remove_node(pos)
+       
+       -- Run callback
+       if def.after_dig_node then
+               -- Copy pos and node because callback can modify them
+               local pos_copy = {x=pos.x, y=pos.y, z=pos.z}
+               local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
+               def.after_dig_node(pos_copy, node_copy, oldmetadata, digger)
+       end
 
        -- Run script hook
        local _, callback
        for _, callback in ipairs(minetest.registered_on_dignodes) do
-               callback(pos, node, digger)
+               -- Copy pos and node because callback can modify them
+               local pos_copy = {x=pos.x, y=pos.y, z=pos.z}
+               local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
+               callback(pos_copy, node_copy, digger)
+       end
+end
+
+-- This is used to allow mods to redefine minetest.item_place and so on
+-- NOTE: This is not the preferred way. Preferred way is to provide enough
+--       callbacks to not require redefining global functions. -celeron55
+local function redef_wrapper(table, name)
+       return function(...)
+               return table[name](...)
        end
 end
 
@@ -293,23 +452,34 @@ minetest.nodedef_default = {
        usable = false,
        liquids_pointable = false,
        tool_capabilities = nil,
+       node_placement_prediction = nil,
 
        -- Interaction callbacks
-       on_place = minetest.item_place,
-       on_drop = minetest.item_drop,
+       on_place = redef_wrapper(minetest, 'item_place'), -- minetest.item_place
+       on_drop = redef_wrapper(minetest, 'item_drop'), -- minetest.item_drop
        on_use = nil,
+       can_dig = nil,
+
+       on_punch = redef_wrapper(minetest, 'node_punch'), -- minetest.node_punch
+       on_rightclick = nil,
+       on_dig = redef_wrapper(minetest, 'node_dig'), -- minetest.node_dig
 
-       on_punch = minetest.node_punch,
-       on_dig = minetest.node_dig,
+       on_receive_fields = nil,
+       
+       on_metadata_inventory_move = minetest.node_metadata_inventory_move_allow_all,
+       on_metadata_inventory_offer = minetest.node_metadata_inventory_offer_allow_all,
+       on_metadata_inventory_take = minetest.node_metadata_inventory_take_allow_all,
 
        -- Node properties
        drawtype = "normal",
        visual_scale = 1.0,
-       tile_images = {""},
-       special_materials = {
-               {image="", backface_culling=true},
-               {image="", backface_culling=true},
-       },
+       -- Don't define these because otherwise the old tile_images and
+       -- special_materials wouldn't be read
+       --tiles ={""},
+       --special_tiles = {
+       --      {name="", backface_culling=true},
+       --      {name="", backface_culling=true},
+       --},
        alpha = 255,
        post_effect_color = {a=0, r=0, g=0, b=0},
        paramtype = "none",
@@ -321,11 +491,11 @@ minetest.nodedef_default = {
        diggable = true,
        climbable = false,
        buildable_to = false,
-       metadata_name = "",
        liquidtype = "none",
        liquid_alternative_flowing = "",
        liquid_alternative_source = "",
        liquid_viscosity = 0,
+       drowning = 0,
        light_source = 0,
        damage_per_second = 0,
        selection_box = {type="regular"},
@@ -346,8 +516,8 @@ minetest.craftitemdef_default = {
        tool_capabilities = nil,
 
        -- Interaction callbacks
-       on_place = minetest.item_place,
-       on_drop = minetest.item_drop,
+       on_place = redef_wrapper(minetest, 'item_place'), -- minetest.item_place
+       on_drop = redef_wrapper(minetest, 'item_drop'), -- minetest.item_drop
        on_use = nil,
 }
 
@@ -364,8 +534,8 @@ minetest.tooldef_default = {
        tool_capabilities = nil,
 
        -- Interaction callbacks
-       on_place = minetest.item_place,
-       on_drop = minetest.item_drop,
+       on_place = redef_wrapper(minetest, 'item_place'), -- minetest.item_place
+       on_drop = redef_wrapper(minetest, 'item_drop'), -- minetest.item_drop
        on_use = nil,
 }
 
@@ -382,7 +552,7 @@ minetest.noneitemdef_default = {  -- This is used for the hand and unknown items
        tool_capabilities = nil,
 
        -- Interaction callbacks
-       on_place = nil,
+       on_place = redef_wrapper(minetest, 'item_place'),
        on_drop = nil,
        on_use = nil,
 }