From cd10bc88c8547e60b028d557994e6aef3d7f2a05 Mon Sep 17 00:00:00 2001 From: Ben Spiers Date: Tue, 8 Jul 2014 02:48:18 +0100 Subject: [PATCH] Updates for changed IC2 API. Not sure if I'll be able to use @Optional with the new non-legacy BC MJ API as it uses Annotations instead of interfaces. --- src/api/java/ic2/api/energy/EnergyNet.java | 18 +++++ src/api/java/ic2/api/energy/IEnergyNet.java | 72 +++++++++++++++++++ .../java/mekanism/common/EnergyNetwork.java | 9 +-- .../mekanism/common/entity/EntityRobit.java | 2 +- .../common/integration/IC2ItemManager.java | 10 +-- .../common/item/ItemBlockEnergyCube.java | 4 +- .../common/item/ItemBlockMachine.java | 6 +- .../mekanism/common/item/ItemEnergized.java | 4 +- .../mekanism/common/item/ItemFreeRunners.java | 4 +- .../tile/TileEntityAdvancedBoundingBlock.java | 12 ++-- .../common/tile/TileEntityElectricBlock.java | 8 +-- .../java/mekanism/common/util/CableUtils.java | 5 +- .../mekanism/common/util/ChargeUtils.java | 2 +- .../common/item/ItemBlockGenerator.java | 4 +- 14 files changed, 126 insertions(+), 34 deletions(-) create mode 100644 src/api/java/ic2/api/energy/EnergyNet.java create mode 100644 src/api/java/ic2/api/energy/IEnergyNet.java diff --git a/src/api/java/ic2/api/energy/EnergyNet.java b/src/api/java/ic2/api/energy/EnergyNet.java new file mode 100644 index 000000000..822bfc297 --- /dev/null +++ b/src/api/java/ic2/api/energy/EnergyNet.java @@ -0,0 +1,18 @@ +package ic2.api.energy; + + +/** + * Provides access to the energy network. + * + * The old EnergyNet methods missing in IEnergyNet have been migrated to events (load, unload) or + * removed (tiles no longer emit energy actively, the energy net implementation requests it). + * + * See ic2/api/energy/usage.txt for an overall description of the energy net api. + */ +public final class EnergyNet { + /** + * Instance of the global EnergyNet class. + */ + public static IEnergyNet instance; +} + diff --git a/src/api/java/ic2/api/energy/IEnergyNet.java b/src/api/java/ic2/api/energy/IEnergyNet.java new file mode 100644 index 000000000..4d07b9838 --- /dev/null +++ b/src/api/java/ic2/api/energy/IEnergyNet.java @@ -0,0 +1,72 @@ +package ic2.api.energy; + +import net.minecraft.tileentity.TileEntity; +import net.minecraft.world.World; + +import net.minecraftforge.common.util.ForgeDirection; + +/** + * Interface representing the methods provided by the global EnergyNet class. + * + * See ic2/api/energy/usage.txt for an overall description of the energy net api. + */ +public interface IEnergyNet { + /** + * Get the EnergyNet-registered tile entity at the specified position. + * + * This is not the same as World.getTileEntity(), it's possible to register delegate tile + * entities with the energy net which are different from what's actually in the world. Those + * delegates allow to use separate TileEntity objects just for the EnergyNet interfaces, + * simplifying cross-mod dependencies and multi-blocks. + * + * @param world World containing the tile entity + * @param x x-coordinate + * @param y y-coordinate + * @param z z-coordinate + * @return tile entity registered to the energy net or null if none is registered + */ + TileEntity getTileEntity(World world, int x, int y, int z); + + /** + * Get the EnergyNet-registered neighbor tile entity at the specified position. + * + * @param te TileEntity indicating the world and position to search from + * @param dir direction the neighbor is to be found + * @return neighbor tile entity registered to the energy net or null if none is registered + */ + TileEntity getNeighbor(TileEntity te, ForgeDirection dir); + + /** + * determine how much energy has been emitted by the EnergyEmitter specified + * + * @note call this twice with x ticks delay to get the avg. emitted power p = (call2 - call1) / x EU/tick + * + * @param tileEntity energy emitter + */ + double getTotalEnergyEmitted(TileEntity tileEntity); + + /** + * determine how much energy has been sunken by the EnergySink specified + * + * @note call this twice with x ticks delay to get the avg. sunken power p = (call2 - call1) / x EU/tick + * + * @param tileEntity energy emitter + */ + double getTotalEnergySunken(TileEntity tileEntity); + + /** + * Determine the typical power used by the specific tier, e.g. 128 eu/t for tier 2. + * + * @param tier tier + * @return power in eu/t + */ + double getPowerFromTier(int tier); + + /** + * Determine minimum tier required to handle the specified power, e.g. tier 2 for 128 eu/t. + * + * @param power in eu/t + * @return tier + */ + int getTierFromPower(double power); +} diff --git a/src/main/java/mekanism/common/EnergyNetwork.java b/src/main/java/mekanism/common/EnergyNetwork.java index da46c5772..11b012149 100644 --- a/src/main/java/mekanism/common/EnergyNetwork.java +++ b/src/main/java/mekanism/common/EnergyNetwork.java @@ -1,5 +1,6 @@ package mekanism.common; +import ic2.api.energy.EnergyNet; import ic2.api.energy.tile.IEnergySink; import java.util.Arrays; @@ -210,9 +211,9 @@ public class EnergyNetwork extends DynamicNetwork } else if(MekanismUtils.useIC2() && acceptor instanceof IEnergySink) { - double toSend = Math.min(currentSending, ((IEnergySink)acceptor).getMaxSafeInput()*Mekanism.FROM_IC2); - toSend = Math.min(toSend, ((IEnergySink)acceptor).demandedEnergyUnits()*Mekanism.FROM_IC2); - sent += (toSend - (((IEnergySink)acceptor).injectEnergyUnits(side.getOpposite(), toSend*Mekanism.TO_IC2)*Mekanism.FROM_IC2)); + double toSend = Math.min(currentSending, EnergyNet.instance.getPowerFromTier(((IEnergySink) acceptor).getSinkTier())*Mekanism.FROM_IC2); + toSend = Math.min(toSend, ((IEnergySink)acceptor).getDemandedEnergy()*Mekanism.FROM_IC2); + sent += (toSend - (((IEnergySink)acceptor).injectEnergy(side.getOpposite(), toSend*Mekanism.TO_IC2, 0)*Mekanism.FROM_IC2)); } else if(MekanismUtils.useBuildCraft() && acceptor instanceof IPowerReceptor) { @@ -280,7 +281,7 @@ public class EnergyNetwork extends DynamicNetwork if(handler.acceptsEnergyFrom(null, side.getOpposite())) { - if(Math.min((handler.demandedEnergyUnits()*Mekanism.FROM_IC2), (handler.getMaxSafeInput()*Mekanism.FROM_IC2)) > 0) + if(Math.min((handler.getDemandedEnergy()*Mekanism.FROM_IC2), (EnergyNet.instance.getPowerFromTier(handler.getSinkTier())*Mekanism.FROM_IC2)) > 0) { toReturn.add(acceptor); } diff --git a/src/main/java/mekanism/common/entity/EntityRobit.java b/src/main/java/mekanism/common/entity/EntityRobit.java index 0e6788ce4..669e53650 100644 --- a/src/main/java/mekanism/common/entity/EntityRobit.java +++ b/src/main/java/mekanism/common/entity/EntityRobit.java @@ -182,7 +182,7 @@ public class EntityRobit extends EntityCreature implements IInventory, ISustaine if(item.canProvideEnergy(inventory[27])) { - double gain = ElectricItem.manager.discharge(inventory[27], (int)((MAX_ELECTRICITY - getEnergy())*Mekanism.TO_IC2), 4, true, false)*Mekanism.FROM_IC2; + double gain = ElectricItem.manager.discharge(inventory[27], (MAX_ELECTRICITY - getEnergy())*Mekanism.TO_IC2, 4, true, true, false)*Mekanism.FROM_IC2; setEnergy(getEnergy() + gain); } } diff --git a/src/main/java/mekanism/common/integration/IC2ItemManager.java b/src/main/java/mekanism/common/integration/IC2ItemManager.java index be347b5c4..93fb6bbb2 100644 --- a/src/main/java/mekanism/common/integration/IC2ItemManager.java +++ b/src/main/java/mekanism/common/integration/IC2ItemManager.java @@ -19,7 +19,7 @@ public class IC2ItemManager implements IElectricItemManager } @Override - public int charge(ItemStack itemStack, int amount, int tier, boolean ignoreTransferLimit, boolean simulate) + public double charge(ItemStack itemStack, double amount, int tier, boolean ignoreTransferLimit, boolean simulate) { if(energizedItem.canReceive(itemStack)) { @@ -38,7 +38,7 @@ public class IC2ItemManager implements IElectricItemManager } @Override - public int discharge(ItemStack itemStack, int amount, int tier, boolean ignoreTransferLimit, boolean simulate) + public double discharge(ItemStack itemStack, double amount, int tier, boolean ignoreTransferLimit, boolean external, boolean simulate) { if(energizedItem.canSend(itemStack)) { @@ -57,19 +57,19 @@ public class IC2ItemManager implements IElectricItemManager } @Override - public boolean canUse(ItemStack itemStack, int amount) + public boolean canUse(ItemStack itemStack, double amount) { return energizedItem.getEnergy(itemStack) >= amount*Mekanism.FROM_IC2; } @Override - public int getCharge(ItemStack itemStack) + public double getCharge(ItemStack itemStack) { return (int)Math.round(energizedItem.getEnergy(itemStack)*Mekanism.TO_IC2); } @Override - public boolean use(ItemStack itemStack, int amount, EntityLivingBase entity) + public boolean use(ItemStack itemStack, double amount, EntityLivingBase entity) { return false; } diff --git a/src/main/java/mekanism/common/item/ItemBlockEnergyCube.java b/src/main/java/mekanism/common/item/ItemBlockEnergyCube.java index 0db6c6306..6d582bb90 100644 --- a/src/main/java/mekanism/common/item/ItemBlockEnergyCube.java +++ b/src/main/java/mekanism/common/item/ItemBlockEnergyCube.java @@ -142,7 +142,7 @@ public class ItemBlockEnergyCube extends ItemBlock implements IEnergizedItem, IE @Override @Method(modid = "IC2API") - public int getMaxCharge(ItemStack itemStack) + public double getMaxCharge(ItemStack itemStack) { return 0; } @@ -156,7 +156,7 @@ public class ItemBlockEnergyCube extends ItemBlock implements IEnergizedItem, IE @Override @Method(modid = "IC2API") - public int getTransferLimit(ItemStack itemStack) + public double getTransferLimit(ItemStack itemStack) { return 0; } diff --git a/src/main/java/mekanism/common/item/ItemBlockMachine.java b/src/main/java/mekanism/common/item/ItemBlockMachine.java index cf58f8e56..cd0a25a66 100644 --- a/src/main/java/mekanism/common/item/ItemBlockMachine.java +++ b/src/main/java/mekanism/common/item/ItemBlockMachine.java @@ -401,7 +401,7 @@ public class ItemBlockMachine extends ItemBlock implements IEnergizedItem, ISpec @Override @Method(modid = "IC2API") - public int getMaxCharge(ItemStack itemStack) + public double getMaxCharge(ItemStack itemStack) { return 0; } @@ -415,7 +415,7 @@ public class ItemBlockMachine extends ItemBlock implements IEnergizedItem, ISpec @Override @Method(modid = "IC2API") - public int getTransferLimit(ItemStack itemStack) + public double getTransferLimit(ItemStack itemStack) { return 0; } @@ -443,7 +443,7 @@ public class ItemBlockMachine extends ItemBlock implements IEnergizedItem, ISpec if(item.canProvideEnergy(inv.getStackInSlot(54))) { - double gain = ElectricItem.manager.discharge(inv.getStackInSlot(54), (int)((getMaxEnergy(itemstack) - getEnergy(itemstack))*Mekanism.TO_IC2), 3, false, false)*Mekanism.FROM_IC2; + double gain = ElectricItem.manager.discharge(inv.getStackInSlot(54), (int)((getMaxEnergy(itemstack) - getEnergy(itemstack))*Mekanism.TO_IC2), 3, false, true, false)*Mekanism.FROM_IC2; setEnergy(itemstack, getEnergy(itemstack) + gain); } } diff --git a/src/main/java/mekanism/common/item/ItemEnergized.java b/src/main/java/mekanism/common/item/ItemEnergized.java index e134f4c1a..73104f1d7 100644 --- a/src/main/java/mekanism/common/item/ItemEnergized.java +++ b/src/main/java/mekanism/common/item/ItemEnergized.java @@ -87,7 +87,7 @@ public class ItemEnergized extends ItemMekanism implements IEnergizedItem, ISpec @Override @Method(modid = "IC2API") - public int getMaxCharge(ItemStack itemStack) + public double getMaxCharge(ItemStack itemStack) { return 0; } @@ -101,7 +101,7 @@ public class ItemEnergized extends ItemMekanism implements IEnergizedItem, ISpec @Override @Method(modid = "IC2API") - public int getTransferLimit(ItemStack itemStack) + public double getTransferLimit(ItemStack itemStack) { return 0; } diff --git a/src/main/java/mekanism/common/item/ItemFreeRunners.java b/src/main/java/mekanism/common/item/ItemFreeRunners.java index e54bf4760..b0f6cd567 100644 --- a/src/main/java/mekanism/common/item/ItemFreeRunners.java +++ b/src/main/java/mekanism/common/item/ItemFreeRunners.java @@ -126,7 +126,7 @@ public class ItemFreeRunners extends ItemArmor implements IEnergizedItem, ISpeci @Override @Method(modid = "IC2API") - public int getMaxCharge(ItemStack itemStack) + public double getMaxCharge(ItemStack itemStack) { return 0; } @@ -140,7 +140,7 @@ public class ItemFreeRunners extends ItemArmor implements IEnergizedItem, ISpeci @Override @Method(modid = "IC2API") - public int getTransferLimit(ItemStack itemStack) + public double getTransferLimit(ItemStack itemStack) { return 0; } diff --git a/src/main/java/mekanism/common/tile/TileEntityAdvancedBoundingBlock.java b/src/main/java/mekanism/common/tile/TileEntityAdvancedBoundingBlock.java index 6695ad773..790593fff 100644 --- a/src/main/java/mekanism/common/tile/TileEntityAdvancedBoundingBlock.java +++ b/src/main/java/mekanism/common/tile/TileEntityAdvancedBoundingBlock.java @@ -359,38 +359,38 @@ public class TileEntityAdvancedBoundingBlock extends TileEntityBoundingBlock imp @Override @Method(modid = "IC2API") - public double demandedEnergyUnits() + public double getDemandedEnergy() { if(getInv() == null) { return 0; } - return getInv().demandedEnergyUnits(); + return getInv().getDemandedEnergy(); } @Override @Method(modid = "IC2API") - public double injectEnergyUnits(ForgeDirection directionFrom, double amount) + public double injectEnergy(ForgeDirection directionFrom, double amount, double voltage) { if(getInv() == null) { return amount; } - return getInv().injectEnergyUnits(directionFrom, amount); + return getInv().injectEnergy(directionFrom, amount, voltage); } @Override @Method(modid = "IC2API") - public int getMaxSafeInput() + public int getSinkTier() { if(getInv() == null) { return 0; } - return getInv().getMaxSafeInput(); + return getInv().getSinkTier(); } public IAdvancedBoundingBlock getInv() diff --git a/src/main/java/mekanism/common/tile/TileEntityElectricBlock.java b/src/main/java/mekanism/common/tile/TileEntityElectricBlock.java index 25d5b3c37..d4e426cde 100644 --- a/src/main/java/mekanism/common/tile/TileEntityElectricBlock.java +++ b/src/main/java/mekanism/common/tile/TileEntityElectricBlock.java @@ -308,9 +308,9 @@ public abstract class TileEntityElectricBlock extends TileEntityContainerBlock i @Override @Method(modid = "IC2API") - public int getMaxSafeInput() + public int getSinkTier() { - return Integer.MAX_VALUE; + return 4; } @Override @@ -371,7 +371,7 @@ public abstract class TileEntityElectricBlock extends TileEntityContainerBlock i @Override @Method(modid = "IC2API") - public double demandedEnergyUnits() + public double getDemandedEnergy() { return (getMaxEnergy() - getEnergy())*Mekanism.TO_IC2; } @@ -391,7 +391,7 @@ public abstract class TileEntityElectricBlock extends TileEntityContainerBlock i @Override @Method(modid = "IC2API") - public double injectEnergyUnits(ForgeDirection direction, double i) + public double injectEnergy(ForgeDirection direction, double i, double v) { if(Coord4D.get(this).getFromSide(direction).getTileEntity(worldObj) instanceof IGridTransmitter) { diff --git a/src/main/java/mekanism/common/util/CableUtils.java b/src/main/java/mekanism/common/util/CableUtils.java index 563e456bb..743958caa 100644 --- a/src/main/java/mekanism/common/util/CableUtils.java +++ b/src/main/java/mekanism/common/util/CableUtils.java @@ -1,5 +1,6 @@ package mekanism.common.util; +import ic2.api.energy.EnergyNet; import ic2.api.energy.tile.IEnergyAcceptor; import ic2.api.energy.tile.IEnergySink; import ic2.api.energy.tile.IEnergySource; @@ -319,8 +320,8 @@ public final class CableUtils { if(((IEnergySink)tileEntity).acceptsEnergyFrom(from, side.getOpposite())) { - double toSend = Math.min(sendingEnergy, Math.min(((IEnergySink)tileEntity).getMaxSafeInput(), ((IEnergySink)tileEntity).demandedEnergyUnits())*Mekanism.FROM_IC2); - double rejects = ((IEnergySink)tileEntity).injectEnergyUnits(side.getOpposite(), toSend*Mekanism.TO_IC2)*Mekanism.FROM_IC2; + double toSend = Math.min(sendingEnergy, Math.min(EnergyNet.instance.getPowerFromTier(((IEnergySink) tileEntity).getSinkTier()), ((IEnergySink)tileEntity).getDemandedEnergy())*Mekanism.FROM_IC2); + double rejects = ((IEnergySink)tileEntity).injectEnergy(side.getOpposite(), toSend*Mekanism.TO_IC2, 0)*Mekanism.FROM_IC2; sent += (toSend - rejects); } } diff --git a/src/main/java/mekanism/common/util/ChargeUtils.java b/src/main/java/mekanism/common/util/ChargeUtils.java index 3bd5a07c3..aa6c5dadb 100644 --- a/src/main/java/mekanism/common/util/ChargeUtils.java +++ b/src/main/java/mekanism/common/util/ChargeUtils.java @@ -31,7 +31,7 @@ public final class ChargeUtils if(item.canProvideEnergy(storer.inventory[slotID])) { - double gain = ElectricItem.manager.discharge(storer.inventory[slotID], (int)((storer.getMaxEnergy() - storer.getEnergy())*Mekanism.TO_IC2), 4, true, false)*Mekanism.FROM_IC2; + double gain = ElectricItem.manager.discharge(storer.inventory[slotID], (int)((storer.getMaxEnergy() - storer.getEnergy())*Mekanism.TO_IC2), 4, true, true, false)*Mekanism.FROM_IC2; storer.setEnergy(storer.getEnergy() + gain); } } diff --git a/src/main/java/mekanism/generators/common/item/ItemBlockGenerator.java b/src/main/java/mekanism/generators/common/item/ItemBlockGenerator.java index b77d80072..33e373e8f 100644 --- a/src/main/java/mekanism/generators/common/item/ItemBlockGenerator.java +++ b/src/main/java/mekanism/generators/common/item/ItemBlockGenerator.java @@ -207,7 +207,7 @@ public class ItemBlockGenerator extends ItemBlock implements IEnergizedItem, ISp @Override @Method(modid = "IC2API") - public int getMaxCharge(ItemStack itemStack) + public double getMaxCharge(ItemStack itemStack) { return 0; } @@ -221,7 +221,7 @@ public class ItemBlockGenerator extends ItemBlock implements IEnergizedItem, ISp @Override @Method(modid = "IC2API") - public int getTransferLimit(ItemStack itemStack) + public double getTransferLimit(ItemStack itemStack) { return 0; }