From ecfb11c096d763d5377d2c2ac5dc204c50bac09d Mon Sep 17 00:00:00 2001 From: mezz Date: Wed, 3 Aug 2016 02:52:18 -0700 Subject: [PATCH] Encapsulate fields of fuels in the API --- .../forestry/api/fuels/EngineBronzeFuel.java | 48 ++++++++++++------- .../forestry/api/fuels/EngineCopperFuel.java | 35 +++++++++----- .../forestry/api/fuels/FermenterFuel.java | 36 +++++++++----- .../forestry/api/fuels/GeneratorFuel.java | 35 +++++++++----- .../forestry/api/fuels/MoistenerFuel.java | 48 ++++++++++++------- .../java/forestry/api/fuels/package-info.java | 2 +- .../energy/tiles/TileEngineBiogas.java | 7 ++- .../forestry/energy/tiles/TileEnginePeat.java | 16 ++++--- .../energy/tiles/TileEuGenerator.java | 8 ++-- .../fermenter/FermenterRecipeCategory.java | 3 +- .../jei/fermenter/FermenterRecipeWrapper.java | 2 +- .../moistener/MoistenerRecipeCategory.java | 4 +- .../jei/moistener/MoistenerRecipeHandler.java | 2 +- .../jei/moistener/MoistenerRecipeWrapper.java | 8 ++-- .../forestry/factory/tiles/TileFermenter.java | 4 +- .../forestry/factory/tiles/TileMoistener.java | 10 ++-- 16 files changed, 167 insertions(+), 101 deletions(-) diff --git a/src/main/java/forestry/api/fuels/EngineBronzeFuel.java b/src/main/java/forestry/api/fuels/EngineBronzeFuel.java index 2b5cd83e4..9a4022fda 100644 --- a/src/main/java/forestry/api/fuels/EngineBronzeFuel.java +++ b/src/main/java/forestry/api/fuels/EngineBronzeFuel.java @@ -8,22 +8,10 @@ package forestry.api.fuels; import net.minecraftforge.fluids.Fluid; public class EngineBronzeFuel { - /** - * Item that is valid fuel for a biogas engine. - */ - public final Fluid liquid; - /** - * Power produced by this fuel per work cycle of the engine. - */ - public final int powerPerCycle; - /** - * How many work cycles a single "stack" of this type lasts. - */ - public final int burnDuration; - /** - * By how much the normal heat dissipation rate of 1 is multiplied when using this fuel type. - */ - public final int dissipationMultiplier; + private final Fluid liquid; + private final int powerPerCycle; + private final int burnDuration; + private final int dissipationMultiplier; public EngineBronzeFuel(Fluid liquid, int powerPerCycle, int burnDuration, int dissipationMultiplier) { this.liquid = liquid; @@ -31,4 +19,32 @@ public class EngineBronzeFuel { this.burnDuration = burnDuration; this.dissipationMultiplier = dissipationMultiplier; } + + /** + * Item that is valid fuel for a biogas engine. + */ + public Fluid getLiquid() { + return liquid; + } + + /** + * Power produced by this fuel per work cycle of the engine. + */ + public int getPowerPerCycle() { + return powerPerCycle; + } + + /** + * How many work cycles a single "stack" of this type lasts. + */ + public int getBurnDuration() { + return burnDuration; + } + + /** + * By how much the normal heat dissipation rate of 1 is multiplied when using this fuel type. + */ + public int getDissipationMultiplier() { + return dissipationMultiplier; + } } diff --git a/src/main/java/forestry/api/fuels/EngineCopperFuel.java b/src/main/java/forestry/api/fuels/EngineCopperFuel.java index 9afcda3c8..7f903fcaa 100644 --- a/src/main/java/forestry/api/fuels/EngineCopperFuel.java +++ b/src/main/java/forestry/api/fuels/EngineCopperFuel.java @@ -9,18 +9,9 @@ import net.minecraft.item.ItemStack; public class EngineCopperFuel { - /** - * Item that is valid fuel for a peat-fired engine. - */ - public final ItemStack fuel; - /** - * Power produced by this fuel per work cycle. - */ - public final int powerPerCycle; - /** - * Amount of work cycles this item lasts before being consumed. - */ - public final int burnDuration; + private final ItemStack fuel; + private final int powerPerCycle; + private final int burnDuration; public EngineCopperFuel(ItemStack fuel, int powerPerCycle, int burnDuration) { this.fuel = fuel; @@ -28,4 +19,24 @@ public class EngineCopperFuel { this.burnDuration = burnDuration; } + /** + * Item that is valid fuel for a peat-fired engine. + */ + public ItemStack getFuel() { + return fuel; + } + + /** + * Power produced by this fuel per work cycle. + */ + public int getPowerPerCycle() { + return powerPerCycle; + } + + /** + * Amount of work cycles this item lasts before being consumed. + */ + public int getBurnDuration() { + return burnDuration; + } } diff --git a/src/main/java/forestry/api/fuels/FermenterFuel.java b/src/main/java/forestry/api/fuels/FermenterFuel.java index 24581263f..28cfd2b9a 100644 --- a/src/main/java/forestry/api/fuels/FermenterFuel.java +++ b/src/main/java/forestry/api/fuels/FermenterFuel.java @@ -8,22 +8,34 @@ package forestry.api.fuels; import net.minecraft.item.ItemStack; public class FermenterFuel { - /** - * Item that is a valid fuel for the fermenter (i.e. fertilizer). - */ - public final ItemStack item; - /** - * How much is fermeted per work cycle, i.e. how much biomass is produced per cycle. - */ - public final int fermentPerCycle; - /** - * Amount of work cycles a single item of this fuel lasts before expiring. - */ - public final int burnDuration; + private final ItemStack item; + private final int fermentPerCycle; + private final int burnDuration; public FermenterFuel(ItemStack item, int fermentPerCycle, int burnDuration) { this.item = item; this.fermentPerCycle = fermentPerCycle; this.burnDuration = burnDuration; } + + /** + * Item that is a valid fuel for the fermenter (i.e. fertilizer). + */ + public ItemStack getItem() { + return item; + } + + /** + * How much is fermeted per work cycle, i.e. how much biomass is produced per cycle. + */ + public int getFermentPerCycle() { + return fermentPerCycle; + } + + /** + * Amount of work cycles a single item of this fuel lasts before expiring. + */ + public int getBurnDuration() { + return burnDuration; + } } diff --git a/src/main/java/forestry/api/fuels/GeneratorFuel.java b/src/main/java/forestry/api/fuels/GeneratorFuel.java index 35ae2f2d0..e9654f224 100644 --- a/src/main/java/forestry/api/fuels/GeneratorFuel.java +++ b/src/main/java/forestry/api/fuels/GeneratorFuel.java @@ -9,18 +9,9 @@ import net.minecraftforge.fluids.FluidStack; public class GeneratorFuel { - /** - * LiquidStack representing the fuel type and amount consumed per triggered cycle. - */ - public final FluidStack fuelConsumed; - /** - * EU emitted per tick while this fuel is being consumed in the generator (i.e. biofuel = 32, biomass = 8). - */ - public final int eu; - /** - * Rate at which the fuel is consumed. 1 - Every tick 2 - Every second tick 3 - Every third tick etc. - */ - public final int rate; + private final FluidStack fuelConsumed; + private final int eu; + private final int rate; public GeneratorFuel(FluidStack fuelConsumed, int eu, int rate) { this.fuelConsumed = fuelConsumed; @@ -28,4 +19,24 @@ public class GeneratorFuel { this.rate = rate; } + /** + * LiquidStack representing the fuel type and amount consumed per triggered cycle. + */ + public FluidStack getFuelConsumed() { + return fuelConsumed; + } + + /** + * EU emitted per tick while this fuel is being consumed in the generator (i.e. biofuel = 32, biomass = 8). + */ + public int getEu() { + return eu; + } + + /** + * Rate at which the fuel is consumed. 1 - Every tick 2 - Every second tick 3 - Every third tick etc. + */ + public int getRate() { + return rate; + } } diff --git a/src/main/java/forestry/api/fuels/MoistenerFuel.java b/src/main/java/forestry/api/fuels/MoistenerFuel.java index a76a9189e..c691bd860 100644 --- a/src/main/java/forestry/api/fuels/MoistenerFuel.java +++ b/src/main/java/forestry/api/fuels/MoistenerFuel.java @@ -8,22 +8,10 @@ package forestry.api.fuels; import net.minecraft.item.ItemStack; public class MoistenerFuel { - /** - * The item to use - */ - public final ItemStack item; - /** - * The item that leaves the moistener's working slot (i.e. mouldy wheat, decayed wheat, mulch) - */ - public final ItemStack product; - /** - * How much this item contributes to the final product of the moistener (i.e. mycelium) - */ - public final int moistenerValue; - /** - * What stage this product represents. Resources with lower stage value will be consumed first. - */ - public final int stage; + private final ItemStack item; + private final ItemStack product; + private final int moistenerValue; + private final int stage; public MoistenerFuel(ItemStack item, ItemStack product, int stage, int moistenerValue) { this.item = item; @@ -31,4 +19,32 @@ public class MoistenerFuel { this.stage = stage; this.moistenerValue = moistenerValue; } + + /** + * The item to use + */ + public ItemStack getItem() { + return item; + } + + /** + * The item that leaves the moistener's working slot (i.e. mouldy wheat, decayed wheat, mulch) + */ + public ItemStack getProduct() { + return product; + } + + /** + * How much this item contributes to the final product of the moistener (i.e. mycelium) + */ + public int getMoistenerValue() { + return moistenerValue; + } + + /** + * What stage this product represents. Resources with lower stage value will be consumed first. + */ + public int getStage() { + return stage; + } } diff --git a/src/main/java/forestry/api/fuels/package-info.java b/src/main/java/forestry/api/fuels/package-info.java index fb2f50abd..39e4780a9 100644 --- a/src/main/java/forestry/api/fuels/package-info.java +++ b/src/main/java/forestry/api/fuels/package-info.java @@ -3,7 +3,7 @@ * * This work (the API) is licensed under the "MIT" License, see LICENSE.txt for details. ******************************************************************************/ -@API(apiVersion = "2.0.1", owner = "ForestryAPI|core", provides = "ForestryAPI|fuels") +@API(apiVersion = "3.0.0", owner = "ForestryAPI|core", provides = "ForestryAPI|fuels") package forestry.api.fuels; import net.minecraftforge.fml.common.API; diff --git a/src/main/java/forestry/energy/tiles/TileEngineBiogas.java b/src/main/java/forestry/energy/tiles/TileEngineBiogas.java index 8dda93677..6443d7daf 100644 --- a/src/main/java/forestry/energy/tiles/TileEngineBiogas.java +++ b/src/main/java/forestry/energy/tiles/TileEngineBiogas.java @@ -14,7 +14,6 @@ import javax.annotation.Nonnull; import javax.annotation.Nullable; import java.io.IOException; -import forestry.energy.EnergyManager; import net.minecraft.entity.player.EntityPlayer; import net.minecraft.inventory.Container; import net.minecraft.inventory.IContainerListener; @@ -163,7 +162,7 @@ public class TileEngineBiogas extends TileEngine implements ISidedInventory, ILi FluidStack fuelFluidStack = fuelTank.getFluid(); EngineBronzeFuel fuel = FuelManager.bronzeEngineFuel.get(fuelFluidStack.getFluid()); if (fuel != null) { - loss = loss * fuel.dissipationMultiplier; + loss = loss * fuel.getDissipationMultiplier(); } } @@ -197,7 +196,7 @@ public class TileEngineBiogas extends TileEngine implements ISidedInventory, ILi */ private static int determineFuelValue(Fluid fluid) { if (FuelManager.bronzeEngineFuel.containsKey(fluid)) { - return FuelManager.bronzeEngineFuel.get(fluid).powerPerCycle; + return FuelManager.bronzeEngineFuel.get(fluid).getPowerPerCycle(); } else { return 0; } @@ -208,7 +207,7 @@ public class TileEngineBiogas extends TileEngine implements ISidedInventory, ILi */ private static int determineBurnTime(Fluid fluid) { if (FuelManager.bronzeEngineFuel.containsKey(fluid)) { - return FuelManager.bronzeEngineFuel.get(fluid).burnDuration; + return FuelManager.bronzeEngineFuel.get(fluid).getBurnDuration(); } else { return 0; } diff --git a/src/main/java/forestry/energy/tiles/TileEnginePeat.java b/src/main/java/forestry/energy/tiles/TileEnginePeat.java index 973aa32a7..d54fb3a9f 100644 --- a/src/main/java/forestry/energy/tiles/TileEnginePeat.java +++ b/src/main/java/forestry/energy/tiles/TileEnginePeat.java @@ -122,9 +122,10 @@ public class TileEnginePeat extends TileEngine implements ISidedInventory { if (fuelSlot >= 0 && wasteSlot >= 0) { IInventoryAdapter inventory = getInternalInventory(); - burnTime = totalBurnTime = determineBurnDuration(inventory.getStackInSlot(fuelSlot)); - if (burnTime > 0) { - fuelItem = inventory.getStackInSlot(fuelSlot).getItem(); + ItemStack fuelStack = inventory.getStackInSlot(fuelSlot); + burnTime = totalBurnTime = determineBurnDuration(fuelStack); + if (burnTime > 0 && fuelStack != null) { + fuelItem = fuelStack.getItem(); decrStackSize(fuelSlot, 1); } } @@ -179,10 +180,11 @@ public class TileEnginePeat extends TileEngine implements ISidedInventory { int wasteSlot = getFreeWasteSlot(); if (wasteSlot >= 0) { IInventoryAdapter inventory = getInternalInventory(); - if (inventory.getStackInSlot(wasteSlot) == null) { + ItemStack wasteStack = inventory.getStackInSlot(wasteSlot); + if (wasteStack == null) { inventory.setInventorySlotContents(wasteSlot, PluginCore.items.ash.getItemStack()); } else { - inventory.getStackInSlot(wasteSlot).stackSize++; + wasteStack.stackSize++; } } // Reset @@ -196,7 +198,7 @@ public class TileEnginePeat extends TileEngine implements ISidedInventory { */ private static int determineFuelValue(ItemStack fuel) { if (FuelManager.copperEngineFuel.containsKey(fuel)) { - return FuelManager.copperEngineFuel.get(fuel).powerPerCycle; + return FuelManager.copperEngineFuel.get(fuel).getPowerPerCycle(); } else { return 0; } @@ -207,7 +209,7 @@ public class TileEnginePeat extends TileEngine implements ISidedInventory { */ private static int determineBurnDuration(ItemStack fuel) { if (FuelManager.copperEngineFuel.containsKey(fuel)) { - return FuelManager.copperEngineFuel.get(fuel).burnDuration; + return FuelManager.copperEngineFuel.get(fuel).getBurnDuration(); } else { return 0; } diff --git a/src/main/java/forestry/energy/tiles/TileEuGenerator.java b/src/main/java/forestry/energy/tiles/TileEuGenerator.java index b0891b48d..c9a8b2707 100644 --- a/src/main/java/forestry/energy/tiles/TileEuGenerator.java +++ b/src/main/java/forestry/energy/tiles/TileEuGenerator.java @@ -142,13 +142,13 @@ public class TileEuGenerator extends TileBase implements ISidedInventory, ILiqui if (resourceTank.getFluidAmount() > 0) { GeneratorFuel fuel = FuelManager.generatorFuel.get(resourceTank.getFluid().getFluid()); - if (resourceTank.canDrainFluidType(fuel.fuelConsumed) && ic2EnergySource.getFreeCapacity() >= fuel.eu) { - ic2EnergySource.addEnergy(fuel.eu); + if (resourceTank.canDrainFluidType(fuel.getFuelConsumed()) && ic2EnergySource.getFreeCapacity() >= fuel.getEu()) { + ic2EnergySource.addEnergy(fuel.getEu()); this.tickCount++; - if (tickCount >= fuel.rate) { + if (tickCount >= fuel.getRate()) { tickCount = 0; - resourceTank.drain(fuel.fuelConsumed.amount, true); + resourceTank.drain(fuel.getFuelConsumed().amount, true); } } diff --git a/src/main/java/forestry/factory/recipes/jei/fermenter/FermenterRecipeCategory.java b/src/main/java/forestry/factory/recipes/jei/fermenter/FermenterRecipeCategory.java index 504bd527f..bb3a5bccf 100644 --- a/src/main/java/forestry/factory/recipes/jei/fermenter/FermenterRecipeCategory.java +++ b/src/main/java/forestry/factory/recipes/jei/fermenter/FermenterRecipeCategory.java @@ -21,7 +21,6 @@ import mezz.jei.api.gui.IDrawableStatic; import mezz.jei.api.gui.IGuiFluidStackGroup; import mezz.jei.api.gui.IGuiItemStackGroup; import mezz.jei.api.gui.IRecipeLayout; -import mezz.jei.api.recipe.IRecipeWrapper; public class FermenterRecipeCategory extends ForestryRecipeCategory { @@ -75,7 +74,7 @@ public class FermenterRecipeCategory extends ForestryRecipeCategory fuels = new ArrayList<>(); for (FermenterFuel fuel : FuelManager.fermenterFuel.values()) { - fuels.add(fuel.item); + fuels.add(fuel.getItem()); } guiItemStacks.set(fuelSlot, fuels); diff --git a/src/main/java/forestry/factory/recipes/jei/fermenter/FermenterRecipeWrapper.java b/src/main/java/forestry/factory/recipes/jei/fermenter/FermenterRecipeWrapper.java index 63a88fa9a..1b31818e3 100644 --- a/src/main/java/forestry/factory/recipes/jei/fermenter/FermenterRecipeWrapper.java +++ b/src/main/java/forestry/factory/recipes/jei/fermenter/FermenterRecipeWrapper.java @@ -30,7 +30,7 @@ public class FermenterRecipeWrapper extends ForestryRecipeWrapper inputs = new ArrayList<>(); for (FermenterFuel fuel : FuelManager.fermenterFuel.values()) { - inputs.add(fuel.item); + inputs.add(fuel.getItem()); } inputs.add(fermentable); return inputs; diff --git a/src/main/java/forestry/factory/recipes/jei/moistener/MoistenerRecipeCategory.java b/src/main/java/forestry/factory/recipes/jei/moistener/MoistenerRecipeCategory.java index 6469c8435..0ec09de83 100644 --- a/src/main/java/forestry/factory/recipes/jei/moistener/MoistenerRecipeCategory.java +++ b/src/main/java/forestry/factory/recipes/jei/moistener/MoistenerRecipeCategory.java @@ -74,10 +74,10 @@ public class MoistenerRecipeCategory extends ForestryRecipeCategory { MoistenerRecipeWrapper wrapper = (MoistenerRecipeWrapper) recipeWrapper; guiItemStacks.set(resourceSlot, wrapper.getRecipe().getResource()); - guiItemStacks.set(fuelItemSlot, wrapper.getFuel().item); + guiItemStacks.set(fuelItemSlot, wrapper.getFuel().getItem()); guiItemStacks.set(productSlot, wrapper.getRecipe().getProduct()); - guiItemStacks.set(fuelProductSlot, wrapper.getFuel().product); + guiItemStacks.set(fuelProductSlot, wrapper.getFuel().getProduct()); guiFluidStacks.set(inputTank, FluidRegistry.getFluidStack("water", 10000)); diff --git a/src/main/java/forestry/factory/recipes/jei/moistener/MoistenerRecipeHandler.java b/src/main/java/forestry/factory/recipes/jei/moistener/MoistenerRecipeHandler.java index da9f78b75..58037640f 100644 --- a/src/main/java/forestry/factory/recipes/jei/moistener/MoistenerRecipeHandler.java +++ b/src/main/java/forestry/factory/recipes/jei/moistener/MoistenerRecipeHandler.java @@ -46,7 +46,7 @@ public class MoistenerRecipeHandler implements IRecipeHandler getInputs() { List inputs = new ArrayList<>(); inputs.add(getRecipe().getResource()); - if (fuel.item != null) { - inputs.add(fuel.item); + if (fuel.getItem() != null) { + inputs.add(fuel.getItem()); } return inputs; } @@ -36,8 +36,8 @@ public class MoistenerRecipeWrapper extends ForestryRecipeWrapper getOutputs() { List outputs = new ArrayList<>(); outputs.add(getRecipe().getProduct()); - if (fuel.product != null) { - outputs.add(fuel.product); + if (fuel.getProduct() != null) { + outputs.add(fuel.getProduct()); } return outputs; } diff --git a/src/main/java/forestry/factory/tiles/TileFermenter.java b/src/main/java/forestry/factory/tiles/TileFermenter.java index 84a2057e1..d03e4eb7b 100644 --- a/src/main/java/forestry/factory/tiles/TileFermenter.java +++ b/src/main/java/forestry/factory/tiles/TileFermenter.java @@ -180,8 +180,8 @@ public class TileFermenter extends TilePowered implements ISidedInventory, ILiqu return; } - fuelBurnTime = fuelTotalTime = fermenterFuel.burnDuration; - fuelCurrentFerment = fermenterFuel.fermentPerCycle; + fuelBurnTime = fuelTotalTime = fermenterFuel.getBurnDuration(); + fuelCurrentFerment = fermenterFuel.getFermentPerCycle(); decrStackSize(InventoryFermenter.SLOT_FUEL, 1); } diff --git a/src/main/java/forestry/factory/tiles/TileMoistener.java b/src/main/java/forestry/factory/tiles/TileMoistener.java index 162150eec..0d6c3e6ad 100644 --- a/src/main/java/forestry/factory/tiles/TileMoistener.java +++ b/src/main/java/forestry/factory/tiles/TileMoistener.java @@ -201,7 +201,7 @@ public class TileMoistener extends TileBase implements ISidedInventory, ILiquidT if (FuelManager.moistenerResource.containsKey(getStackInSlot(InventoryMoistener.SLOT_WORKING))) { MoistenerFuel res = FuelManager.moistenerResource.get(getStackInSlot(InventoryMoistener.SLOT_WORKING)); - burnTime = totalTime = res.moistenerValue; + burnTime = totalTime = res.getMoistenerValue(); } } else { rotateReservoir(); @@ -302,8 +302,8 @@ public class TileMoistener extends TileBase implements ISidedInventory, ILiquidT } MoistenerFuel res = FuelManager.moistenerResource.get(slotStack); - if (stage < 0 || res.stage < stage) { - stage = res.stage; + if (stage < 0 || res.getStage() < stage) { + stage = res.getStage(); resourceSlot = i; } } @@ -320,7 +320,7 @@ public class TileMoistener extends TileBase implements ISidedInventory, ILiquidT ItemStack deposit; if (FuelManager.moistenerResource.containsKey(getStackInSlot(InventoryMoistener.SLOT_WORKING))) { MoistenerFuel res = FuelManager.moistenerResource.get(getStackInSlot(InventoryMoistener.SLOT_WORKING)); - deposit = res.product.copy(); + deposit = res.getProduct().copy(); } else { deposit = getStackInSlot(InventoryMoistener.SLOT_WORKING).copy(); } @@ -423,7 +423,7 @@ public class TileMoistener extends TileBase implements ISidedInventory, ILiquidT } if (FuelManager.moistenerResource.containsKey(inventory.getStackInSlot(i))) { MoistenerFuel res = FuelManager.moistenerResource.get(inventory.getStackInSlot(i)); - if (res.item.isItemEqual(inventory.getStackInSlot(i))) { + if (res.getItem().isItemEqual(inventory.getStackInSlot(i))) { max += 64; avail += inventory.getStackInSlot(i).stackSize; }