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 {ItemStack({name=nodename})}
  80         elseif type(drop) == "string" then
  81                 -- itemstring drop
  82                 return {ItemStack(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" 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()
 131
 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)
 136                         return
 137                 end
 138
 139                 minetest.log("action", placer:get_player_name() .. " places node "
 140                         .. def.name .. " at " .. minetest.pos_to_string(pos))
 141
 142                 local newnode = {name = def.name, param1 = 0, param2 = 0}
 143
 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)
 156                 end
 157
 158                 -- Add node and update
 159                 minetest.env:add_node(pos, newnode)
 160
 161                 -- Run callback
 162                 if def.after_place_node then
 163                         def.after_place_node(pos, placer)
 164                 end
 165
 166                 -- Run script hook (deprecated)
 167                 local _, callback
 168                 for _, callback in ipairs(minetest.registered_on_placenodes) do
 169                         callback(pos, newnode, placer)
 170                 end
 171
 172                 itemstack:take_item()
 173         end
 174         return itemstack
 175 end
 176
 177 function minetest.item_place_object(itemstack, placer, pointed_thing)
 178         local pos = minetest.get_pointed_thing_position(pointed_thing, true)
 179         if pos ~= nil then
 180                 local item = itemstack:take_item()
 181                 minetest.env:add_item(pos, item)
 182         end
 183         return itemstack
 184 end
 185
 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)
 189         else
 190                 return minetest.item_place_object(itemstack, placer, pointed_thing)
 191         end
 192 end
 193
 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)
 199                 v.x = v.x*2
 200                 v.y = v.y*2 + 1
 201                 v.z = v.z*2
 202                 obj:setvelocity(v)
 203         else
 204                 minetest.env:add_item(pos, itemstack)
 205         end
 206         return ""
 207 end
 208
 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
 214                 end
 215                 return itemstack
 216         end
 217 end
 218
 219 function minetest.node_punch(pos, node, puncher)
 220         -- Run script hook
 221         local _, callback
 222         for _, callback in ipairs(minetest.registered_on_punchnodes) do
 223                 callback(pos, node, puncher)
 224         end
 225
 226 end
 227
 228 function minetest.node_dig(pos, node, digger)
 229         minetest.debug("node_dig")
 230
 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))
 237                 return
 238         end
 239
 240         minetest.log('action', digger:get_player_name() .. " digs "
 241                 .. node.name .. " at " .. minetest.pos_to_string(pos))
 242
 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())
 246
 247                 -- Wear out tool
 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)
 252
 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)
 258                         end
 259                 end
 260         end
 261
 262         local oldnode = nil
 263         local oldmetadata = nil
 264         if def.after_dig_node then
 265                 oldnode = node;
 266                 oldmetadata = minetest.env:get_meta(pos):to_table()
 267         end
 268
 269         -- Remove node and update
 270         minetest.env:remove_node(pos)
 271
 272         -- Run callback
 273         if def.after_dig_node then
 274                 def.after_dig_node(pos, oldnode, oldmetadata, digger)
 275         end
 276
 277         -- Run script hook (deprecated)
 278         local _, callback
 279         for _, callback in ipairs(minetest.registered_on_dignodes) do
 280                 callback(pos, node, digger)
 281         end
 282 end
 283
 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()
 289
 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)
 293
 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)
 297 end
 298
 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)
 306         return ItemStack("")
 307 end
 308
 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)
 316         return taken_items
 317 end
 318
 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)
 323         return function(...)
 324                 return table[name](...)
 325         end
 326 end
 327
 328 --
 329 -- Item definition defaults
 330 --
 331
 332 minetest.nodedef_default = {
 333         -- Item properties
 334         type="node",
 335         -- name intentionally not defined here
 336         description = "",
 337         groups = {},
 338         inventory_image = "",
 339         wield_image = "",
 340         wield_scale = {x=1,y=1,z=1},
 341         stack_max = 99,
 342         usable = false,
 343         liquids_pointable = false,
 344         tool_capabilities = nil,
 345
 346         -- Interaction callbacks
 347         on_place = redef_wrapper(minetest, 'item_place'), -- minetest.item_place
 348         on_drop = redef_wrapper(minetest, 'item_drop'), -- minetest.item_drop
 349         on_use = nil,
 350         can_dig = nil,
 351
 352         on_punch = redef_wrapper(minetest, 'node_punch'), -- minetest.node_punch
 353         on_dig = redef_wrapper(minetest, 'node_dig'), -- minetest.node_dig
 354
 355         on_receive_fields = nil,
 356
 357         on_metadata_inventory_move = minetest.node_metadata_inventory_move_allow_all,
 358         on_metadata_inventory_offer = minetest.node_metadata_inventory_offer_allow_all,
 359         on_metadata_inventory_take = minetest.node_metadata_inventory_take_allow_all,
 360
 361         -- Node properties
 362         drawtype = "normal",
 363         visual_scale = 1.0,
 364         tile_images = {""},
 365         special_materials = {
 366                 {image="", backface_culling=true},
 367                 {image="", backface_culling=true},
 368         },
 369         alpha = 255,
 370         post_effect_color = {a=0, r=0, g=0, b=0},
 371         paramtype = "none",
 372         paramtype2 = "none",
 373         is_ground_content = false,
 374         sunlight_propagates = false,
 375         walkable = true,
 376         pointable = true,
 377         diggable = true,
 378         climbable = false,
 379         buildable_to = false,
 380         liquidtype = "none",
 381         liquid_alternative_flowing = "",
 382         liquid_alternative_source = "",
 383         liquid_viscosity = 0,
 384         light_source = 0,
 385         damage_per_second = 0,
 386         selection_box = {type="regular"},
 387         legacy_facedir_simple = false,
 388         legacy_wallmounted = false,
 389 }
 390
 391 minetest.craftitemdef_default = {
 392         type="craft",
 393         -- name intentionally not defined here
 394         description = "",
 395         groups = {},
 396         inventory_image = "",
 397         wield_image = "",
 398         wield_scale = {x=1,y=1,z=1},
 399         stack_max = 99,
 400         liquids_pointable = false,
 401         tool_capabilities = nil,
 402
 403         -- Interaction callbacks
 404         on_place = redef_wrapper(minetest, 'item_place'), -- minetest.item_place
 405         on_drop = redef_wrapper(minetest, 'item_drop'), -- minetest.item_drop
 406         on_use = nil,
 407 }
 408
 409 minetest.tooldef_default = {
 410         type="tool",
 411         -- name intentionally not defined here
 412         description = "",
 413         groups = {},
 414         inventory_image = "",
 415         wield_image = "",
 416         wield_scale = {x=1,y=1,z=1},
 417         stack_max = 1,
 418         liquids_pointable = false,
 419         tool_capabilities = nil,
 420
 421         -- Interaction callbacks
 422         on_place = redef_wrapper(minetest, 'item_place'), -- minetest.item_place
 423         on_drop = redef_wrapper(minetest, 'item_drop'), -- minetest.item_drop
 424         on_use = nil,
 425 }
 426
 427 minetest.noneitemdef_default = {  -- This is used for the hand and unknown items
 428         type="none",
 429         -- name intentionally not defined here
 430         description = "",
 431         groups = {},
 432         inventory_image = "",
 433         wield_image = "",
 434         wield_scale = {x=1,y=1,z=1},
 435         stack_max = 99,
 436         liquids_pointable = false,
 437         tool_capabilities = nil,
 438
 439         -- Interaction callbacks
 440         on_place = nil,
 441         on_drop = nil,
 442         on_use = nil,
 443 }
 444