builtin/item.lua

   1 -- Minetest: builtin/item.lua
   2
   3 --
   4 -- Item definition helpers
   5 --
   6
   7 function minetest.inventorycube(img1, img2, img3)
   8         img2 = img2 or img1
   9         img3 = img3 or img1
  10         return "[inventorycube"
  11                         .. "{" .. img1:gsub("%^", "&")
  12                         .. "{" .. img2:gsub("%^", "&")
  13                         .. "{" .. img3:gsub("%^", "&")
  14 end
  15
  16 function minetest.get_pointed_thing_position(pointed_thing, above)
  17         if pointed_thing.type == "node" then
  18                 if above then
  19                         -- The position where a node would be placed
  20                         return pointed_thing.above
  21                 else
  22                         -- The position where a node would be dug
  23                         return pointed_thing.under
  24                 end
  25         elseif pointed_thing.type == "object" then
  26                 obj = pointed_thing.ref
  27                 if obj ~= nil then
  28                         return obj:getpos()
  29                 else
  30                         return nil
  31                 end
  32         else
  33                 return nil
  34         end
  35 end
  36
  37 function minetest.dir_to_facedir(dir)
  38         if math.abs(dir.x) > math.abs(dir.z) then
  39                 if dir.x < 0 then
  40                         return 3
  41                 else
  42                         return 1
  43                 end
  44         else
  45                 if dir.z < 0 then
  46                         return 2
  47                 else
  48                         return 0
  49                 end
  50         end
  51 end
  52
  53 function minetest.dir_to_wallmounted(dir)
  54         if math.abs(dir.y) > math.max(math.abs(dir.x), math.abs(dir.z)) then
  55                 if dir.y < 0 then
  56                         return 1
  57                 else
  58                         return 0
  59                 end
  60         elseif math.abs(dir.x) > math.abs(dir.z) then
  61                 if dir.x < 0 then
  62                         return 3
  63                 else
  64                         return 2
  65                 end
  66         else
  67                 if dir.z < 0 then
  68                         return 5
  69                 else
  70                         return 4
  71                 end
  72         end
  73 end
  74
  75 function minetest.get_node_drops(nodename, toolname)
  76         local drop = ItemStack({name=nodename}):get_definition().drop
  77         if drop == nil then
  78                 -- default drop
  79                 return {nodename}
  80         elseif type(drop) == "string" then
  81                 -- itemstring drop
  82                 return {drop}
  83         elseif drop.items == nil then
  84                 -- drop = {} to disable default drop
  85                 return {}
  86         end
  87
  88         -- Extended drop table
  89         local got_items = {}
  90         local got_count = 0
  91         local _, item, tool
  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
  97                 end
  98                 if item.tools ~= nil then
  99                         good_tool = false
 100                         for _, tool in ipairs(item.tools) do
 101                                 if tool:sub(1, 1) == '~' then
 102                                         good_tool = toolname:find(tool:sub(2)) ~= nil
 103                                 else
 104                                         good_tool = toolname == tool
 105                                 end
 106                                 if good_tool then
 107                                         break
 108                                 end
 109                         end
 110                 end
 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
 115                         end
 116                         if drop.max_items ~= nil and got_count == drop.max_items then
 117                                 break
 118                         end
 119                 end
 120         end
 121         return got_items
 122 end
 123
 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
 128                 return itemstack
 129         end
 130
 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
 139
 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)
 144                 return itemstack
 145         end
 146
 147         -- Place above pointed node
 148         local place_to = {x = above.x, y = above.y, z = above.z}
 149
 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}
 154         end
 155
 156         minetest.log("action", placer:get_player_name() .. " places node "
 157                 .. def.name .. " at " .. minetest.pos_to_string(place_to))
 158
 159         local oldnode = minetest.env:get_node(place_to)
 160         local newnode = {name = def.name, param1 = 0, param2 = 0}
 161
 162         -- Calculate direction for wall mounted stuff like torches and signs
 163         if def.paramtype2 == 'wallmounted' then
 164                 local dir = {
 165                         x = under.x - above.x,
 166                         y = under.y - above.y,
 167                         z = under.z - above.z
 168                 }
 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()
 173                 if placer_pos then
 174                         local dir = {
 175                                 x = above.x - placer_pos.x,
 176                                 y = above.y - placer_pos.y,
 177                                 z = above.z - placer_pos.z
 178                         }
 179                         newnode.param2 = minetest.dir_to_facedir(dir)
 180                         minetest.log("action", "facedir: " .. newnode.param2)
 181                 end
 182         end
 183
 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))
 189                 return itemstack
 190         end
 191
 192         -- Add node and update
 193         minetest.env:add_node(place_to, newnode)
 194
 195         local take_item = true
 196
 197         -- Run callback
 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
 202                         take_item = false
 203                 end
 204         end
 205
 206         -- Run script hook
 207         local _, callback
 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
 214                         take_item = false
 215                 end
 216         end
 217
 218         if take_item then
 219                 itemstack:take_item()
 220         end
 221         return itemstack
 222 end
 223
 224 function minetest.item_place_object(itemstack, placer, pointed_thing)
 225         local pos = minetest.get_pointed_thing_position(pointed_thing, true)
 226         if pos ~= nil then
 227                 local item = itemstack:take_item()
 228                 minetest.env:add_item(pos, item)
 229         end
 230         return itemstack
 231 end
 232
 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)
 238                 local nn = n.name
 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)
 241                 end
 242         end
 243
 244         if itemstack:get_definition().type == "node" then
 245                 return minetest.item_place_node(itemstack, placer, pointed_thing)
 246         end
 247         return itemstack
 248 end
 249
 250 function minetest.item_drop(itemstack, dropper, pos)
 251         if dropper.get_player_name then
 252                 local v = dropper:get_look_dir()
 253                 local p = {x=pos.x+v.x, y=pos.y+1.5+v.y, z=pos.z+v.z}
 254                 local obj = minetest.env:add_item(p, itemstack)
 255                 if obj then
 256                         v.x = v.x*2
 257                         v.y = v.y*2 + 1
 258                         v.z = v.z*2
 259                         obj:setvelocity(v)
 260                 end
 261         else
 262                 minetest.env:add_item(pos, itemstack)
 263         end
 264         return ItemStack("")
 265 end
 266
 267 function minetest.item_eat(hp_change, replace_with_item)
 268         return function(itemstack, user, pointed_thing)  -- closure
 269                 if itemstack:take_item() ~= nil then
 270                         user:set_hp(user:get_hp() + hp_change)
 271                         itemstack:add_item(replace_with_item) -- note: replace_with_item is optional
 272                 end
 273                 return itemstack
 274         end
 275 end
 276
 277 function minetest.node_punch(pos, node, puncher)
 278         -- Run script hook
 279         local _, callback
 280         for _, callback in ipairs(minetest.registered_on_punchnodes) do
 281                 -- Copy pos and node because callback can modify them
 282                 local pos_copy = {x=pos.x, y=pos.y, z=pos.z}
 283                 local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
 284                 callback(pos_copy, node_copy, puncher)
 285         end
 286 end
 287
 288 function minetest.handle_node_drops(pos, drops, digger)
 289         -- Add dropped items to object's inventory
 290         if digger:get_inventory() then
 291                 local _, dropped_item
 292                 for _, dropped_item in ipairs(drops) do
 293                         digger:get_inventory():add_item("main", dropped_item)
 294                 end
 295         end
 296 end
 297
 298 function minetest.node_dig(pos, node, digger)
 299         minetest.debug("node_dig")
 300
 301         local def = ItemStack({name=node.name}):get_definition()
 302         -- Check if def ~= 0 because we always want to be able to remove unknown nodes
 303         if #def ~= 0 and not def.diggable or (def.can_dig and not def.can_dig(pos,digger)) then
 304                 minetest.debug("not diggable")
 305                 minetest.log("info", digger:get_player_name() .. " tried to dig "
 306                         .. node.name .. " which is not diggable "
 307                         .. minetest.pos_to_string(pos))
 308                 return
 309         end
 310
 311         minetest.log('action', digger:get_player_name() .. " digs "
 312                 .. node.name .. " at " .. minetest.pos_to_string(pos))
 313
 314         local wielded = digger:get_wielded_item()
 315         local drops = minetest.get_node_drops(node.name, wielded:get_name())
 316
 317         -- Wear out tool
 318         local tp = wielded:get_tool_capabilities()
 319         local dp = minetest.get_dig_params(def.groups, tp)
 320         wielded:add_wear(dp.wear)
 321         digger:set_wielded_item(wielded)
 322
 323         -- Handle drops
 324         minetest.handle_node_drops(pos, drops, digger)
 325
 326         local oldmetadata = nil
 327         if def.after_dig_node then
 328                 oldmetadata = minetest.env:get_meta(pos):to_table()
 329         end
 330
 331         -- Remove node and update
 332         minetest.env:remove_node(pos)
 333
 334         -- Run callback
 335         if def.after_dig_node then
 336                 -- Copy pos and node because callback can modify them
 337                 local pos_copy = {x=pos.x, y=pos.y, z=pos.z}
 338                 local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
 339                 def.after_dig_node(pos_copy, node_copy, oldmetadata, digger)
 340         end
 341
 342         -- Run script hook
 343         local _, callback
 344         for _, callback in ipairs(minetest.registered_on_dignodes) do
 345                 -- Copy pos and node because callback can modify them
 346                 local pos_copy = {x=pos.x, y=pos.y, z=pos.z}
 347                 local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
 348                 callback(pos_copy, node_copy, digger)
 349         end
 350 end
 351
 352 -- This is used to allow mods to redefine minetest.item_place and so on
 353 -- NOTE: This is not the preferred way. Preferred way is to provide enough
 354 --       callbacks to not require redefining global functions. -celeron55
 355 local function redef_wrapper(table, name)
 356         return function(...)
 357                 return table[name](...)
 358         end
 359 end
 360
 361 --
 362 -- Item definition defaults
 363 --
 364
 365 minetest.nodedef_default = {
 366         -- Item properties
 367         type="node",
 368         -- name intentionally not defined here
 369         description = "",
 370         groups = {},
 371         inventory_image = "",
 372         wield_image = "",
 373         wield_scale = {x=1,y=1,z=1},
 374         stack_max = 99,
 375         usable = false,
 376         liquids_pointable = false,
 377         tool_capabilities = nil,
 378         node_placement_prediction = nil,
 379
 380         -- Interaction callbacks
 381         on_place = redef_wrapper(minetest, 'item_place'), -- minetest.item_place
 382         on_drop = redef_wrapper(minetest, 'item_drop'), -- minetest.item_drop
 383         on_use = nil,
 384         can_dig = nil,
 385
 386         on_punch = redef_wrapper(minetest, 'node_punch'), -- minetest.node_punch
 387         on_rightclick = nil,
 388         on_dig = redef_wrapper(minetest, 'node_dig'), -- minetest.node_dig
 389
 390         on_receive_fields = nil,
 391
 392         on_metadata_inventory_move = minetest.node_metadata_inventory_move_allow_all,
 393         on_metadata_inventory_offer = minetest.node_metadata_inventory_offer_allow_all,
 394         on_metadata_inventory_take = minetest.node_metadata_inventory_take_allow_all,
 395
 396         -- Node properties
 397         drawtype = "normal",
 398         visual_scale = 1.0,
 399         -- Don't define these because otherwise the old tile_images and
 400         -- special_materials wouldn't be read
 401         --tiles ={""},
 402         --special_tiles = {
 403         --      {name="", backface_culling=true},
 404         --      {name="", backface_culling=true},
 405         --},
 406         alpha = 255,
 407         post_effect_color = {a=0, r=0, g=0, b=0},
 408         paramtype = "none",
 409         paramtype2 = "none",
 410         is_ground_content = false,
 411         sunlight_propagates = false,
 412         walkable = true,
 413         pointable = true,
 414         diggable = true,
 415         climbable = false,
 416         buildable_to = false,
 417         liquidtype = "none",
 418         liquid_alternative_flowing = "",
 419         liquid_alternative_source = "",
 420         liquid_viscosity = 0,
 421         light_source = 0,
 422         damage_per_second = 0,
 423         selection_box = {type="regular"},
 424         legacy_facedir_simple = false,
 425         legacy_wallmounted = false,
 426 }
 427
 428 minetest.craftitemdef_default = {
 429         type="craft",
 430         -- name intentionally not defined here
 431         description = "",
 432         groups = {},
 433         inventory_image = "",
 434         wield_image = "",
 435         wield_scale = {x=1,y=1,z=1},
 436         stack_max = 99,
 437         liquids_pointable = false,
 438         tool_capabilities = nil,
 439
 440         -- Interaction callbacks
 441         on_place = redef_wrapper(minetest, 'item_place'), -- minetest.item_place
 442         on_drop = redef_wrapper(minetest, 'item_drop'), -- minetest.item_drop
 443         on_use = nil,
 444 }
 445
 446 minetest.tooldef_default = {
 447         type="tool",
 448         -- name intentionally not defined here
 449         description = "",
 450         groups = {},
 451         inventory_image = "",
 452         wield_image = "",
 453         wield_scale = {x=1,y=1,z=1},
 454         stack_max = 1,
 455         liquids_pointable = false,
 456         tool_capabilities = nil,
 457
 458         -- Interaction callbacks
 459         on_place = redef_wrapper(minetest, 'item_place'), -- minetest.item_place
 460         on_drop = redef_wrapper(minetest, 'item_drop'), -- minetest.item_drop
 461         on_use = nil,
 462 }
 463
 464 minetest.noneitemdef_default = {  -- This is used for the hand and unknown items
 465         type="none",
 466         -- name intentionally not defined here
 467         description = "",
 468         groups = {},
 469         inventory_image = "",
 470         wield_image = "",
 471         wield_scale = {x=1,y=1,z=1},
 472         stack_max = 99,
 473         liquids_pointable = false,
 474         tool_capabilities = nil,
 475
 476         -- Interaction callbacks
 477         on_place = redef_wrapper(minetest, 'item_place'),
 478         on_drop = nil,
 479         on_use = nil,
 480 }
 481