VoxeLibre/mods/ITEMS/mcl_buckets/init.lua

361 lines
11 KiB
Lua
Raw Permalink Normal View History

2015-06-29 19:55:56 +02:00
-- See README.txt for licensing and other information.
local modname = minetest.get_current_modname()
local S = minetest.get_translator(modname)
local modpath = minetest.get_modpath(modname)
2022-10-29 20:30:16 +02:00
local use_select_box = minetest.settings:get_bool("mcl_buckets_use_select_box", false)
2015-06-29 19:55:56 +02:00
-- Compatibility with old bucket mod
2017-08-03 16:36:55 +02:00
minetest.register_alias("bucket:bucket_empty", "mcl_buckets:bucket_empty")
minetest.register_alias("bucket:bucket_water", "mcl_buckets:bucket_water")
minetest.register_alias("bucket:bucket_lava", "mcl_buckets:bucket_lava")
2015-06-29 19:55:56 +02:00
2017-07-26 19:00:04 +02:00
local mod_doc = minetest.get_modpath("doc")
local mod_mcl_core = minetest.get_modpath("mcl_core")
2021-05-23 00:42:31 +02:00
--local mod_mclx_core = minetest.get_modpath("mclx_core")
2017-07-26 19:00:04 +02:00
-- Localize some functions for faster access
2021-05-22 18:58:58 +02:00
local vector = vector
local math = math
local string = string
2021-05-22 18:57:51 +02:00
local raycast = minetest.raycast
local get_node = minetest.get_node
local set_node = minetest.set_node
2021-05-22 18:57:51 +02:00
local add_node = minetest.add_node
2021-06-12 12:21:01 +02:00
local add_item = minetest.add_item
local registered_nodes = minetest.registered_nodes
local get_item_group = minetest.get_item_group
local is_creative_enabled = minetest.is_creative_enabled
local is_protected = minetest.is_protected
local record_protection_violation = minetest.record_protection_violation
2021-05-22 18:57:51 +02:00
minetest.register_craft({
output = "mcl_buckets:bucket_empty 1",
recipe = {
{"mcl_core:iron_ingot", "", "mcl_core:iron_ingot"},
{"", "mcl_core:iron_ingot", ""},
},
})
2015-06-29 19:55:56 +02:00
2022-02-17 15:36:48 +01:00
mcl_buckets = {
liquids = {},
buckets = {},
}
2015-06-29 19:55:56 +02:00
2017-06-06 21:50:03 +02:00
-- Sound helper functions for placing and taking liquids
2021-06-12 12:21:01 +02:00
local function sound_place(itemname, pos)
local def = registered_nodes[itemname]
2017-06-06 21:50:03 +02:00
if def and def.sounds and def.sounds.place then
2020-04-07 00:55:45 +02:00
minetest.sound_play(def.sounds.place, {gain=1.0, pos = pos, pitch = 1 + math.random(-10, 10)*0.005}, true)
2017-06-06 21:50:03 +02:00
end
end
2021-06-12 12:21:01 +02:00
local function sound_take(itemname, pos)
local def = registered_nodes[itemname]
2017-06-06 21:50:03 +02:00
if def and def.sounds and def.sounds.dug then
2020-04-07 00:55:45 +02:00
minetest.sound_play(def.sounds.dug, {gain=1.0, pos = pos, pitch = 1 + math.random(-10, 10)*0.005}, true)
2017-06-06 21:50:03 +02:00
end
end
2021-06-12 12:21:01 +02:00
local function place_liquid(pos, itemstring)
sound_place(itemstring, pos)
2023-02-18 09:25:47 +01:00
set_node(pos, {name=itemstring})
end
2021-05-22 10:47:28 +02:00
local function give_bucket(new_bucket, itemstack, user)
2021-06-12 12:21:01 +02:00
local inv = user:get_inventory()
if is_creative_enabled(user:get_player_name()) then
2021-06-12 12:21:01 +02:00
--TODO: is a full bucket added if inv doesn't contain one?
return itemstack
2021-05-22 10:47:28 +02:00
else
2021-06-12 12:21:01 +02:00
if itemstack:get_count() == 1 then
return new_bucket
2021-05-22 10:47:28 +02:00
else
2021-06-12 12:21:01 +02:00
if inv:room_for_item("main", new_bucket) then
inv:add_item("main", new_bucket)
else
add_item(user:get_pos(), new_bucket)
end
2021-05-22 10:47:28 +02:00
itemstack:take_item()
2021-06-12 12:21:01 +02:00
return itemstack
2021-05-22 10:47:28 +02:00
end
end
end
2021-06-12 12:21:01 +02:00
local pointable_sources = {}
local function get_node_place(source_place, place_pos)
local node_place
if type(source_place) == "function" then
node_place = source_place(place_pos)
else
node_place = source_place
end
return node_place
end
local function get_extra_check(check, pos, user)
local result
local take_bucket
if check then
result, take_bucket = check(pos, user)
if result == nil then result = true end
if take_bucket == nil then take_bucket = true end
else
result = true
take_bucket = true
end
return result, take_bucket
end
local function get_bucket_drop(itemstack, user, take_bucket)
-- Handle bucket item and inventory stuff
if take_bucket and not is_creative_enabled(user:get_player_name()) then
-- Add empty bucket and put it into inventory, if possible.
-- Drop empty bucket otherwise.
local new_bucket = ItemStack("mcl_buckets:bucket_empty")
if itemstack:get_count() == 1 then
return new_bucket
else
local inv = user:get_inventory()
if inv:room_for_item("main", new_bucket) then
inv:add_item("main", new_bucket)
else
add_item(user:get_pos(), new_bucket)
end
itemstack:take_item()
return itemstack
end
else
return itemstack
end
end
2022-10-29 20:30:16 +02:00
local function bucket_get_pointed_thing(user)
local start = user:get_pos()
start.y = start.y + user:get_properties().eye_height
local look_dir = user:get_look_dir()
local _end = vector.add(start, vector.multiply(look_dir, 5))
2022-10-29 20:30:16 +02:00
local ray = raycast(start, _end, false, true)
for pointed_thing in ray do
local name = get_node(pointed_thing.under).name
local def = registered_nodes[name]
if not def or def.drawtype ~= "flowingliquid" then
return pointed_thing
end
end
end
local function on_place_bucket(itemstack, user, pointed_thing)
if not use_select_box then
pointed_thing = bucket_get_pointed_thing(user)
end
2022-02-17 15:36:48 +01:00
-- Must be pointing to node
2022-10-29 20:30:16 +02:00
if not pointed_thing or pointed_thing.type ~= "node" then
2022-02-17 15:36:48 +01:00
return
end
2022-11-25 03:33:59 +01:00
2022-02-17 15:36:48 +01:00
-- Call on_rightclick if the pointed node defines it
local new_stack = mcl_util.call_on_rightclick(itemstack, user, pointed_thing)
if new_stack then
return new_stack
end
2022-10-29 20:30:16 +02:00
local bucket_def = mcl_buckets.buckets[itemstack:get_name()]
for _, pos in pairs({ pointed_thing.under, pointed_thing.above }) do
local node = get_node(pos)
local node_def = registered_nodes[node.name]
if node_def and node_def.buildable_to or get_item_group(node.name, "cauldron") == 1 or minetest.get_node(pos).name == "mcl_mangrove:mangrove_roots" then
2022-10-29 20:30:16 +02:00
local result, take_bucket = get_extra_check(bucket_def.extra_check, pos, user)
if result then
local node_place = get_node_place(bucket_def.source_place, pos)
local player_name = user:get_player_name()
-- Check protection
if is_protected(pos, player_name) then
record_protection_violation(pos, player_name)
return itemstack
end
2022-02-17 15:36:48 +01:00
2022-10-29 20:30:16 +02:00
-- Place liquid
place_liquid(pos, node_place)
2022-02-17 15:36:48 +01:00
2022-10-29 20:30:16 +02:00
-- Update doc mod
if mod_doc and doc.entry_exists("nodes", node_place) then
doc.mark_entry_as_revealed(user:get_player_name(), "nodes", node_place)
end
2022-02-17 15:36:48 +01:00
end
2022-10-29 20:30:16 +02:00
return get_bucket_drop(itemstack, user, take_bucket)
2022-02-17 15:36:48 +01:00
end
end
2022-10-29 20:30:16 +02:00
return itemstack
2022-02-17 15:36:48 +01:00
end
local function on_place_bucket_empty(itemstack, user, pointed_thing)
2022-10-29 20:30:16 +02:00
if not use_select_box then
pointed_thing = bucket_get_pointed_thing(user)
end
2022-11-25 03:33:59 +01:00
2022-02-17 15:36:48 +01:00
-- Must be pointing to node
2022-10-29 20:30:16 +02:00
if not pointed_thing or pointed_thing.type ~= "node" then
2022-02-17 15:36:48 +01:00
return itemstack
end
-- Call on_rightclick if the pointed node defines it
local new_stack = mcl_util.call_on_rightclick(itemstack, user, pointed_thing)
if new_stack and new_stack ~= itemstack then
2022-02-17 15:36:48 +01:00
return new_stack
end
local new_bucket
2022-10-29 20:30:16 +02:00
local under = pointed_thing.under
local node_name = get_node(under).name
if pointable_sources[node_name] then
if is_protected(under, user:get_player_name()) then
record_protection_violation(under, user:get_player_name())
2022-02-17 15:36:48 +01:00
end
2022-10-29 20:30:16 +02:00
local liquid_def = mcl_buckets.liquids[node_name]
if liquid_def then
-- Fill bucket, but not in Creative Mode
-- FIXME: remove this line
--if not is_creative_enabled(user:get_player_name()) then
if not false then
new_bucket = ItemStack({name = liquid_def.bucketname})
if liquid_def.on_take then
liquid_def.on_take(user)
2022-02-17 15:36:48 +01:00
end
2022-10-29 20:30:16 +02:00
end
add_node(under, {name="air"})
sound_take(node_name, under)
2022-02-17 15:36:48 +01:00
2022-10-29 20:30:16 +02:00
if mod_doc and doc.entry_exists("nodes", node_name) then
doc.mark_entry_as_revealed(user:get_player_name(), "nodes", node_name)
end
if new_bucket then
return give_bucket(new_bucket, itemstack, user)
2022-02-17 15:36:48 +01:00
end
2022-10-29 20:30:16 +02:00
else
minetest.log("error", string.format("[mcl_buckets] Node [%s] has invalid group [_mcl_bucket_pointable]!", node_name))
2022-02-17 15:36:48 +01:00
end
return itemstack
else
-- FIXME: replace this ugly code by cauldrons API
2022-10-29 20:30:16 +02:00
if node_name == "mcl_cauldrons:cauldron_3" then
2022-02-17 15:36:48 +01:00
-- Take water out of full cauldron
2022-10-29 20:30:16 +02:00
set_node(under, {name="mcl_cauldrons:cauldron"})
if not is_creative_enabled(user:get_player_name()) then
2022-02-17 15:36:48 +01:00
new_bucket = ItemStack("mcl_buckets:bucket_water")
end
2022-10-29 20:30:16 +02:00
sound_take("mcl_core:water_source", under)
elseif node_name == "mcl_cauldrons:cauldron_3r" then
2022-02-17 15:36:48 +01:00
-- Take river water out of full cauldron
2022-10-29 20:30:16 +02:00
set_node(under, {name="mcl_cauldrons:cauldron"})
if not is_creative_enabled(user:get_player_name()) then
2022-02-17 15:36:48 +01:00
new_bucket = ItemStack("mcl_buckets:bucket_river_water")
end
2022-10-29 20:30:16 +02:00
sound_take("mclx_core:river_water_source", under)
elseif node_name == "mcl_cauldrons:cauldron_3_lava" then
set_node(under, {name="mcl_cauldrons:cauldron"})
2022-06-21 13:05:24 +02:00
if not is_creative_enabled(user:get_player_name()) then
new_bucket = ItemStack("mcl_buckets:bucket_lava")
end
2022-10-29 20:30:16 +02:00
sound_take("mcl_core:lava_source", under)
2022-02-17 15:36:48 +01:00
end
if new_bucket then
return give_bucket(new_bucket, itemstack, user)
end
end
return itemstack
end
function mcl_buckets.register_liquid(def)
2021-05-22 10:47:28 +02:00
for _,source in ipairs(def.source_take) do
mcl_buckets.liquids[source] = {
source_place = def.source_place,
2021-05-22 10:47:28 +02:00
source_take = source,
on_take = def.on_take,
2021-07-14 15:18:12 +02:00
bucketname = def.bucketname,
}
2021-06-12 12:21:01 +02:00
pointable_sources[source] = true
if type(def.source_place) == "string" then
2021-05-22 10:47:28 +02:00
mcl_buckets.liquids[def.source_place] = mcl_buckets.liquids[source]
end
end
2015-06-29 19:55:56 +02:00
2022-02-17 15:36:48 +01:00
mcl_buckets.buckets[def.bucketname] = def
2021-07-14 15:18:12 +02:00
if def.bucketname == nil or def.bucketname == "" then
error(string.format("[mcl_bucket] Invalid itemname then registering [%s]!", def.name))
end
2021-07-14 15:18:12 +02:00
minetest.register_craftitem(def.bucketname, {
2021-05-22 10:47:28 +02:00
description = def.name,
_doc_items_longdesc = def.longdesc,
_doc_items_usagehelp = def.usagehelp,
_tt_help = def.tt_help,
inventory_image = def.inventory_image,
stack_max = 1,
groups = def.groups,
2022-10-29 20:30:16 +02:00
liquids_pointable = use_select_box,
on_place = on_place_bucket,
on_secondary_use = on_place_bucket,
2021-05-22 10:47:28 +02:00
_on_dispense = function(stack, pos, droppos, dropnode, dropdir)
local buildable = registered_nodes[dropnode.name].buildable_to or dropnode.name == "mcl_portals:portal"
2021-07-14 09:18:15 +02:00
if not buildable then return stack end
local result, take_bucket = get_extra_check(def.extra_check, droppos, nil)
2021-07-14 09:18:15 +02:00
if result then -- Fail placement of liquid if result is false
place_liquid(droppos, get_node_place(def.source_place, droppos))
end
if take_bucket then
2021-05-22 10:47:28 +02:00
stack:set_name("mcl_buckets:bucket_empty")
end
return stack
end,
})
2015-06-29 19:55:56 +02:00
end
2017-08-03 16:36:55 +02:00
minetest.register_craftitem("mcl_buckets:bucket_empty", {
description = S("Empty Bucket"),
_doc_items_longdesc = S("A bucket can be used to collect and release liquids."),
_doc_items_usagehelp = S("Punch a liquid source to collect it. You can then use the filled bucket to place the liquid somewhere else."),
2020-03-08 03:18:47 +01:00
_tt_help = S("Collects liquids"),
inventory_image = "mcl_buckets_bucket.png",
stack_max = 16,
2022-10-29 20:30:16 +02:00
liquids_pointable = use_select_box,
on_place = on_place_bucket_empty,
on_secondary_use = on_place_bucket_empty,
_on_dispense = function(stack, pos, droppos, dropnode, dropdir)
-- Fill empty bucket with liquid or drop bucket if no liquid
local collect_liquid = false
local liquiddef = mcl_buckets.liquids[dropnode.name]
local new_bucket
2021-07-14 15:18:12 +02:00
if liquiddef and liquiddef.bucketname and (dropnode.name == liquiddef.source_take) then
-- Fill bucket
2021-07-14 15:18:12 +02:00
new_bucket = ItemStack({name = liquiddef.bucketname})
sound_take(dropnode.name, droppos)
collect_liquid = true
end
if collect_liquid then
set_node(droppos, {name="air"})
-- Fill bucket with liquid
stack = new_bucket
else
-- No liquid found: Drop empty bucket
add_item(droppos, stack)
stack:take_item()
end
return stack
end,
2015-06-29 19:55:56 +02:00
})
dofile(modpath.."/register.lua")
2022-11-25 03:33:36 +01:00
dofile(modpath.."/fishbuckets.lua")