From 2bf396e5bf19d506cf11bce68c87abfecc87571b Mon Sep 17 00:00:00 2001 From: FaceDeer Date: Sat, 13 Mar 2021 02:19:11 -0700 Subject: [PATCH] fancy compressor with formspec and fuel requirement (optional) --- init.lua | 380 ++++++++++++++++++++++++++++++++++---------- locale/template.txt | 8 +- settingtypes.txt | 3 +- 3 files changed, 301 insertions(+), 90 deletions(-) diff --git a/init.lua b/init.lua index aaa4012..39cd40a 100644 --- a/init.lua +++ b/init.lua @@ -42,55 +42,30 @@ setting("int", "bronze_3_uses", config.bronze_uses * 3, "Number of uses for thre setting("bool", "wear_in_creative", true, "Air tanks wear out in creative mode") +setting("bool", "compressor_needs_fuel", true, "Compressor needs fuel") + local compressor_desc = S("A machine for filling air tanks with compressed air.") -local compressor_help = S("Place this machine somewhere that it has access to air (one of its adjacent nodes needs to have air in it). When you click on it with an empty or partly-empty compressed air tank the tank will be refilled.") +local compressor_help +if config.compressor_needs_fuel then + compressor_help = S("This machine requires fuel to operate. Place something that can burn in the fuel slot, and then place empty tanks in the inventory to the right. The compressor will start filling the largest capacity tanks first.") +else + compressor_help = S("Place place empty tanks in the inventory to the right. The compressor will start filling the largest capacity tanks first.") +end local tube_desc = S("A breathing tube to allow automatic hands-free use of air tanks.") local tube_help = S("If this item is present in your quick-use inventory then whenever your breath bar goes below 5 it will automatically make use of any air tanks that are present in your quick-use inventory to replenish your breath supply. Note that it will not use air tanks that are present elsewhere in your inventory, only ones in your quick-use bar.") local cardinal_dirs = {{x=1,y=0,z=0},{x=-1,y=0,z=0},{x=0,y=1,z=0},{x=0,y=-1,z=0},{x=0,y=0,z=1},{x=0,y=0,z=-1},} -local function recharge_airtank(itemstack, user, pointed_thing, full_item) - if pointed_thing.type ~= "node" then return itemstack end - local node = minetest.get_node(pointed_thing.under) - if minetest.get_item_group(node.name, "airtanks_compressor") > 0 then - - local has_air = false - for _, dir in pairs(cardinal_dirs) do - if minetest.get_node(vector.add(pointed_thing.under, dir)).name == "air" then - has_air = true - break - end - end - if not has_air then - minetest.sound_play("airtanks_compressor_fail", {pos = pointed_thing.under, gain = 0.5}) - return itemstack - end - - if itemstack:get_name() == full_item then - itemstack:set_wear(0) - else - local inv = user:get_inventory() - - if itemstack:get_count() == 1 then - itemstack = ItemStack(full_item) -- replace with new stack containing one full tank - else - local leftover = inv:add_item("main", full_item) - if leftover:get_count() == 0 then - itemstack:take_item(1) - end - end - end - minetest.sound_play("airtanks_compressor", {pos = pointed_thing.under, gain = 0.5}) - end - return itemstack +-- For compressor code use later on +local max_uses = math.max(config.steel_uses, config.copper_uses, config.bronze_uses) +if config.enable_triple then + max_uses = max_uses * 3 +elseif config.enable_double then + max_uses = max_uses * 2 end -local function use_airtank(itemstack, user, pointed_thing, full_item) - if pointed_thing then - itemstack = recharge_airtank(itemstack, user, pointed_thing, full_item) -- first check if we're clicking on a compressor - end - +local function use_airtank(itemstack, user) local breath = user:get_breath() if breath > 9 then return itemstack end breath = math.min(10, breath+5) @@ -99,14 +74,14 @@ local function use_airtank(itemstack, user, pointed_thing, full_item) if (not minetest.settings:get_bool("creative_mode")) or config.wear_in_creative then local wdef = itemstack:get_definition() - itemstack:add_wear(65535/(wdef._airtank_uses-1)) + itemstack:add_wear(65535/(wdef._airtanks_uses-1)) if itemstack:get_count() == 0 then if wdef.sound and wdef.sound.breaks then minetest.sound_play(wdef.sound.breaks, {pos = user:get_pos(), gain = 0.5}) end local inv = user:get_inventory() - itemstack = inv:add_item("main", wdef._airtank_empty) + itemstack = inv:add_item("main", wdef._airtanks_empty) end end return itemstack @@ -116,38 +91,33 @@ end local function register_air_tank(name, desc, color, uses, material) minetest.register_craftitem("airtanks:empty_"..name.."_tank", { description = S("Empty @1", desc), + groups = {airtank = 1}, _doc_items_longdesc = S("A compressed air tank, currently empty."), _doc_items_usagehelp = S("This tank can be recharged with compressed air by using it on a compressor block. When fully charged this tank has @1 uses before it becomes empty.", uses), + _airtanks_uses = uses, + _airtanks_full = "airtanks:"..name.."_tank", inventory_image = "airtanks_airtank.png^[colorize:"..color.."^[mask:airtanks_airtank.png^airtanks_empty.png", wield_image = "airtanks_airtank.png^[colorize:"..color.."^[mask:airtanks_airtank.png^airtanks_empty.png", stack_max = 99, - - on_place = function(itemstack, user, pointed_thing) - return recharge_airtank(itemstack, user, pointed_thing, "airtanks:"..name.."_tank") - end, - - on_use = function(itemstack, user, pointed_thing) - return recharge_airtank(itemstack, user, pointed_thing, "airtanks:"..name.."_tank") - end, }) minetest.register_tool("airtanks:"..name.."_tank", { description = desc, _doc_items_longdesc = S("A tank containing compressed air."), _doc_items_usagehelp = S("If you're underwater and you're running out of breath, wield this item and use it to replenish 5 bubbles on your breath bar. When fully charged this tank has @1 uses before it becomes empty.", uses), - _airtank_uses = uses, - _airtank_empty = "airtanks:empty_"..name.."_tank", - groups = {not_repaired_by_anvil = 1, airtank = 1}, + _airtanks_uses = uses, + _airtanks_empty = "airtanks:empty_"..name.."_tank", + groups = {not_repaired_by_anvil = 1, airtank = 2}, inventory_image = "airtanks_airtank.png^[colorize:"..color.."^[mask:airtanks_airtank.png", wield_image = "airtanks_airtank.png^[colorize:"..color.."^[mask:airtanks_airtank.png", stack_max = 1, on_place = function(itemstack, user, pointed_thing) - return use_airtank(itemstack, user, pointed_thing, "airtanks:"..name.."_tank", "airtanks:empty_"..name.."_tank") + return use_airtank(itemstack, user) end, on_use = function(itemstack, user, pointed_thing) - return use_airtank(itemstack, user, pointed_thing, "airtanks:"..name.."_tank", "airtanks:empty_"..name.."_tank") + return use_airtank(itemstack, user) end, }) @@ -166,38 +136,33 @@ end local function register_air_tank_2(name, desc, color, uses) minetest.register_craftitem("airtanks:empty_"..name.."_tank_2", { description = S("Empty @1", desc), + groups = {airtank = 1}, _doc_items_longdesc = S("A pair of compressed air tanks, currently empty."), _doc_items_usagehelp = S("This tank can be recharged with compressed air by using it on a compressor block. When fully charged these tanks have @1 uses before it becomes empty.", uses), + _airtanks_uses = uses, + _airtanks_full = "airtanks:"..name.."_tank_2", inventory_image = "airtanks_airtank_two.png^[colorize:"..color.."^[mask:airtanks_airtank_two.png^airtanks_empty.png", wield_image = "airtanks_airtank_two.png^[colorize:"..color.."^[mask:airtanks_airtank_two.png^airtanks_empty.png", stack_max = 99, - - on_place = function(itemstack, user, pointed_thing) - return recharge_airtank(itemstack, user, pointed_thing, "airtanks:"..name.."_tank_2") - end, - - on_use = function(itemstack, user, pointed_thing) - return recharge_airtank(itemstack, user, pointed_thing, "airtanks:"..name.."_tank_2") - end, }) minetest.register_tool("airtanks:"..name.."_tank_2", { description = desc, _doc_items_longdesc = S("A pair of tanks containing compressed air."), _doc_items_usagehelp = S("If you're underwater and you're running out of breath, wield this item and use it to replenish 5 bubbles on your breath bar. When fully charged these tanks have @1 uses before it becomes empty.", uses), - _airtank_uses = uses, - _airtank_empty = "airtanks:empty_"..name.."_tank_2", - groups = {not_repaired_by_anvil = 1, airtank = 1}, + _airtanks_uses = uses, + _airtanks_empty = "airtanks:empty_"..name.."_tank_2", + groups = {not_repaired_by_anvil = 1, airtank = 2}, inventory_image = "airtanks_airtank_two.png^[colorize:"..color.."^[mask:airtanks_airtank_two.png", wield_image = "airtanks_airtank_two.png^[colorize:"..color.."^[mask:airtanks_airtank_two.png", stack_max = 1, on_place = function(itemstack, user, pointed_thing) - return use_airtank(itemstack, user, pointed_thing, "airtanks:"..name.."_tank_2", "airtanks:empty_"..name.."_tank_2") + return use_airtank(itemstack, user) end, on_use = function(itemstack, user, pointed_thing) - return use_airtank(itemstack, user, pointed_thing, "airtanks:"..name.."_tank_2", "airtanks:empty_"..name.."_tank_2") + return use_airtank(itemstack, user) end, }) @@ -223,41 +188,36 @@ end local function register_air_tank_3(name, desc, color, uses) minetest.register_craftitem("airtanks:empty_"..name.."_tank_3", { description = S("Empty @1", desc), + groups = {airtank = 1}, _doc_items_longdesc = S("A set of three compressed air tanks, currently empty."), _doc_items_usagehelp = S("These tanks can be recharged with compressed air by using it on a compressor block. When fully charged these tanks have @1 uses before it becomes empty.", uses), + _airtanks_uses = uses, + _airtanks_full = "airtanks:"..name.."_tank_3", inventory_image = "airtanks_airtank_three.png^[colorize:"..color.."^[mask:airtanks_airtank_three.png^airtanks_empty.png", wield_image = "airtanks_airtank_three.png^[colorize:"..color.."^[mask:airtanks_airtank_three.png^airtanks_empty.png", stack_max = 99, - - on_place = function(itemstack, user, pointed_thing) - return recharge_airtank(itemstack, user, pointed_thing, "airtanks:"..name.."_tank_3") - end, - - on_use = function(itemstack, user, pointed_thing) - return recharge_airtank(itemstack, user, pointed_thing, "airtanks:"..name.."_tank_3") - end, }) minetest.register_tool("airtanks:"..name.."_tank_3", { description = desc, _doc_items_longdesc = S("A set of three tanks containing compressed air."), _doc_items_usagehelp = S("If you're underwater and you're running out of breath, wield this item and use it to replenish 5 bubbles on your breath bar. When fully charged these tanks have @1 uses before it becomes empty.", uses), - _airtank_uses = uses, - _airtank_empty = "airtanks:empty_"..name.."_tank_3", - groups = {not_repaired_by_anvil = 1, airtank = 1}, + _airtanks_uses = uses, + _airtanks_empty = "airtanks:empty_"..name.."_tank_3", + groups = {not_repaired_by_anvil = 1, airtank = 2}, inventory_image = "airtanks_airtank_three.png^[colorize:"..color.."^[mask:airtanks_airtank_three.png", wield_image = "airtanks_airtank_three.png^[colorize:"..color.."^[mask:airtanks_airtank_three.png", stack_max = 1, on_place = function(itemstack, user, pointed_thing) - return use_airtank(itemstack, user, pointed_thing, "airtanks:"..name.."_tank_3", "airtanks:empty_"..name.."_tank_3") + return use_airtank(itemstack, user) end, on_use = function(itemstack, user, pointed_thing) - return use_airtank(itemstack, user, pointed_thing, "airtanks:"..name.."_tank_3", "airtanks:empty_"..name.."_tank_3") + return use_airtank(itemstack, user) end, }) - + -- Allow empty tanks minetest.register_craft({ recipe = { @@ -310,11 +270,204 @@ end --------------------------------------------------------------------------------------------------------- -- Compressor -local sounds -if default.node_sound_metal_defaults then -- 0.4.14 doesn't have metal sounds - sounds = default.node_sound_metal_defaults() +local sounds = default.node_sound_metal_defaults() + +local tank_inv_size = 4*4 + +local get_compressor_formspec +if config.compressor_needs_fuel then + get_compressor_formspec = function(remaining_time) + local formspec = + "size[8,9]" .. + "label[1,1.5;" .. S("Fuel") .. "]" .. + "list[context;fuel;1,2;1,1;]" .. + "label[4.5,0;" .. S("Tanks") .. "]" .. + "label[2,2;" .. S("Pressure:\n@1", remaining_time) .. "]" .. + "list[context;tanks;3,0.5;4,4;]" .. + "list[current_player;main;0,4.85;8,1;]" .. + "list[current_player;main;0,6.08;8,3;8]" .. + "listring[context;tanks]" .. + "listring[current_player;main]" .. + default.get_hotbar_bg(0,4.85) + return formspec + end else - sounds = default.node_sound_stone_defaults() + get_compressor_formspec = function() + local formspec = + "size[8,9]" .. + "label[3.5,0;" .. S("Tanks") .. "]" .. + "list[context;tanks;2,0.5;4,4;]" .. + "list[current_player;main;0,4.85;8,1;]" .. + "list[current_player;main;0,6.08;8,3;8]" .. + "listring[context;tanks]" .. + "listring[current_player;main]" .. + default.get_hotbar_bg(0,4.85) + return formspec + end +end + +-- ensures only valid items can be placed into compressor inventories +local test_can_put = function(pos, listname, index, itemstack) + if listname == "tanks" then + if minetest.get_item_group(itemstack:get_name(), "airtank") > 0 then + local meta = minetest.get_meta(pos) + local inv = meta:get_inventory() + if inv:get_stack(listname, index):get_count() == 0 then + return 1 + end + end + return 0 + end + if listname == "fuel" then + local fuel, afterfuel = minetest.get_craft_result({method="fuel",width=1,items={itemstack:get_name()}}) + if fuel.time ~= 0 then + return itemstack:get_count() + end + return 0 + end + return itemstack:get_count() +end + +-- whenever an inventory action is performed, makes sure there's a timer running +local ensure_timer = function(pos) + local timer = minetest.get_node_timer(pos) + if not timer:is_started() then + timer:start(1) + end +end + +-- Locates the target tank to fill +local find_most_fillable = function(inv) + local most_fillable_index = 0 + local most_fillable_capacity = 0 + local most_fillable_needs = max_uses + 1 + local most_fillable_stack + local most_fillable_def + for i = 1, tank_inv_size do + local tank = inv:get_stack("tanks", i) + local count = tank:get_count() -- for sanity-checking purposes + if count > 1 then + minetest.log("error", "[airtanks] Compressor at " .. minetest.pos_to_string(pos) + .. " had a tank stack with more than one tank in it. Currently not something that's" + .. " handled gracefully.") + return false + elseif count == 1 then + local tank_def = tank:get_definition() + local tank_capacity = tank_def._airtanks_uses + local tank_needs + if tank_def._airtanks_full then + tank_needs = tank_capacity -- this is an empty tank + else + tank_needs = tank_capacity * (tank:get_wear() / 65535) + end + if tank_needs > 0 then -- ignore tanks that are already full + if tank_capacity > most_fillable_capacity then -- fill biggest tanks first + most_fillable_needs = max_uses + 1 + most_fillable_capacity = tank_capacity + end + if tank_needs < most_fillable_needs then-- fill tanks closest to being full first + most_fillable_needs = tank_needs + end + if most_fillable_capacity == tank_capacity and most_fillable_needs == tank_needs then + most_fillable_index = i + most_fillable_stack = tank + most_fillable_def = tank_def + end + end + end + end + + return most_fillable_index, most_fillable_stack, most_fillable_def +end + +local compressor_timestep_with_fuel = function(pos) + local meta = minetest.get_meta(pos) + local inv = meta:get_inventory() + local fuel_time = meta:get_float("fuel_time") + + if (fuel_time < 1 and inv:is_empty("fuel")) or inv:is_empty("tanks") then + return false + end + + local most_fillable_index, most_fillable_stack, most_fillable_def = find_most_fillable(inv) + + if most_fillable_index == 0 then + return false + end + + -- we now have a tank to fill. Do we have enough fuel? + if fuel_time < 1 then + local fuel_item = inv:get_stack("fuel", 1) -- there should be something here or we would have exited early above + fuel_item:set_count(1) + local fuel_item = inv:remove_item("fuel", fuel_item) + local burn = minetest.get_craft_result({method="fuel",width=1,items={fuel_item:get_name()}}) + fuel_time = fuel_time + burn.time + end + + if fuel_time < 1 then + -- this fuel source is producing less than 1 second of burn time. Weird, but maybe so. + -- don't refill yet, just update the fuel burned and try again. + -- this is an edge case so I'm not too worried about efficiency here + meta:set_float("fuel_time", fuel_time) + return true + end + + fuel_time = fuel_time - 1 + local wear_per_use = 65535/most_fillable_def._airtanks_uses + if most_fillable_def._airtanks_full then + -- we're starting with a completely empty tank, turn it into a full tank and add wear. + most_fillable_stack = ItemStack(most_fillable_def._airtanks_full) + most_fillable_stack:set_wear(65535 - wear_per_use) + else + most_fillable_stack:set_wear(math.max(most_fillable_stack:get_wear() - wear_per_use, 0)) + end + + inv:set_stack("tanks", most_fillable_index, most_fillable_stack) + meta:set_float("fuel_time", fuel_time) + return true +end + +local compressor_timestep_without_fuel = function(pos) + local meta = minetest.get_meta(pos) + local inv = meta:get_inventory() + + if inv:is_empty("tanks") then + return false + end + + local most_fillable_index, most_fillable_stack, most_fillable_def = find_most_fillable(inv) + + if most_fillable_index == 0 then + return false + end + + local wear_per_use = 65535/most_fillable_def._airtanks_uses + if most_fillable_def._airtanks_full then + -- we're starting with a completely empty tank, turn it into a full tank and add wear. + most_fillable_stack = ItemStack(most_fillable_def._airtanks_full) + most_fillable_stack:set_wear(65535 - wear_per_use) + else + most_fillable_stack:set_wear(math.max(most_fillable_stack:get_wear() - wear_per_use, 0)) + end + + inv:set_stack("tanks", most_fillable_index, most_fillable_stack) + return true +end + +local compressor_timestep +if config.compressor_needs_fuel then + compressor_timestep = compressor_timestep_with_fuel +else + compressor_timestep = compressor_timestep_without_fuel +end + +local compressor_construct = function(pos) + local meta = minetest.get_meta(pos) + local inv = meta:get_inventory() + inv:set_size("fuel", 1) + inv:set_size("tanks", tank_inv_size) + meta:set_float("fuel_time", 0) + meta:set_string("formspec", get_compressor_formspec(0)) end minetest.register_node("airtanks:compressor", { @@ -328,6 +481,7 @@ minetest.register_node("airtanks:compressor", { "airtanks_compressor_bottom.png^[transformR90", "airtanks_compressor.png" }, + use_texture_alpha = "clip", drawtype = "nodebox", paramtype = "light", paramtype2 = "facedir", @@ -338,9 +492,49 @@ minetest.register_node("airtanks:compressor", { {-0.3125, -0.5, -0.375, 0.3125, 0.125, 0.375}, {-0.125, 0.125, -0.25, 0.125, 0.4375, 0.25}, } - } + }, + + on_construct = compressor_construct, + + can_dig = function(pos,player) + local meta = minetest.get_meta(pos); + local inv = meta:get_inventory() + return inv:is_empty("fuel") and inv:is_empty("tanks") + end, + + allow_metadata_inventory_move = function(pos, from_list, from_index, to_list, to_index, count, player) + local meta = minetest.get_meta(pos) + local inv = meta:get_inventory() + local stack = inv:get_stack(from_list, from_index) + return test_can_put(pos, to_list, to_index, stack) + end, + allow_metadata_inventory_put = function(pos, listname, index, stack, player) + return test_can_put(pos, listname, index, stack) + end, + on_metadata_inventory_move = ensure_timer, + on_metadata_inventory_put = ensure_timer, + on_metadata_inventory_take = ensure_timer, + + on_timer = function(pos, elapsed) + local meta = minetest.get_meta(pos) + local last_return = true + while elapsed > 0 and last_return == true do + last_return = compressor_timestep(pos) + elapsed = elapsed - 1 + end + if last_return == true then + minetest.sound_play("airtanks_compressor", {pos = pos, gain = 0.5}) + minetest.get_node_timer(pos):start(1) + meta:set_string("last_state", "success") + elseif meta:get("last_state") == "success" then + minetest.sound_play("airtanks_compressor_fail", {pos = pos, gain = 0.5}) + meta:set_string("last_state", "fail") + end + meta:set_string("formspec", get_compressor_formspec(math.floor(meta:get_float("fuel_time")))) + end }) + minetest.register_craft({ recipe = { {"", "default:steel_ingot", ""}, @@ -409,3 +603,15 @@ end minetest.register_playerevent(player_event_handler) +----------------------------------------------------------------------------------------- +-- Update old compressors + +minetest.register_lbm({ + label = "Upgrade airtanks compressors", + name = "airtanks:upgrade_compressors", + nodenames = {"airtanks:compressor"}, + run_at_every_load = false, + action = function(pos, node) + compressor_construct(pos) + end, +}) diff --git a/locale/template.txt b/locale/template.txt index 4d12226..47ce280 100644 --- a/locale/template.txt +++ b/locale/template.txt @@ -29,6 +29,7 @@ Double Copper Air Tanks= Double Steel Air Tanks= #for indicating that a particular type of air tank is empty Empty @1= +Fuel= #documentation text If this item is present in your quick-use inventory then whenever your breath bar goes below 5 it will automatically make use of any air tanks that are present in your quick-use inventory to replenish your breath supply. Note that it will not use air tanks that are present elsewhere in your inventory, only ones in your quick-use bar.= @@ -38,14 +39,17 @@ If you're underwater and you're running out of breath, wield this item and use i #documentation text If you're underwater and you're running out of breath, wield this item and use it to replenish 5 bubbles on your breath bar. When fully charged this tank has @1 uses before it becomes empty.= -#documentation text -Place this machine somewhere that it has access to air (one of its adjacent nodes needs to have air in it). When you click on it with an empty or partly-empty compressed air tank the tank will be refilled.= +Place place empty tanks in the inventory to the right. The compressor will start filling the largest capacity tanks first.= +Pressure:@n@1= #compressed air tank made of steel Steel Air Tank= +Tanks= These tanks can be recharged with compressed air by using it on a compressor block. When fully charged these tanks have @1 uses before it becomes empty.= +This machine requires fuel to operate. Place something that can burn in the fuel slot, and then place empty tanks in the inventory to the right. The compressor will start filling the largest capacity tanks first.= + This tank can be recharged with compressed air by using it on a compressor block. When fully charged these tanks have @1 uses before it becomes empty.= #documentation text diff --git a/settingtypes.txt b/settingtypes.txt index d7190af..d973ad4 100644 --- a/settingtypes.txt +++ b/settingtypes.txt @@ -3,4 +3,5 @@ airtanks_copper_uses (Number of uses for a copper air tank) int 10 2 1000 airtanks_bronze_uses (Number of uses for a bronze air tank) int 20 2 1000 airtanks_wear_in_creative (Air tanks wear out in creative mode) bool true airtanks_enable_double (Enable double tanks) bool true -airtanks_enable_triple (Enable triple tanks) bool true \ No newline at end of file +airtanks_enable_triple (Enable triple tanks) bool true +airtanks_compressor_needs_fuel (Compressor requires fuel) bool true \ No newline at end of file