123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589 |
- -- Minetest: builtin/item.lua
- local function copy_pointed_thing(pointed_thing)
- return {
- type = pointed_thing.type,
- above = vector.new(pointed_thing.above),
- under = vector.new(pointed_thing.under),
- ref = pointed_thing.ref,
- }
- end
- --
- -- Item definition helpers
- --
- function core.inventorycube(img1, img2, img3)
- img2 = img2 or img1
- img3 = img3 or img1
- return "[inventorycube"
- .. "{" .. img1:gsub("%^", "&")
- .. "{" .. img2:gsub("%^", "&")
- .. "{" .. img3:gsub("%^", "&")
- end
- function core.get_pointed_thing_position(pointed_thing, above)
- if pointed_thing.type == "node" then
- if above then
- -- The position where a node would be placed
- return pointed_thing.above
- else
- -- The position where a node would be dug
- return pointed_thing.under
- end
- elseif pointed_thing.type == "object" then
- obj = pointed_thing.ref
- if obj ~= nil then
- return obj:getpos()
- else
- return nil
- end
- else
- return nil
- end
- end
- function core.dir_to_facedir(dir, is6d)
- --account for y if requested
- if is6d and math.abs(dir.y) > math.abs(dir.x) and math.abs(dir.y) > math.abs(dir.z) then
- --from above
- if dir.y < 0 then
- if math.abs(dir.x) > math.abs(dir.z) then
- if dir.x < 0 then
- return 19
- else
- return 13
- end
- else
- if dir.z < 0 then
- return 10
- else
- return 4
- end
- end
- --from below
- else
- if math.abs(dir.x) > math.abs(dir.z) then
- if dir.x < 0 then
- return 15
- else
- return 17
- end
- else
- if dir.z < 0 then
- return 6
- else
- return 8
- end
- end
- end
- --otherwise, place horizontally
- elseif math.abs(dir.x) > math.abs(dir.z) then
- if dir.x < 0 then
- return 3
- else
- return 1
- end
- else
- if dir.z < 0 then
- return 2
- else
- return 0
- end
- end
- end
- function core.facedir_to_dir(facedir)
- --a table of possible dirs
- return ({{x=0, y=0, z=1},
- {x=1, y=0, z=0},
- {x=0, y=0, z=-1},
- {x=-1, y=0, z=0},
- {x=0, y=-1, z=0},
- {x=0, y=1, z=0}})
- --indexed into by a table of correlating facedirs
- [({[0]=1, 2, 3, 4,
- 5, 2, 6, 4,
- 6, 2, 5, 4,
- 1, 5, 3, 6,
- 1, 6, 3, 5,
- 1, 4, 3, 2})
- --indexed into by the facedir in question
- [facedir]]
- end
- function core.dir_to_wallmounted(dir)
- if math.abs(dir.y) > math.max(math.abs(dir.x), math.abs(dir.z)) then
- if dir.y < 0 then
- return 1
- else
- return 0
- end
- elseif math.abs(dir.x) > math.abs(dir.z) then
- if dir.x < 0 then
- return 3
- else
- return 2
- end
- else
- if dir.z < 0 then
- return 5
- else
- return 4
- end
- end
- end
- function core.get_node_drops(nodename, toolname)
- local drop = ItemStack({name=nodename}):get_definition().drop
- if drop == nil then
- -- default drop
- return {nodename}
- elseif type(drop) == "string" then
- -- itemstring drop
- return {drop}
- elseif drop.items == nil then
- -- drop = {} to disable default drop
- return {}
- end
- -- Extended drop table
- local got_items = {}
- local got_count = 0
- local _, item, tool
- for _, item in ipairs(drop.items) do
- local good_rarity = true
- local good_tool = true
- if item.rarity ~= nil then
- good_rarity = item.rarity < 1 or math.random(item.rarity) == 1
- end
- if item.tools ~= nil then
- good_tool = false
- for _, tool in ipairs(item.tools) do
- if tool:sub(1, 1) == '~' then
- good_tool = toolname:find(tool:sub(2)) ~= nil
- else
- good_tool = toolname == tool
- end
- if good_tool then
- break
- end
- end
- end
- if good_rarity and good_tool then
- got_count = got_count + 1
- for _, add_item in ipairs(item.items) do
- got_items[#got_items+1] = add_item
- end
- if drop.max_items ~= nil and got_count == drop.max_items then
- break
- end
- end
- end
- return got_items
- end
- function core.item_place_node(itemstack, placer, pointed_thing, param2)
- local item = itemstack:peek_item()
- local def = itemstack:get_definition()
- if def.type ~= "node" or pointed_thing.type ~= "node" then
- return itemstack, false
- end
- local under = pointed_thing.under
- local oldnode_under = core.get_node_or_nil(under)
- local above = pointed_thing.above
- local oldnode_above = core.get_node_or_nil(above)
- if not oldnode_under or not oldnode_above then
- core.log("info", placer:get_player_name() .. " tried to place"
- .. " node in unloaded position " .. core.pos_to_string(above))
- return itemstack, false
- end
- local olddef_under = ItemStack({name=oldnode_under.name}):get_definition()
- olddef_under = olddef_under or core.nodedef_default
- local olddef_above = ItemStack({name=oldnode_above.name}):get_definition()
- olddef_above = olddef_above or core.nodedef_default
- if not olddef_above.buildable_to and not olddef_under.buildable_to then
- core.log("info", placer:get_player_name() .. " tried to place"
- .. " node in invalid position " .. core.pos_to_string(above)
- .. ", replacing " .. oldnode_above.name)
- return itemstack, false
- end
- -- Place above pointed node
- local place_to = {x = above.x, y = above.y, z = above.z}
- -- If node under is buildable_to, place into it instead (eg. snow)
- if olddef_under.buildable_to then
- core.log("info", "node under is buildable to")
- place_to = {x = under.x, y = under.y, z = under.z}
- end
- if core.is_protected(place_to, placer:get_player_name()) then
- core.log("action", placer:get_player_name()
- .. " tried to place " .. def.name
- .. " at protected position "
- .. core.pos_to_string(place_to))
- core.record_protection_violation(place_to, placer:get_player_name())
- return itemstack
- end
- core.log("action", placer:get_player_name() .. " places node "
- .. def.name .. " at " .. core.pos_to_string(place_to))
-
- local oldnode = core.get_node(place_to)
- local newnode = {name = def.name, param1 = 0, param2 = param2}
- -- Calculate direction for wall mounted stuff like torches and signs
- if def.paramtype2 == 'wallmounted' and not param2 then
- local dir = {
- x = under.x - above.x,
- y = under.y - above.y,
- z = under.z - above.z
- }
- newnode.param2 = core.dir_to_wallmounted(dir)
- -- Calculate the direction for furnaces and chests and stuff
- elseif def.paramtype2 == 'facedir' and not param2 then
- local placer_pos = placer:getpos()
- if placer_pos then
- local dir = {
- x = above.x - placer_pos.x,
- y = above.y - placer_pos.y,
- z = above.z - placer_pos.z
- }
- newnode.param2 = core.dir_to_facedir(dir)
- core.log("action", "facedir: " .. newnode.param2)
- end
- end
- -- Check if the node is attached and if it can be placed there
- if core.get_item_group(def.name, "attached_node") ~= 0 and
- not check_attached_node(place_to, newnode) then
- core.log("action", "attached node " .. def.name ..
- " can not be placed at " .. core.pos_to_string(place_to))
- return itemstack, false
- end
- -- Add node and update
- core.add_node(place_to, newnode)
- local take_item = true
- -- Run callback
- if def.after_place_node then
- -- Deepcopy place_to and pointed_thing because callback can modify it
- local place_to_copy = {x=place_to.x, y=place_to.y, z=place_to.z}
- local pointed_thing_copy = copy_pointed_thing(pointed_thing)
- if def.after_place_node(place_to_copy, placer, itemstack,
- pointed_thing_copy) then
- take_item = false
- end
- end
- -- Run script hook
- local _, callback
- for _, callback in ipairs(core.registered_on_placenodes) do
- -- Deepcopy pos, node and pointed_thing because callback can modify them
- local place_to_copy = {x=place_to.x, y=place_to.y, z=place_to.z}
- local newnode_copy = {name=newnode.name, param1=newnode.param1, param2=newnode.param2}
- local oldnode_copy = {name=oldnode.name, param1=oldnode.param1, param2=oldnode.param2}
- local pointed_thing_copy = copy_pointed_thing(pointed_thing)
- if callback(place_to_copy, newnode_copy, placer, oldnode_copy, itemstack, pointed_thing_copy) then
- take_item = false
- end
- end
- if take_item then
- itemstack:take_item()
- end
- return itemstack, true
- end
- function core.item_place_object(itemstack, placer, pointed_thing)
- local pos = core.get_pointed_thing_position(pointed_thing, true)
- if pos ~= nil then
- local item = itemstack:take_item()
- core.add_item(pos, item)
- end
- return itemstack
- end
- function core.item_place(itemstack, placer, pointed_thing, param2)
- -- Call on_rightclick if the pointed node defines it
- if pointed_thing.type == "node" and placer and
- not placer:get_player_control().sneak then
- local n = core.get_node(pointed_thing.under)
- local nn = n.name
- if core.registered_nodes[nn] and core.registered_nodes[nn].on_rightclick then
- return core.registered_nodes[nn].on_rightclick(pointed_thing.under, n,
- placer, itemstack, pointed_thing) or itemstack, false
- end
- end
- if itemstack:get_definition().type == "node" then
- return core.item_place_node(itemstack, placer, pointed_thing, param2)
- end
- return itemstack
- end
- function core.item_drop(itemstack, dropper, pos)
- if dropper.get_player_name then
- local v = dropper:get_look_dir()
- local p = {x=pos.x+v.x, y=pos.y+1.5+v.y, z=pos.z+v.z}
- local obj = core.add_item(p, itemstack)
- if obj then
- v.x = v.x*2
- v.y = v.y*2 + 1
- v.z = v.z*2
- obj:setvelocity(v)
- end
- else
- core.add_item(pos, itemstack)
- end
- return ItemStack("")
- end
- function core.item_eat(hp_change, replace_with_item)
- return function(itemstack, user, pointed_thing) -- closure
- if itemstack:take_item() ~= nil then
- user:set_hp(user:get_hp() + hp_change)
- itemstack:add_item(replace_with_item) -- note: replace_with_item is optional
- end
- return itemstack
- end
- end
- function core.node_punch(pos, node, puncher, pointed_thing)
- -- Run script hook
- for _, callback in ipairs(core.registered_on_punchnodes) do
- -- Copy pos and node because callback can modify them
- local pos_copy = vector.new(pos)
- local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
- local pointed_thing_copy = pointed_thing and copy_pointed_thing(pointed_thing) or nil
- callback(pos_copy, node_copy, puncher, pointed_thing_copy)
- end
- end
- function core.handle_node_drops(pos, drops, digger)
- -- Add dropped items to object's inventory
- if digger:get_inventory() then
- local _, dropped_item
- for _, dropped_item in ipairs(drops) do
- local left = digger:get_inventory():add_item("main", dropped_item)
- if not left:is_empty() then
- local p = {
- x = pos.x + math.random()/2-0.25,
- y = pos.y + math.random()/2-0.25,
- z = pos.z + math.random()/2-0.25,
- }
- core.add_item(p, left)
- end
- end
- end
- end
- function core.node_dig(pos, node, digger)
- local def = ItemStack({name=node.name}):get_definition()
- if not def.diggable or (def.can_dig and not def.can_dig(pos,digger)) then
- core.log("info", digger:get_player_name() .. " tried to dig "
- .. node.name .. " which is not diggable "
- .. core.pos_to_string(pos))
- return
- end
- if core.is_protected(pos, digger:get_player_name()) then
- core.log("action", digger:get_player_name()
- .. " tried to dig " .. node.name
- .. " at protected position "
- .. core.pos_to_string(pos))
- core.record_protection_violation(pos, digger:get_player_name())
- return
- end
- core.log('action', digger:get_player_name() .. " digs "
- .. node.name .. " at " .. core.pos_to_string(pos))
- local wielded = digger:get_wielded_item()
- local drops = core.get_node_drops(node.name, wielded:get_name())
-
- local wdef = wielded:get_definition()
- local tp = wielded:get_tool_capabilities()
- local dp = core.get_dig_params(def.groups, tp)
- if wdef and wdef.after_use then
- wielded = wdef.after_use(wielded, digger, node, dp) or wielded
- else
- -- Wear out tool
- if not core.setting_getbool("creative_mode") then
- wielded:add_wear(dp.wear)
- end
- end
- digger:set_wielded_item(wielded)
-
- -- Handle drops
- core.handle_node_drops(pos, drops, digger)
- local oldmetadata = nil
- if def.after_dig_node then
- oldmetadata = core.get_meta(pos):to_table()
- end
- -- Remove node and update
- core.remove_node(pos)
-
- -- Run callback
- if def.after_dig_node then
- -- Copy pos and node because callback can modify them
- local pos_copy = {x=pos.x, y=pos.y, z=pos.z}
- local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
- def.after_dig_node(pos_copy, node_copy, oldmetadata, digger)
- end
- -- Run script hook
- local _, callback
- for _, callback in ipairs(core.registered_on_dignodes) do
- -- Copy pos and node because callback can modify them
- local pos_copy = {x=pos.x, y=pos.y, z=pos.z}
- local node_copy = {name=node.name, param1=node.param1, param2=node.param2}
- callback(pos_copy, node_copy, digger)
- end
- end
- -- This is used to allow mods to redefine core.item_place and so on
- -- NOTE: This is not the preferred way. Preferred way is to provide enough
- -- callbacks to not require redefining global functions. -celeron55
- local function redef_wrapper(table, name)
- return function(...)
- return table[name](...)
- end
- end
- --
- -- Item definition defaults
- --
- core.nodedef_default = {
- -- Item properties
- type="node",
- -- name intentionally not defined here
- description = "",
- groups = {},
- inventory_image = "",
- wield_image = "",
- wield_scale = {x=1,y=1,z=1},
- stack_max = 99,
- usable = false,
- liquids_pointable = false,
- tool_capabilities = nil,
- node_placement_prediction = nil,
- -- Interaction callbacks
- on_place = redef_wrapper(core, 'item_place'), -- core.item_place
- on_drop = redef_wrapper(core, 'item_drop'), -- core.item_drop
- on_use = nil,
- can_dig = nil,
- on_punch = redef_wrapper(core, 'node_punch'), -- core.node_punch
- on_rightclick = nil,
- on_dig = redef_wrapper(core, 'node_dig'), -- core.node_dig
- on_receive_fields = nil,
-
- on_metadata_inventory_move = core.node_metadata_inventory_move_allow_all,
- on_metadata_inventory_offer = core.node_metadata_inventory_offer_allow_all,
- on_metadata_inventory_take = core.node_metadata_inventory_take_allow_all,
- -- Node properties
- drawtype = "normal",
- visual_scale = 1.0,
- -- Don't define these because otherwise the old tile_images and
- -- special_materials wouldn't be read
- --tiles ={""},
- --special_tiles = {
- -- {name="", backface_culling=true},
- -- {name="", backface_culling=true},
- --},
- alpha = 255,
- post_effect_color = {a=0, r=0, g=0, b=0},
- paramtype = "none",
- paramtype2 = "none",
- is_ground_content = true,
- sunlight_propagates = false,
- walkable = true,
- pointable = true,
- diggable = true,
- climbable = false,
- buildable_to = false,
- liquidtype = "none",
- liquid_alternative_flowing = "",
- liquid_alternative_source = "",
- liquid_viscosity = 0,
- drowning = 0,
- light_source = 0,
- damage_per_second = 0,
- selection_box = {type="regular"},
- legacy_facedir_simple = false,
- legacy_wallmounted = false,
- }
- core.craftitemdef_default = {
- type="craft",
- -- name intentionally not defined here
- description = "",
- groups = {},
- inventory_image = "",
- wield_image = "",
- wield_scale = {x=1,y=1,z=1},
- stack_max = 99,
- liquids_pointable = false,
- tool_capabilities = nil,
- -- Interaction callbacks
- on_place = redef_wrapper(core, 'item_place'), -- core.item_place
- on_drop = redef_wrapper(core, 'item_drop'), -- core.item_drop
- on_use = nil,
- }
- core.tooldef_default = {
- type="tool",
- -- name intentionally not defined here
- description = "",
- groups = {},
- inventory_image = "",
- wield_image = "",
- wield_scale = {x=1,y=1,z=1},
- stack_max = 1,
- liquids_pointable = false,
- tool_capabilities = nil,
- -- Interaction callbacks
- on_place = redef_wrapper(core, 'item_place'), -- core.item_place
- on_drop = redef_wrapper(core, 'item_drop'), -- core.item_drop
- on_use = nil,
- }
- core.noneitemdef_default = { -- This is used for the hand and unknown items
- type="none",
- -- name intentionally not defined here
- description = "",
- groups = {},
- inventory_image = "",
- wield_image = "",
- wield_scale = {x=1,y=1,z=1},
- stack_max = 99,
- liquids_pointable = false,
- tool_capabilities = nil,
- -- Interaction callbacks
- on_place = redef_wrapper(core, 'item_place'),
- on_drop = nil,
- on_use = nil,
- }
|