Updated to the official RF-Api for 1.8

This commit is contained in:
canitzp 2016-02-16 21:49:44 +01:00
parent 8bdf350a4d
commit 6819c6b34b
11 changed files with 36 additions and 75 deletions

View file

@ -6,6 +6,6 @@ public class CoFHAPIProps {
} }
public static final String VERSION = "1.7.10R1.0.2"; public static final String VERSION = "1.8.9R1.2.0B1";
} }

View file

@ -51,29 +51,33 @@ public class EnergyStorage implements IEnergyStorage {
return nbt; return nbt;
} }
public void setCapacity(int capacity) { public EnergyStorage setCapacity(int capacity) {
this.capacity = capacity; this.capacity = capacity;
if (energy > capacity) { if (energy > capacity) {
energy = capacity; energy = capacity;
} }
return this;
} }
public void setMaxTransfer(int maxTransfer) { public EnergyStorage setMaxTransfer(int maxTransfer) {
setMaxReceive(maxTransfer); setMaxReceive(maxTransfer);
setMaxExtract(maxTransfer); setMaxExtract(maxTransfer);
return this;
} }
public void setMaxReceive(int maxReceive) { public EnergyStorage setMaxReceive(int maxReceive) {
this.maxReceive = maxReceive; this.maxReceive = maxReceive;
return this;
} }
public void setMaxExtract(int maxExtract) { public EnergyStorage setMaxExtract(int maxExtract) {
this.maxExtract = maxExtract; this.maxExtract = maxExtract;
return this;
} }
public int getMaxReceive() { public int getMaxReceive() {
@ -87,7 +91,7 @@ public class EnergyStorage implements IEnergyStorage {
} }
/** /**
* This function is included to allow for server -> client sync. Do not call this externally to the containing Tile Entity, as not all IEnergyHandlers * This function is included to allow for server to client sync. Do not call this externally to the containing Tile Entity, as not all IEnergyHandlers
* are guaranteed to have it. * are guaranteed to have it.
* *
* @param energy * @param energy

View file

@ -2,6 +2,7 @@ package cofh.api.energy;
import net.minecraft.util.EnumFacing; import net.minecraft.util.EnumFacing;
/** /**
* Implement this interface on TileEntities which should connect to energy transportation blocks. This is intended for blocks which generate energy but do not * Implement this interface on TileEntities which should connect to energy transportation blocks. This is intended for blocks which generate energy but do not
* accept it; otherwise just use IEnergyHandler. * accept it; otherwise just use IEnergyHandler.

View file

@ -6,53 +6,22 @@ import net.minecraft.util.EnumFacing;
* Implement this interface on Tile Entities which should handle energy, generally storing it in one or more internal {@link IEnergyStorage} objects. * Implement this interface on Tile Entities which should handle energy, generally storing it in one or more internal {@link IEnergyStorage} objects.
* <p> * <p>
* A reference implementation is provided {@link TileEnergyHandler}. * A reference implementation is provided {@link TileEnergyHandler}.
* <p>
* Note that {@link IEnergyReceiver} and {@link IEnergyProvider} are extensions of this.
* *
* @author King Lemming * @author King Lemming
* *
*/ */
public interface IEnergyHandler extends IEnergyProvider, IEnergyReceiver { public interface IEnergyHandler extends IEnergyConnection {
// merely a convenience interface (remove these methods in 1.8; provided here for back-compat via compiler doing things)
/**
* Add energy to an IEnergyReceiver, internal distribution is left entirely to the IEnergyReceiver.
*
* @param from
* Orientation the energy is received from.
* @param maxReceive
* Maximum amount of energy to receive.
* @param simulate
* If TRUE, the charge will only be simulated.
* @return Amount of energy that was (or would have been, if simulated) received.
*/
@Override
int receiveEnergy(EnumFacing from, int maxReceive, boolean simulate);
/**
* Remove energy from an IEnergyProvider, internal distribution is left entirely to the IEnergyProvider.
*
* @param from
* Orientation the energy is extracted from.
* @param maxExtract
* Maximum amount of energy to extract.
* @param simulate
* If TRUE, the extraction will only be simulated.
* @return Amount of energy that was (or would have been, if simulated) extracted.
*/
@Override
int extractEnergy(EnumFacing from, int maxExtract, boolean simulate);
/** /**
* Returns the amount of energy currently stored. * Returns the amount of energy currently stored.
*/ */
@Override
int getEnergyStored(EnumFacing from); int getEnergyStored(EnumFacing from);
/** /**
* Returns the maximum amount of energy that can be stored. * Returns the maximum amount of energy that can be stored.
*/ */
@Override
int getMaxEnergyStored(EnumFacing from); int getMaxEnergyStored(EnumFacing from);
} }

View file

@ -2,6 +2,7 @@ package cofh.api.energy;
import net.minecraft.util.EnumFacing; import net.minecraft.util.EnumFacing;
/** /**
* Implement this interface on Tile Entities which should provide energy, generally storing it in one or more internal {@link IEnergyStorage} objects. * Implement this interface on Tile Entities which should provide energy, generally storing it in one or more internal {@link IEnergyStorage} objects.
* <p> * <p>
@ -10,7 +11,7 @@ import net.minecraft.util.EnumFacing;
* @author King Lemming * @author King Lemming
* *
*/ */
public interface IEnergyProvider extends IEnergyConnection { public interface IEnergyProvider extends IEnergyHandler {
/** /**
* Remove energy from an IEnergyProvider, internal distribution is left entirely to the IEnergyProvider. * Remove energy from an IEnergyProvider, internal distribution is left entirely to the IEnergyProvider.
@ -25,14 +26,4 @@ public interface IEnergyProvider extends IEnergyConnection {
*/ */
int extractEnergy(EnumFacing from, int maxExtract, boolean simulate); int extractEnergy(EnumFacing from, int maxExtract, boolean simulate);
/**
* Returns the amount of energy currently stored.
*/
int getEnergyStored(EnumFacing from);
/**
* Returns the maximum amount of energy that can be stored.
*/
int getMaxEnergyStored(EnumFacing from);
} }

View file

@ -2,6 +2,7 @@ package cofh.api.energy;
import net.minecraft.util.EnumFacing; import net.minecraft.util.EnumFacing;
/** /**
* Implement this interface on Tile Entities which should receive energy, generally storing it in one or more internal {@link IEnergyStorage} objects. * Implement this interface on Tile Entities which should receive energy, generally storing it in one or more internal {@link IEnergyStorage} objects.
* <p> * <p>
@ -10,7 +11,7 @@ import net.minecraft.util.EnumFacing;
* @author King Lemming * @author King Lemming
* *
*/ */
public interface IEnergyReceiver extends IEnergyConnection { public interface IEnergyReceiver extends IEnergyHandler {
/** /**
* Add energy to an IEnergyReceiver, internal distribution is left entirely to the IEnergyReceiver. * Add energy to an IEnergyReceiver, internal distribution is left entirely to the IEnergyReceiver.
@ -25,14 +26,4 @@ public interface IEnergyReceiver extends IEnergyConnection {
*/ */
int receiveEnergy(EnumFacing from, int maxReceive, boolean simulate); int receiveEnergy(EnumFacing from, int maxReceive, boolean simulate);
/**
* Returns the amount of energy currently stored.
*/
int getEnergyStored(EnumFacing from);
/**
* Returns the maximum amount of energy that can be stored.
*/
int getMaxEnergyStored(EnumFacing from);
} }

View file

@ -43,27 +43,30 @@ public class ItemEnergyContainer extends Item implements IEnergyContainerItem {
return this; return this;
} }
public void setMaxTransfer(int maxTransfer) { public ItemEnergyContainer setMaxTransfer(int maxTransfer) {
setMaxReceive(maxTransfer); setMaxReceive(maxTransfer);
setMaxExtract(maxTransfer); setMaxExtract(maxTransfer);
return this;
} }
public void setMaxReceive(int maxReceive) { public ItemEnergyContainer setMaxReceive(int maxReceive) {
this.maxReceive = maxReceive; this.maxReceive = maxReceive;
return this;
} }
public void setMaxExtract(int maxExtract) { public ItemEnergyContainer setMaxExtract(int maxExtract) {
this.maxExtract = maxExtract; this.maxExtract = maxExtract;
return this;
} }
/* IEnergyContainerItem */ /* IEnergyContainerItem */
@Override @Override
public int receiveEnergy(ItemStack container, int maxReceive, boolean simulate) { public int receiveEnergy(ItemStack container, int maxReceive, boolean simulate) {
if (container.getTagCompound() == null) { if (!container.hasTagCompound()) {
container.setTagCompound(new NBTTagCompound()); container.setTagCompound(new NBTTagCompound());
} }
int energy = container.getTagCompound().getInteger("Energy"); int energy = container.getTagCompound().getInteger("Energy");

View file

@ -5,12 +5,14 @@ import net.minecraft.tileentity.TileEntity;
import net.minecraft.util.EnumFacing; import net.minecraft.util.EnumFacing;
/** /**
* Reference implementation of {@link IEnergyHandler}. Use/extend this or implement your own. * Reference implementation of {@link IEnergyReceiver} and {@link IEnergyProvider}. Use/extend this or implement your own.
*
* This class is really meant to summarize how each interface is properly used.
* *
* @author King Lemming * @author King Lemming
* *
*/ */
public class TileEnergyHandler extends TileEntity implements IEnergyHandler { public class TileEnergyHandler extends TileEntity implements IEnergyReceiver, IEnergyProvider {
protected EnergyStorage storage = new EnergyStorage(32000); protected EnergyStorage storage = new EnergyStorage(32000);
@ -49,7 +51,7 @@ public class TileEnergyHandler extends TileEntity implements IEnergyHandler {
return storage.extractEnergy(maxExtract, simulate); return storage.extractEnergy(maxExtract, simulate);
} }
/* IEnergyReceiver and IEnergyProvider */ /* IEnergyHandler */
@Override @Override
public int getEnergyStored(EnumFacing from) { public int getEnergyStored(EnumFacing from) {

View file

@ -1,10 +1,10 @@
/** /**
* (C) 2014 Team CoFH / CoFH / Cult of the Full Hub * (C) 2014-2016 Team CoFH / CoFH / Cult of the Full Hub
* http://www.teamcofh.com * http://www.teamcofh.com
*/ */
@API(apiVersion = CoFHAPIProps.VERSION, owner = "CoFHAPI", provides = "CoFHAPI|energy") @API(apiVersion = CoFHAPIProps.VERSION, owner = "CoFHAPI", provides = "CoFHAPI|energy")
package cofh.api.energy; package cofh.api.energy;
import cofh.api.CoFHAPIProps;
import net.minecraftforge.fml.common.API; import net.minecraftforge.fml.common.API;
import cofh.api.CoFHAPIProps;

View file

@ -1,8 +1,9 @@
/** /**
* (C) 2014 Team CoFH / CoFH / Cult of the Full Hub * (C) 2014-2016 Team CoFH / CoFH / Cult of the Full Hub
* http://www.teamcofh.com * http://www.teamcofh.com
*/ */
@API(apiVersion = CoFHAPIProps.VERSION, owner = "CoFHLib", provides = "CoFHAPI") @API(apiVersion = CoFHAPIProps.VERSION, owner = "CoFHLib", provides = "CoFHAPI")
package cofh.api; package cofh.api;
import net.minecraftforge.fml.common.API; import net.minecraftforge.fml.common.API;

View file

@ -10,7 +10,6 @@
package de.ellpeck.actuallyadditions.mod.tile; package de.ellpeck.actuallyadditions.mod.tile;
import cofh.api.energy.IEnergyHandler;
import cofh.api.energy.IEnergyProvider; import cofh.api.energy.IEnergyProvider;
import cofh.api.energy.IEnergyReceiver; import cofh.api.energy.IEnergyReceiver;
import de.ellpeck.actuallyadditions.mod.blocks.BlockPhantom; import de.ellpeck.actuallyadditions.mod.blocks.BlockPhantom;
@ -18,7 +17,7 @@ import de.ellpeck.actuallyadditions.mod.util.WorldUtil;
import net.minecraft.tileentity.TileEntity; import net.minecraft.tileentity.TileEntity;
import net.minecraft.util.EnumFacing; import net.minecraft.util.EnumFacing;
public class TileEntityPhantomEnergyface extends TileEntityPhantomface implements IEnergyHandler{ public class TileEntityPhantomEnergyface extends TileEntityPhantomface implements IEnergyReceiver, IEnergyProvider{
public TileEntityPhantomEnergyface(){ public TileEntityPhantomEnergyface(){
super("energyface"); super("energyface");