builtin/game/item.lua

   1 -- Minetest: builtin/item.lua
   2
   3 local function copy_pointed_thing(pointed_thing)
   4         return {
   5                 type  = pointed_thing.type,
   6                 above = vector.new(pointed_thing.above),
   7                 under = vector.new(pointed_thing.under),
   8                 ref   = pointed_thing.ref,
   9         }
  10 end
  11
  12 --
  13 -- Item definition helpers
  14 --
  15
  16 function core.inventorycube(img1, img2, img3)
  17         img2 = img2 or img1
  18         img3 = img3 or img1
  19         return "[inventorycube"
  20                         .. "{" .. img1:gsub("%^", "&")
  21                         .. "{" .. img2:gsub("%^", "&")
  22                         .. "{" .. img3:gsub("%^", "&")
  23 end
  24
  25 function core.get_pointed_thing_position(pointed_thing, above)
  26         if pointed_thing.type == "node" then
  27                 if above then
  28                         -- The position where a node would be placed
  29                         return pointed_thing.above
  30                 end
  31                 -- The position where a node would be dug
  32                 return pointed_thing.under
  33         elseif pointed_thing.type == "object" then
  34                 return pointed_thing.ref and pointed_thing.ref:getpos()
  35         end
  36 end
  37
  38 function core.dir_to_facedir(dir, is6d)
  39         --account for y if requested
  40         if is6d and math.abs(dir.y) > math.abs(dir.x) and math.abs(dir.y) > math.abs(dir.z) then
  41
  42                 --from above
  43                 if dir.y < 0 then
  44                         if math.abs(dir.x) > math.abs(dir.z) then
  45                                 if dir.x < 0 then
  46                                         return 19
  47                                 else
  48                                         return 13
  49                                 end
  50                         else
  51                                 if dir.z < 0 then
  52                                         return 10
  53                                 else
  54                                         return 4
  55                                 end
  56                         end
  57
  58                 --from below
  59                 else
  60                         if math.abs(dir.x) > math.abs(dir.z) then
  61                                 if dir.x < 0 then
  62                                         return 15
  63                                 else
  64                                         return 17
  65                                 end
  66                         else
  67                                 if dir.z < 0 then
  68                                         return 6
  69                                 else
  70                                         return 8
  71                                 end
  72                         end
  73                 end
  74
  75         --otherwise, place horizontally
  76         elseif math.abs(dir.x) > math.abs(dir.z) then
  77                 if dir.x < 0 then
  78                         return 3
  79                 else
  80                         return 1
  81                 end
  82         else
  83                 if dir.z < 0 then
  84                         return 2
  85                 else
  86                         return 0
  87                 end
  88         end
  89 end
  90
  91 -- Table of possible dirs
  92 local facedir_to_dir = {
  93         {x= 0, y=0,  z= 1},
  94         {x= 1, y=0,  z= 0},
  95         {x= 0, y=0,  z=-1},
  96         {x=-1, y=0,  z= 0},
  97         {x= 0, y=-1, z= 0},
  98         {x= 0, y=1,  z= 0},
  99 }
 100 -- Mapping from facedir value to index in facedir_to_dir.
 101 local facedir_to_dir_map = {
 102         [0]=1, 2, 3, 4,
 103         5, 2, 6, 4,
 104         6, 2, 5, 4,
 105         1, 5, 3, 6,
 106         1, 6, 3, 5,
 107         1, 4, 3, 2,
 108 }
 109 function core.facedir_to_dir(facedir)
 110         return facedir_to_dir[facedir_to_dir_map[facedir]]
 111 end
 112
 113 function core.dir_to_wallmounted(dir)
 114         if math.abs(dir.y) > math.max(math.abs(dir.x), math.abs(dir.z)) then
 115                 if dir.y < 0 then
 116                         return 1
 117                 else
 118                         return 0
 119                 end
 120         elseif math.abs(dir.x) > math.abs(dir.z) then
 121                 if dir.x < 0 then
 122                         return 3
 123                 else
 124                         return 2
 125                 end
 126         else
 127                 if dir.z < 0 then
 128                         return 5
 129                 else
 130                         return 4
 131                 end
 132         end
 133 end
 134
 135 -- table of dirs in wallmounted order
 136 local wallmounted_to_dir = {
 137         [0] = {x = 0, y = 1, z = 0},
 138         {x =  0, y = -1, z =  0},
 139         {x =  1, y =  0, z =  0},
 140         {x = -1, y =  0, z =  0},
 141         {x =  0, y =  0, z =  1},
 142         {x =  0, y =  0, z = -1},
 143 }
 144 function core.wallmounted_to_dir(wallmounted)
 145         return wallmounted_to_dir[wallmounted]
 146 end
 147
 148 function core.get_node_drops(nodename, toolname)
 149         local drop = ItemStack({name=nodename}):get_definition().drop
 150         if drop == nil then
 151                 -- default drop
 152                 return {nodename}
 153         elseif type(drop) == "string" then
 154                 -- itemstring drop
 155                 return {drop}
 156         elseif drop.items == nil then
 157                 -- drop = {} to disable default drop
 158                 return {}
 159         end
 160
 161         -- Extended drop table
 162         local got_items = {}
 163         local got_count = 0
 164         local _, item, tool
 165         for _, item in ipairs(drop.items) do
 166                 local good_rarity = true
 167                 local good_tool = true
 168                 if item.rarity ~= nil then
 169                         good_rarity = item.rarity < 1 or math.random(item.rarity) == 1
 170                 end
 171                 if item.tools ~= nil then
 172                         good_tool = false
 173                         for _, tool in ipairs(item.tools) do
 174                                 if tool:sub(1, 1) == '~' then
 175                                         good_tool = toolname:find(tool:sub(2)) ~= nil
 176                                 else
 177                                         good_tool = toolname == tool
 178                                 end
 179                                 if good_tool then
 180                                         break
 181                                 end
 182                         end
 183                 end
 184                 if good_rarity and good_tool then
 185                         got_count = got_count + 1
 186                         for _, add_item in ipairs(item.items) do
 187                                 got_items[#got_items+1] = add_item
 188                         end
 189                         if drop.max_items ~= nil and got_count == drop.max_items then
 190                                 break
 191                         end
 192                 end
 193         end
 194         return got_items
 195 end
 196
 197 function core.item_place_node(itemstack, placer, pointed_thing, param2)
 198         local item = itemstack:peek_item()
 199         local def = itemstack:get_definition()
 200         if def.type ~= "node" or pointed_thing.type ~= "node" then
 201                 return itemstack, false
 202         end
 203
 204         local under = pointed_thing.under
 205         local oldnode_under = core.get_node_or_nil(under)
 206         local above = pointed_thing.above
 207         local oldnode_above = core.get_node_or_nil(above)
 208
 209         if not oldnode_under or not oldnode_above then
 210                 core.log("info", placer:get_player_name() .. " tried to place"
 211                         .. " node in unloaded position " .. core.pos_to_string(above))
 212                 return itemstack, false
 213         end
 214
 215         local olddef_under = ItemStack({name=oldnode_under.name}):get_definition()
 216         olddef_under = olddef_under or core.nodedef_default
 217         local olddef_above = ItemStack({name=oldnode_above.name}):get_definition()
 218         olddef_above = olddef_above or core.nodedef_default
 219
 220         if not olddef_above.buildable_to and not olddef_under.buildable_to then
 221                 core.log("info", placer:get_player_name() .. " tried to place"
 222                         .. " node in invalid position " .. core.pos_to_string(above)
 223                         .. ", replacing " .. oldnode_above.name)
 224                 return itemstack, false
 225         end
 226
 227         -- Place above pointed node
 228         local place_to = {x = above.x, y = above.y, z = above.z}
 229
 230         -- If node under is buildable_to, place into it instead (eg. snow)
 231         if olddef_under.buildable_to then
 232                 core.log("info", "node under is buildable to")
 233                 place_to = {x = under.x, y = under.y, z = under.z}
 234         end
 235
 236         if core.is_protected(place_to, placer:get_player_name()) then
 237                 core.log("action", placer:get_player_name()
 238                                 .. " tried to place " .. def.name
 239                                 .. " at protected position "
 240                                 .. core.pos_to_string(place_to))
 241                 core.record_protection_violation(place_to, placer:get_player_name())
 242                 return itemstack
 243         end
 244
 245         core.log("action", placer:get_player_name() .. " places node "
 246                 .. def.name .. " at " .. core.pos_to_string(place_to))
 247
 248         local oldnode = core.get_node(place_to)
 249         local newnode = {name = def.name, param1 = 0, param2 = param2}
 250
 251         -- Calculate direction for wall mounted stuff like torches and signs
 252         if def.paramtype2 == 'wallmounted' and not param2 then
 253                 local dir = {
 254                         x = under.x - above.x,
 255                         y = under.y - above.y,
 256                         z = under.z - above.z
 257                 }
 258                 newnode.param2 = core.dir_to_wallmounted(dir)
 259         -- Calculate the direction for furnaces and chests and stuff
 260         elseif def.paramtype2 == 'facedir' and not param2 then
 261                 local placer_pos = placer:getpos()
 262                 if placer_pos then
 263                         local dir = {
 264                                 x = above.x - placer_pos.x,
 265                                 y = above.y - placer_pos.y,
 266                                 z = above.z - placer_pos.z
 267                         }
 268                         newnode.param2 = core.dir_to_facedir(dir)
 269                         core.log("action", "facedir: " .. newnode.param2)
 270                 end
 271         end
 272
 273         -- Check if the node is attached and if it can be placed there
 274         if core.get_item_group(def.name, "attached_node") ~= 0 and
 275                 not check_attached_node(place_to, newnode) then
 276                 core.log("action", "attached node " .. def.name ..
 277                         " can not be placed at " .. core.pos_to_string(place_to))
 278                 return itemstack, false
 279         end
 280
 281         -- Add node and update
 282         core.add_node(place_to, newnode)
 283
 284         local take_item = true
 285
 286         -- Run callback
 287         if def.after_place_node then
 288                 -- Deepcopy place_to and pointed_thing because callback can modify it
 289                 local place_to_copy = {x=place_to.x, y=place_to.y, z=place_to.z}
 290                 local pointed_thing_copy = copy_pointed_thing(pointed_thing)
 291                 if def.after_place_node(place_to_copy, placer, itemstack,
 292                                 pointed_thing_copy) then
 293                         take_item = false
 294                 end
 295         end
 296
 297         -- Run script hook
 298         local _, callback
 299         for _, callback in ipairs(core.registered_on_placenodes) do
 300                 -- Deepcopy pos, node and pointed_thing because callback can modify them
 301                 local place_to_copy = {x=place_to.x, y=place_to.y, z=place_to.z}
 302                 local newnode_copy = {name=newnode.name, param1=newnode.param1, param2=newnode.param2}
 303                 local oldnode_copy = {name=oldnode.name, param1=oldnode.param1, param2=oldnode.param2}
 304                 local pointed_thing_copy = copy_pointed_thing(pointed_thing)
 305                 if callback(place_to_copy, newnode_copy, placer, oldnode_copy, itemstack, pointed_thing_copy) then
 306                         take_item = false
 307                 end
 308         end
 309
 310         if take_item then
 311                 itemstack:take_item()
 312         end
 313         return itemstack, true
 314 end
 315
 316 function core.item_place_object(itemstack, placer, pointed_thing)
 317         local pos = core.get_pointed_thing_position(pointed_thing, true)
 318         if pos ~= nil then
 319                 local item = itemstack:take_item()
 320                 core.add_item(pos, item)
 321         end
 322         return itemstack
 323 end
 324
 325 function core.item_place(itemstack, placer, pointed_thing, param2)
 326         -- Call on_rightclick if the pointed node defines it
 327         if pointed_thing.type == "node" and placer and
 328                         not placer:get_player_control().sneak then
 329                 local n = core.get_node(pointed_thing.under)
 330                 local nn = n.name
 331                 if core.registered_nodes[nn] and core.registered_nodes[nn].on_rightclick then
 332                         return core.registered_nodes[nn].on_rightclick(pointed_thing.under, n,
 333                                         placer, itemstack, pointed_thing) or itemstack, false
 334                 end
 335         end
 336
 337         if itemstack:get_definition().type == "node" then
 338                 return core.item_place_node(itemstack, placer, pointed_thing, param2)
 339         end
 340         return itemstack
 341 end
 342
 343 function core.item_secondary_use(itemstack, placer)
 344         return itemstack
 345 end
 346
 347 function core.item_drop(itemstack, dropper, pos)
 348         if dropper and dropper:is_player() then
 349                 local v = dropper:get_look_dir()
 350                 local p = {x=pos.x, y=pos.y+1.2, z=pos.z}
 351                 local cs = itemstack:get_count()
 352                 if dropper:get_player_control().sneak then
 353                         cs = 1
 354                 end
 355                 local item = itemstack:take_item(cs)
 356                 local obj = core.add_item(p, item)
 357                 if obj then
 358                         v.x = v.x*2
 359                         v.y = v.y*2 + 2
 360                         v.z = v.z*2
 361                         obj:setvelocity(v)
 362                         obj:get_luaentity().dropped_by = dropper:get_player_name()
 363                         return itemstack
 364                 end
 365
 366         else
 367                 if core.add_item(pos, itemstack) then
 368                         return itemstack
 369                 end
 370         end
 371         -- If we reach this, adding the object to the
 372         -- environment failed
 373 end
 374
 375 function core.do_item_eat(hp_change, replace_with_item, itemstack, user, pointed_thing)
 376         for _, callback in pairs(core.registered_on_item_eats) do
 377                 local result = callback(hp_change, replace_with_item, itemstack, user, pointed_thing)
 378                 if result then
 379                         return result
 380                 end
 381         end
 382         if itemstack:take_item() ~= nil then
 383                 user:set_hp(user:get_hp() + hp_change)
 384
 385                 if replace_with_item then
 386                         if itemstack:is_empty() then
 387                                 itemstack:add_item(replace_with_item)
 388                         else
 389                                 local inv = user:get_inventory()
 390                                 if inv:room_for_item("main", {name=replace_with_item}) then
 391                                         inv:add_item("main", replace_with_item)
 392                                 else
 393                                         local pos = user:getpos()
 394                                         pos.y = math.floor(pos.y + 0.5)
 395                                         core.add_item(pos, replace_with_item)
 396                                 end
 397                         end
 398                 end
 399         end
 400         return itemstack
 401 end
 402
 403 function core.item_eat(hp_change, replace_with_item)
 404         return function(itemstack, user, pointed_thing)  -- closure
 405                 return core.do_item_eat(hp_change, replace_with_item, itemstack, user, pointed_thing)
 406         end
 407 end
 408
 409 function core.node_punch(pos, node, puncher, pointed_thing)
 410         -- Run script hook
 411         for _, callback in ipairs(core.registered_on_punchnodes) do
 412                 -- Copy pos and node because callback can modify them
 413                 local pos_copy = vector.new(pos)
 414                 local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
 415                 local pointed_thing_copy = pointed_thing and copy_pointed_thing(pointed_thing) or nil
 416                 callback(pos_copy, node_copy, puncher, pointed_thing_copy)
 417         end
 418 end
 419
 420 function core.handle_node_drops(pos, drops, digger)
 421         -- Add dropped items to object's inventory
 422         if digger:get_inventory() then
 423                 local _, dropped_item
 424                 for _, dropped_item in ipairs(drops) do
 425                         local left = digger:get_inventory():add_item("main", dropped_item)
 426                         if not left:is_empty() then
 427                                 local p = {
 428                                         x = pos.x + math.random()/2-0.25,
 429                                         y = pos.y + math.random()/2-0.25,
 430                                         z = pos.z + math.random()/2-0.25,
 431                                 }
 432                                 core.add_item(p, left)
 433                         end
 434                 end
 435         end
 436 end
 437
 438 function core.node_dig(pos, node, digger)
 439         local def = ItemStack({name=node.name}):get_definition()
 440         if not def.diggable or (def.can_dig and not def.can_dig(pos,digger)) then
 441                 core.log("info", digger:get_player_name() .. " tried to dig "
 442                         .. node.name .. " which is not diggable "
 443                         .. core.pos_to_string(pos))
 444                 return
 445         end
 446
 447         if core.is_protected(pos, digger:get_player_name()) then
 448                 core.log("action", digger:get_player_name()
 449                                 .. " tried to dig " .. node.name
 450                                 .. " at protected position "
 451                                 .. core.pos_to_string(pos))
 452                 core.record_protection_violation(pos, digger:get_player_name())
 453                 return
 454         end
 455
 456         core.log('action', digger:get_player_name() .. " digs "
 457                 .. node.name .. " at " .. core.pos_to_string(pos))
 458
 459         local wielded = digger:get_wielded_item()
 460         local drops = core.get_node_drops(node.name, wielded:get_name())
 461
 462         local wdef = wielded:get_definition()
 463         local tp = wielded:get_tool_capabilities()
 464         local dp = core.get_dig_params(def.groups, tp)
 465         if wdef and wdef.after_use then
 466                 wielded = wdef.after_use(wielded, digger, node, dp) or wielded
 467         else
 468                 -- Wear out tool
 469                 if not core.setting_getbool("creative_mode") then
 470                         wielded:add_wear(dp.wear)
 471                 end
 472         end
 473         digger:set_wielded_item(wielded)
 474
 475         -- Handle drops
 476         core.handle_node_drops(pos, drops, digger)
 477
 478         local oldmetadata = nil
 479         if def.after_dig_node then
 480                 oldmetadata = core.get_meta(pos):to_table()
 481         end
 482
 483         -- Remove node and update
 484         core.remove_node(pos)
 485
 486         -- Run callback
 487         if def.after_dig_node then
 488                 -- Copy pos and node because callback can modify them
 489                 local pos_copy = {x=pos.x, y=pos.y, z=pos.z}
 490                 local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
 491                 def.after_dig_node(pos_copy, node_copy, oldmetadata, digger)
 492         end
 493
 494         -- Run script hook
 495         local _, callback
 496         for _, callback in ipairs(core.registered_on_dignodes) do
 497                 local origin = core.callback_origins[callback]
 498                 if origin then
 499                         core.set_last_run_mod(origin.mod)
 500                         --print("Running " .. tostring(callback) ..
 501                         --      " (a " .. origin.name .. " callback in " .. origin.mod .. ")")
 502                 else
 503                         --print("No data associated with callback")
 504                 end
 505
 506                 -- Copy pos and node because callback can modify them
 507                 local pos_copy = {x=pos.x, y=pos.y, z=pos.z}
 508                 local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
 509                 callback(pos_copy, node_copy, digger)
 510         end
 511 end
 512
 513 -- This is used to allow mods to redefine core.item_place and so on
 514 -- NOTE: This is not the preferred way. Preferred way is to provide enough
 515 --       callbacks to not require redefining global functions. -celeron55
 516 local function redef_wrapper(table, name)
 517         return function(...)
 518                 return table[name](...)
 519         end
 520 end
 521
 522 --
 523 -- Item definition defaults
 524 --
 525
 526 core.nodedef_default = {
 527         -- Item properties
 528         type="node",
 529         -- name intentionally not defined here
 530         description = "",
 531         groups = {},
 532         inventory_image = "",
 533         wield_image = "",
 534         wield_scale = {x=1,y=1,z=1},
 535         stack_max = 99,
 536         usable = false,
 537         liquids_pointable = false,
 538         tool_capabilities = nil,
 539         node_placement_prediction = nil,
 540
 541         -- Interaction callbacks
 542         on_place = redef_wrapper(core, 'item_place'), -- core.item_place
 543         on_drop = redef_wrapper(core, 'item_drop'), -- core.item_drop
 544         on_use = nil,
 545         can_dig = nil,
 546
 547         on_punch = redef_wrapper(core, 'node_punch'), -- core.node_punch
 548         on_rightclick = nil,
 549         on_dig = redef_wrapper(core, 'node_dig'), -- core.node_dig
 550
 551         on_receive_fields = nil,
 552
 553         on_metadata_inventory_move = core.node_metadata_inventory_move_allow_all,
 554         on_metadata_inventory_offer = core.node_metadata_inventory_offer_allow_all,
 555         on_metadata_inventory_take = core.node_metadata_inventory_take_allow_all,
 556
 557         -- Node properties
 558         drawtype = "normal",
 559         visual_scale = 1.0,
 560         -- Don't define these because otherwise the old tile_images and
 561         -- special_materials wouldn't be read
 562         --tiles ={""},
 563         --special_tiles = {
 564         --      {name="", backface_culling=true},
 565         --      {name="", backface_culling=true},
 566         --},
 567         alpha = 255,
 568         post_effect_color = {a=0, r=0, g=0, b=0},
 569         paramtype = "none",
 570         paramtype2 = "none",
 571         is_ground_content = true,
 572         sunlight_propagates = false,
 573         walkable = true,
 574         pointable = true,
 575         diggable = true,
 576         climbable = false,
 577         buildable_to = false,
 578         floodable = false,
 579         liquidtype = "none",
 580         liquid_alternative_flowing = "",
 581         liquid_alternative_source = "",
 582         liquid_viscosity = 0,
 583         drowning = 0,
 584         light_source = 0,
 585         damage_per_second = 0,
 586         selection_box = {type="regular"},
 587         legacy_facedir_simple = false,
 588         legacy_wallmounted = false,
 589 }
 590
 591 core.craftitemdef_default = {
 592         type="craft",
 593         -- name intentionally not defined here
 594         description = "",
 595         groups = {},
 596         inventory_image = "",
 597         wield_image = "",
 598         wield_scale = {x=1,y=1,z=1},
 599         stack_max = 99,
 600         liquids_pointable = false,
 601         tool_capabilities = nil,
 602
 603         -- Interaction callbacks
 604         on_place = redef_wrapper(core, 'item_place'), -- core.item_place
 605         on_drop = redef_wrapper(core, 'item_drop'), -- core.item_drop
 606         on_secondary_use = redef_wrapper(core, 'item_secondary_use'),
 607         on_use = nil,
 608 }
 609
 610 core.tooldef_default = {
 611         type="tool",
 612         -- name intentionally not defined here
 613         description = "",
 614         groups = {},
 615         inventory_image = "",
 616         wield_image = "",
 617         wield_scale = {x=1,y=1,z=1},
 618         stack_max = 1,
 619         liquids_pointable = false,
 620         tool_capabilities = nil,
 621
 622         -- Interaction callbacks
 623         on_place = redef_wrapper(core, 'item_place'), -- core.item_place
 624         on_secondary_use = redef_wrapper(core, 'item_secondary_use'),
 625         on_drop = redef_wrapper(core, 'item_drop'), -- core.item_drop
 626         on_use = nil,
 627 }
 628
 629 core.noneitemdef_default = {  -- This is used for the hand and unknown items
 630         type="none",
 631         -- name intentionally not defined here
 632         description = "",
 633         groups = {},
 634         inventory_image = "",
 635         wield_image = "",
 636         wield_scale = {x=1,y=1,z=1},
 637         stack_max = 99,
 638         liquids_pointable = false,
 639         tool_capabilities = nil,
 640
 641         -- Interaction callbacks
 642         on_place = redef_wrapper(core, 'item_place'),
 643         on_secondary_use = redef_wrapper(core, 'item_secondary_use'),
 644         on_drop = nil,
 645         on_use = nil,
 646 }