57 lines
1.8 KiB
Java
57 lines
1.8 KiB
Java
|
package cofh.api.energy;
|
||
|
|
|
||
|
|
import net.minecraftforge.common.ForgeDirection;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Implement this interface on TileEntities which should handle energy, generally storing it in one or more internal {@link IEnergyStorage} objects.
|
||
|
|
*
|
||
|
|
* A reference implementation is provided {@link TileEnergyHandler}.
|
||
|
|
*
|
||
|
|
* @author King Lemming
|
||
|
|
*
|
||
|
|
*/
|
||
|
|
public interface IEnergyHandler {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Add energy to an IEnergyHandler, internal distribution is left entirely to the IEnergyHandler.
|
||
|
|
*
|
||
|
|
* @param from
|
||
|
|
* Orientation the energy is received from.
|
||
|
|
* @param maxReceive
|
||
|
|
* Maximum amount of energy to received.
|
||
|
|
* @param simulate
|
||
|
|
* If TRUE, the charge will only be simulated.
|
||
|
|
* @return Amount of energy that was (or would have been, if simulated) received.
|
||
|
|
*/
|
||
|
|
int receiveEnergy(ForgeDirection from, int maxReceive, boolean simulate);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Remove energy from an IEnergyHandler, internal distribution is left entirely to the IEnergyHandler.
|
||
|
|
*
|
||
|
|
* @param from
|
||
|
|
* Orientation the energy is extracted to.
|
||
|
|
* @param maxExtract
|
||
|
|
* Maximum amount of energy to extract.
|
||
|
|
* @param simulate
|
||
|
|
* If TRUE, the discharge will only be simulated.
|
||
|
|
* @return Amount of energy that was (or would have been, if simulated) extracted.
|
||
|
|
*/
|
||
|
|
int extractEnergy(ForgeDirection from, int maxExtract, boolean simulate);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns true if the Handler functions on a given side - if a Tile Entity can receive and/or send energy from a given side, this should return true.
|
||
|
|
*/
|
||
|
|
boolean canInterface(ForgeDirection from);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the amount of energy currently stored.
|
||
|
|
*/
|
||
|
|
int getEnergyStored(ForgeDirection from);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns the maximum amount of energy that can be stored.
|
||
|
|
*/
|
||
|
|
int getMaxEnergyStored(ForgeDirection from);
|
||
|
|
|
||
|
|
}
|