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 script hook
 162                 local _, callback
 163                 for _, callback in ipairs(minetest.registered_on_placenodes) do
 164                         callback(pos, newnode, placer)
 165                 end
 166
 167                 itemstack:take_item()
 168         end
 169         return itemstack
 170 end
 171
 172 function minetest.item_place_object(itemstack, placer, pointed_thing)
 173         local pos = minetest.get_pointed_thing_position(pointed_thing, true)
 174         if pos ~= nil then
 175                 local item = itemstack:take_item()
 176                 minetest.env:add_item(pos, item)
 177         end
 178         return itemstack
 179 end
 180
 181 function minetest.item_place(itemstack, placer, pointed_thing)
 182         if itemstack:get_definition().type == "node" then
 183                 return minetest.item_place_node(itemstack, placer, pointed_thing)
 184         else
 185                 return minetest.item_place_object(itemstack, placer, pointed_thing)
 186         end
 187 end
 188
 189 function minetest.item_drop(itemstack, dropper, pos)
 190         if dropper.get_player_name then
 191                 local v = dropper:get_look_dir()
 192                 local p = {x=pos.x+v.x, y=pos.y+1.5+v.y, z=pos.z+v.z}
 193                 local obj = minetest.env:add_item(p, itemstack)
 194                 v.x = v.x*2
 195                 v.y = v.y*2 + 1
 196                 v.z = v.z*2
 197                 obj:setvelocity(v)
 198         else
 199                 minetest.env:add_item(pos, itemstack)
 200         end
 201         return ""
 202 end
 203
 204 function minetest.item_eat(hp_change, replace_with_item)
 205         return function(itemstack, user, pointed_thing)  -- closure
 206                 if itemstack:take_item() ~= nil then
 207                         user:set_hp(user:get_hp() + hp_change)
 208                         itemstack:add_item(replace_with_item) -- note: replace_with_item is optional
 209                 end
 210                 return itemstack
 211         end
 212 end
 213
 214 function minetest.node_punch(pos, node, puncher)
 215         -- Run script hook
 216         local _, callback
 217         for _, callback in ipairs(minetest.registered_on_punchnodes) do
 218                 callback(pos, node, puncher)
 219         end
 220
 221 end
 222
 223 function minetest.node_dig(pos, node, digger)
 224         minetest.debug("node_dig")
 225
 226         local def = ItemStack({name=node.name}):get_definition()
 227         if not def.diggable then
 228                 minetest.debug("not diggable")
 229                 minetest.log("info", digger:get_player_name() .. " tried to dig "
 230                         .. node.name .. " which is not diggable "
 231                         .. minetest.pos_to_string(pos))
 232                 return
 233         end
 234
 235         minetest.log('action', digger:get_player_name() .. " digs "
 236                 .. node.name .. " at " .. minetest.pos_to_string(pos))
 237
 238         if not minetest.setting_getbool("creative_mode") then
 239                 local wielded = digger:get_wielded_item()
 240                 local drops = minetest.get_node_drops(node.name, wielded:get_name())
 241
 242                 -- Wear out tool
 243                 tp = wielded:get_tool_capabilities()
 244                 dp = minetest.get_dig_params(def.groups, tp)
 245                 wielded:add_wear(dp.wear)
 246                 digger:set_wielded_item(wielded)
 247
 248                 -- Add dropped items
 249                 local _, dropped_item
 250                 for _, dropped_item in ipairs(drops) do
 251                         digger:get_inventory():add_item("main", dropped_item)
 252                 end
 253         end
 254
 255         -- Remove node and update
 256         minetest.env:remove_node(pos)
 257
 258         -- Run script hook
 259         local _, callback
 260         for _, callback in ipairs(minetest.registered_on_dignodes) do
 261                 callback(pos, node, digger)
 262         end
 263 end
 264
 265 function minetest.node_metadata_inventory_move_allow_all(pos, from_list,
 266                 from_index, to_list, to_index, count, player)
 267         minetest.log("verbose", "node_metadata_inventory_move_allow_all")
 268         local meta = minetest.env:get_meta(pos)
 269         local inv = meta:get_inventory()
 270
 271         local from_stack = inv:get_stack(from_list, from_index)
 272         local taken_items = from_stack:take_item(count)
 273         inv:set_stack(from_list, from_index, from_stack)
 274
 275         local to_stack = inv:get_stack(to_list, to_index)
 276         to_stack:add_item(taken_items)
 277         inv:set_stack(to_list, to_index, to_stack)
 278 end
 279
 280 function minetest.node_metadata_inventory_offer_allow_all(pos, listname, index, stack, player)
 281         minetest.log("verbose", "node_metadata_inventory_offer_allow_all")
 282         local meta = minetest.env:get_meta(pos)
 283         local inv = meta:get_inventory()
 284         local the_stack = inv:get_stack(listname, index)
 285         the_stack:add_item(stack)
 286         inv:set_stack(listname, index, the_stack)
 287         return ItemStack("")
 288 end
 289
 290 function minetest.node_metadata_inventory_take_allow_all(pos, listname, index, count, player)
 291         minetest.log("verbose", "node_metadata_inventory_take_allow_all")
 292         local meta = minetest.env:get_meta(pos)
 293         local inv = meta:get_inventory()
 294         local the_stack = inv:get_stack(listname, index)
 295         local taken_items = the_stack:take_item(count)
 296         inv:set_stack(listname, index, the_stack)
 297         return taken_items
 298 end
 299
 300 -- This is used to allow mods to redefine minetest.item_place and so on
 301 local function redef_wrapper(table, name)
 302         return function(...)
 303                 return table[name](...)
 304         end
 305 end
 306
 307 --
 308 -- Item definition defaults
 309 --
 310
 311 minetest.nodedef_default = {
 312         -- Item properties
 313         type="node",
 314         -- name intentionally not defined here
 315         description = "",
 316         groups = {},
 317         inventory_image = "",
 318         wield_image = "",
 319         wield_scale = {x=1,y=1,z=1},
 320         stack_max = 99,
 321         usable = false,
 322         liquids_pointable = false,
 323         tool_capabilities = nil,
 324
 325         -- Interaction callbacks
 326         on_place = redef_wrapper(minetest, 'item_place'), -- minetest.item_place
 327         on_drop = redef_wrapper(minetest, 'item_drop'), -- minetest.item_drop
 328         on_use = nil,
 329
 330         on_punch = redef_wrapper(minetest, 'node_punch'), -- minetest.node_punch
 331         on_dig = redef_wrapper(minetest, 'node_dig'), -- minetest.node_dig
 332
 333         on_receive_fields = nil,
 334
 335         on_metadata_inventory_move = minetest.node_metadata_inventory_move_allow_all,
 336         on_metadata_inventory_offer = minetest.node_metadata_inventory_offer_allow_all,
 337         on_metadata_inventory_take = minetest.node_metadata_inventory_take_allow_all,
 338
 339         -- Node properties
 340         drawtype = "normal",
 341         visual_scale = 1.0,
 342         tile_images = {""},
 343         special_materials = {
 344                 {image="", backface_culling=true},
 345                 {image="", backface_culling=true},
 346         },
 347         alpha = 255,
 348         post_effect_color = {a=0, r=0, g=0, b=0},
 349         paramtype = "none",
 350         paramtype2 = "none",
 351         is_ground_content = false,
 352         sunlight_propagates = false,
 353         walkable = true,
 354         pointable = true,
 355         diggable = true,
 356         climbable = false,
 357         buildable_to = false,
 358         liquidtype = "none",
 359         liquid_alternative_flowing = "",
 360         liquid_alternative_source = "",
 361         liquid_viscosity = 0,
 362         light_source = 0,
 363         damage_per_second = 0,
 364         selection_box = {type="regular"},
 365         legacy_facedir_simple = false,
 366         legacy_wallmounted = false,
 367 }
 368
 369 minetest.craftitemdef_default = {
 370         type="craft",
 371         -- name intentionally not defined here
 372         description = "",
 373         groups = {},
 374         inventory_image = "",
 375         wield_image = "",
 376         wield_scale = {x=1,y=1,z=1},
 377         stack_max = 99,
 378         liquids_pointable = false,
 379         tool_capabilities = nil,
 380
 381         -- Interaction callbacks
 382         on_place = redef_wrapper(minetest, 'item_place'), -- minetest.item_place
 383         on_drop = redef_wrapper(minetest, 'item_drop'), -- minetest.item_drop
 384         on_use = nil,
 385 }
 386
 387 minetest.tooldef_default = {
 388         type="tool",
 389         -- name intentionally not defined here
 390         description = "",
 391         groups = {},
 392         inventory_image = "",
 393         wield_image = "",
 394         wield_scale = {x=1,y=1,z=1},
 395         stack_max = 1,
 396         liquids_pointable = false,
 397         tool_capabilities = nil,
 398
 399         -- Interaction callbacks
 400         on_place = redef_wrapper(minetest, 'item_place'), -- minetest.item_place
 401         on_drop = redef_wrapper(minetest, 'item_drop'), -- minetest.item_drop
 402         on_use = nil,
 403 }
 404
 405 minetest.noneitemdef_default = {  -- This is used for the hand and unknown items
 406         type="none",
 407         -- name intentionally not defined here
 408         description = "",
 409         groups = {},
 410         inventory_image = "",
 411         wield_image = "",
 412         wield_scale = {x=1,y=1,z=1},
 413         stack_max = 99,
 414         liquids_pointable = false,
 415         tool_capabilities = nil,
 416
 417         -- Interaction callbacks
 418         on_place = nil,
 419         on_drop = nil,
 420         on_use = nil,
 421 }
 422