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                 -- Set metadata owner
 162                 if def.metadata_name ~= "" then
 163                         minetest.env:get_meta(pos):set_owner(placer:get_player_name())
 164                 end
 165
 166                 -- Run script hook
 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         minetest.env:add_item(pos, itemstack)
 196         return ""
 197 end
 198
 199 function minetest.item_eat(hp_change, replace_with_item)
 200         return function(itemstack, user, pointed_thing)  -- closure
 201                 if itemstack:take_item() ~= nil then
 202                         user:set_hp(user:get_hp() + hp_change)
 203                         itemstack:add_item(replace_with_item) -- note: replace_with_item is optional
 204                 end
 205                 return itemstack
 206         end
 207 end
 208
 209 function minetest.node_punch(pos, node, puncher)
 210         -- Run script hook
 211         local _, callback
 212         for _, callback in ipairs(minetest.registered_on_punchnodes) do
 213                 callback(pos, node, puncher)
 214         end
 215
 216 end
 217
 218 function minetest.node_dig(pos, node, digger)
 219         minetest.debug("node_dig")
 220
 221         local def = ItemStack({name=node.name}):get_definition()
 222         if not def.diggable then
 223                 minetest.debug("not diggable")
 224                 minetest.log("info", digger:get_player_name() .. " tried to dig "
 225                         .. node.name .. " which is not diggable "
 226                         .. minetest.pos_to_string(pos))
 227                 return
 228         end
 229
 230         local meta = minetest.env:get_meta(pos)
 231         if meta ~= nil and not meta:get_allow_removal() then
 232                 minetest.debug("dig prevented by metadata")
 233                 minetest.log("info", digger:get_player_name() .. " tried to dig "
 234                         .. node.name .. ", but removal is disabled by metadata "
 235                         .. minetest.pos_to_string(pos))
 236                 return
 237         end
 238
 239         minetest.log('action', digger:get_player_name() .. " digs "
 240                 .. node.name .. " at " .. minetest.pos_to_string(pos))
 241
 242         if not minetest.setting_getbool("creative_mode") then
 243                 local wielded = digger:get_wielded_item()
 244                 local drops = minetest.get_node_drops(node.name, wielded:get_name())
 245
 246                 -- Wear out tool
 247                 tp = wielded:get_tool_capabilities()
 248                 dp = minetest.get_dig_params(def.groups, tp)
 249                 wielded:add_wear(dp.wear)
 250                 digger:set_wielded_item(wielded)
 251
 252                 -- Add dropped items
 253                 local _, dropped_item
 254                 for _, dropped_item in ipairs(drops) do
 255                         digger:get_inventory():add_item("main", dropped_item)
 256                 end
 257         end
 258
 259         -- Remove node and update
 260         minetest.env:remove_node(pos)
 261
 262         -- Run script hook
 263         local _, callback
 264         for _, callback in ipairs(minetest.registered_on_dignodes) do
 265                 callback(pos, node, digger)
 266         end
 267 end
 268
 269 --
 270 -- Item definition defaults
 271 --
 272
 273 minetest.nodedef_default = {
 274         -- Item properties
 275         type="node",
 276         -- name intentionally not defined here
 277         description = "",
 278         groups = {},
 279         inventory_image = "",
 280         wield_image = "",
 281         wield_scale = {x=1,y=1,z=1},
 282         stack_max = 99,
 283         usable = false,
 284         liquids_pointable = false,
 285         tool_capabilities = nil,
 286
 287         -- Interaction callbacks
 288         on_place = minetest.item_place,
 289         on_drop = minetest.item_drop,
 290         on_use = nil,
 291
 292         on_punch = minetest.node_punch,
 293         on_dig = minetest.node_dig,
 294
 295         -- Node properties
 296         drawtype = "normal",
 297         visual_scale = 1.0,
 298         tile_images = {""},
 299         special_materials = {
 300                 {image="", backface_culling=true},
 301                 {image="", backface_culling=true},
 302         },
 303         alpha = 255,
 304         post_effect_color = {a=0, r=0, g=0, b=0},
 305         paramtype = "none",
 306         paramtype2 = "none",
 307         is_ground_content = false,
 308         sunlight_propagates = false,
 309         walkable = true,
 310         pointable = true,
 311         diggable = true,
 312         climbable = false,
 313         buildable_to = false,
 314         metadata_name = "",
 315         liquidtype = "none",
 316         liquid_alternative_flowing = "",
 317         liquid_alternative_source = "",
 318         liquid_viscosity = 0,
 319         light_source = 0,
 320         damage_per_second = 0,
 321         selection_box = {type="regular"},
 322         legacy_facedir_simple = false,
 323         legacy_wallmounted = false,
 324 }
 325
 326 minetest.craftitemdef_default = {
 327         type="craft",
 328         -- name intentionally not defined here
 329         description = "",
 330         groups = {},
 331         inventory_image = "",
 332         wield_image = "",
 333         wield_scale = {x=1,y=1,z=1},
 334         stack_max = 99,
 335         liquids_pointable = false,
 336         tool_capabilities = nil,
 337
 338         -- Interaction callbacks
 339         on_place = minetest.item_place,
 340         on_drop = minetest.item_drop,
 341         on_use = nil,
 342 }
 343
 344 minetest.tooldef_default = {
 345         type="tool",
 346         -- name intentionally not defined here
 347         description = "",
 348         groups = {},
 349         inventory_image = "",
 350         wield_image = "",
 351         wield_scale = {x=1,y=1,z=1},
 352         stack_max = 1,
 353         liquids_pointable = false,
 354         tool_capabilities = nil,
 355
 356         -- Interaction callbacks
 357         on_place = minetest.item_place,
 358         on_drop = minetest.item_drop,
 359         on_use = nil,
 360 }
 361
 362 minetest.noneitemdef_default = {  -- This is used for the hand and unknown items
 363         type="none",
 364         -- name intentionally not defined here
 365         description = "",
 366         groups = {},
 367         inventory_image = "",
 368         wield_image = "",
 369         wield_scale = {x=1,y=1,z=1},
 370         stack_max = 99,
 371         liquids_pointable = false,
 372         tool_capabilities = nil,
 373
 374         -- Interaction callbacks
 375         on_place = nil,
 376         on_drop = nil,
 377         on_use = nil,
 378 }
 379
 380