2015-07-15 00:19:44 +02:00
|
|
|
package cofh.api.energy;
|
|
|
|
|
2016-01-07 18:20:59 +01:00
|
|
|
import net.minecraft.util.EnumFacing;
|
2015-07-15 00:19:44 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Implement this interface on Tile Entities which should provide energy, generally storing it in one or more internal {@link IEnergyStorage} objects.
|
2017-03-10 23:33:51 +01:00
|
|
|
*
|
2015-07-15 00:19:44 +02:00
|
|
|
* A reference implementation is provided {@link TileEnergyHandler}.
|
|
|
|
*
|
|
|
|
* @author King Lemming
|
|
|
|
*/
|
2016-02-16 21:49:44 +01:00
|
|
|
public interface IEnergyProvider extends IEnergyHandler {
|
2015-07-15 00:19:44 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Remove energy from an IEnergyProvider, internal distribution is left entirely to the IEnergyProvider.
|
|
|
|
*
|
2017-03-10 23:33:51 +01:00
|
|
|
* @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.
|
2015-07-15 00:19:44 +02:00
|
|
|
* @return Amount of energy that was (or would have been, if simulated) extracted.
|
|
|
|
*/
|
2016-01-07 18:20:59 +01:00
|
|
|
int extractEnergy(EnumFacing from, int maxExtract, boolean simulate);
|
2015-07-15 00:19:44 +02:00
|
|
|
|
|
|
|
}
|