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
 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
 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                         minetest.registered_nodes[nn].on_rightclick(pointed_thing.under, n, placer)
 241                         return
 242                 end
 243         end
 244
 245         if itemstack:get_definition().type == "node" then
 246                 return minetest.item_place_node(itemstack, placer, pointed_thing)
 247         elseif itemstack:get_definition().type ~= "none" then
 248                 return minetest.item_place_object(itemstack, placer, pointed_thing)
 249         end
 250 end
 251
 252 function minetest.item_drop(itemstack, dropper, pos)
 253         if dropper.get_player_name then
 254                 local v = dropper:get_look_dir()
 255                 local p = {x=pos.x+v.x, y=pos.y+1.5+v.y, z=pos.z+v.z}
 256                 local obj = minetest.env:add_item(p, itemstack)
 257                 if obj then
 258                         v.x = v.x*2
 259                         v.y = v.y*2 + 1
 260                         v.z = v.z*2
 261                         obj:setvelocity(v)
 262                 end
 263         else
 264                 minetest.env:add_item(pos, itemstack)
 265         end
 266         return ""
 267 end
 268
 269 function minetest.item_eat(hp_change, replace_with_item)
 270         return function(itemstack, user, pointed_thing)  -- closure
 271                 if itemstack:take_item() ~= nil then
 272                         user:set_hp(user:get_hp() + hp_change)
 273                         itemstack:add_item(replace_with_item) -- note: replace_with_item is optional
 274                 end
 275                 return itemstack
 276         end
 277 end
 278
 279 function minetest.node_punch(pos, node, puncher)
 280         -- Run script hook
 281         local _, callback
 282         for _, callback in ipairs(minetest.registered_on_punchnodes) do
 283                 -- Copy pos and node because callback can modify them
 284                 local pos_copy = {x=pos.x, y=pos.y, z=pos.z}
 285                 local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
 286                 callback(pos_copy, node_copy, puncher)
 287         end
 288 end
 289
 290 function minetest.handle_node_drops(pos, drops, digger)
 291         -- Add dropped items to object's inventory
 292         if digger:get_inventory() then
 293                 local _, dropped_item
 294                 for _, dropped_item in ipairs(drops) do
 295                         digger:get_inventory():add_item("main", dropped_item)
 296                 end
 297         end
 298 end
 299
 300 function minetest.node_dig(pos, node, digger)
 301         minetest.debug("node_dig")
 302
 303         local def = ItemStack({name=node.name}):get_definition()
 304         -- Check if def ~= 0 because we always want to be able to remove unknown nodes
 305         if #def ~= 0 and not def.diggable or (def.can_dig and not def.can_dig(pos,digger)) then
 306                 minetest.debug("not diggable")
 307                 minetest.log("info", digger:get_player_name() .. " tried to dig "
 308                         .. node.name .. " which is not diggable "
 309                         .. minetest.pos_to_string(pos))
 310                 return
 311         end
 312
 313         minetest.log('action', digger:get_player_name() .. " digs "
 314                 .. node.name .. " at " .. minetest.pos_to_string(pos))
 315
 316         local wielded = digger:get_wielded_item()
 317         local drops = minetest.get_node_drops(node.name, wielded:get_name())
 318
 319         -- Wear out tool
 320         local tp = wielded:get_tool_capabilities()
 321         local dp = minetest.get_dig_params(def.groups, tp)
 322         wielded:add_wear(dp.wear)
 323         digger:set_wielded_item(wielded)
 324
 325         -- Handle drops
 326         minetest.handle_node_drops(pos, drops, digger)
 327
 328         local oldmetadata = nil
 329         if def.after_dig_node then
 330                 oldmetadata = minetest.env:get_meta(pos):to_table()
 331         end
 332
 333         -- Remove node and update
 334         minetest.env:remove_node(pos)
 335
 336         -- Run callback
 337         if def.after_dig_node then
 338                 -- Copy pos and node because callback can modify them
 339                 local pos_copy = {x=pos.x, y=pos.y, z=pos.z}
 340                 local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
 341                 def.after_dig_node(pos_copy, node_copy, oldmetadata, digger)
 342         end
 343
 344         -- Run script hook
 345         local _, callback
 346         for _, callback in ipairs(minetest.registered_on_dignodes) do
 347                 -- Copy pos and node because callback can modify them
 348                 local pos_copy = {x=pos.x, y=pos.y, z=pos.z}
 349                 local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
 350                 callback(pos_copy, node_copy, digger)
 351         end
 352 end
 353
 354 -- This is used to allow mods to redefine minetest.item_place and so on
 355 -- NOTE: This is not the preferred way. Preferred way is to provide enough
 356 --       callbacks to not require redefining global functions. -celeron55
 357 local function redef_wrapper(table, name)
 358         return function(...)
 359                 return table[name](...)
 360         end
 361 end
 362
 363 --
 364 -- Item definition defaults
 365 --
 366
 367 minetest.nodedef_default = {
 368         -- Item properties
 369         type="node",
 370         -- name intentionally not defined here
 371         description = "",
 372         groups = {},
 373         inventory_image = "",
 374         wield_image = "",
 375         wield_scale = {x=1,y=1,z=1},
 376         stack_max = 99,
 377         usable = false,
 378         liquids_pointable = false,
 379         tool_capabilities = nil,
 380         node_placement_prediction = nil,
 381
 382         -- Interaction callbacks
 383         on_place = redef_wrapper(minetest, 'item_place'), -- minetest.item_place
 384         on_drop = redef_wrapper(minetest, 'item_drop'), -- minetest.item_drop
 385         on_use = nil,
 386         can_dig = nil,
 387
 388         on_punch = redef_wrapper(minetest, 'node_punch'), -- minetest.node_punch
 389         on_rightclick = nil,
 390         on_dig = redef_wrapper(minetest, 'node_dig'), -- minetest.node_dig
 391
 392         on_receive_fields = nil,
 393
 394         on_metadata_inventory_move = minetest.node_metadata_inventory_move_allow_all,
 395         on_metadata_inventory_offer = minetest.node_metadata_inventory_offer_allow_all,
 396         on_metadata_inventory_take = minetest.node_metadata_inventory_take_allow_all,
 397
 398         -- Node properties
 399         drawtype = "normal",
 400         visual_scale = 1.0,
 401         -- Don't define these because otherwise the old tile_images and
 402         -- special_materials wouldn't be read
 403         --tiles ={""},
 404         --special_tiles = {
 405         --      {name="", backface_culling=true},
 406         --      {name="", backface_culling=true},
 407         --},
 408         alpha = 255,
 409         post_effect_color = {a=0, r=0, g=0, b=0},
 410         paramtype = "none",
 411         paramtype2 = "none",
 412         is_ground_content = false,
 413         sunlight_propagates = false,
 414         walkable = true,
 415         pointable = true,
 416         diggable = true,
 417         climbable = false,
 418         buildable_to = false,
 419         liquidtype = "none",
 420         liquid_alternative_flowing = "",
 421         liquid_alternative_source = "",
 422         liquid_viscosity = 0,
 423         light_source = 0,
 424         damage_per_second = 0,
 425         selection_box = {type="regular"},
 426         legacy_facedir_simple = false,
 427         legacy_wallmounted = false,
 428 }
 429
 430 minetest.craftitemdef_default = {
 431         type="craft",
 432         -- name intentionally not defined here
 433         description = "",
 434         groups = {},
 435         inventory_image = "",
 436         wield_image = "",
 437         wield_scale = {x=1,y=1,z=1},
 438         stack_max = 99,
 439         liquids_pointable = false,
 440         tool_capabilities = nil,
 441
 442         -- Interaction callbacks
 443         on_place = redef_wrapper(minetest, 'item_place'), -- minetest.item_place
 444         on_drop = redef_wrapper(minetest, 'item_drop'), -- minetest.item_drop
 445         on_use = nil,
 446 }
 447
 448 minetest.tooldef_default = {
 449         type="tool",
 450         -- name intentionally not defined here
 451         description = "",
 452         groups = {},
 453         inventory_image = "",
 454         wield_image = "",
 455         wield_scale = {x=1,y=1,z=1},
 456         stack_max = 1,
 457         liquids_pointable = false,
 458         tool_capabilities = nil,
 459
 460         -- Interaction callbacks
 461         on_place = redef_wrapper(minetest, 'item_place'), -- minetest.item_place
 462         on_drop = redef_wrapper(minetest, 'item_drop'), -- minetest.item_drop
 463         on_use = nil,
 464 }
 465
 466 minetest.noneitemdef_default = {  -- This is used for the hand and unknown items
 467         type="none",
 468         -- name intentionally not defined here
 469         description = "",
 470         groups = {},
 471         inventory_image = "",
 472         wield_image = "",
 473         wield_scale = {x=1,y=1,z=1},
 474         stack_max = 99,
 475         liquids_pointable = false,
 476         tool_capabilities = nil,
 477
 478         -- Interaction callbacks
 479         on_place = redef_wrapper(minetest, 'item_place'),
 480         on_drop = nil,
 481         on_use = nil,
 482 }
 483