cofh.api.energy

Interface IEnergyProvider

All Superinterfaces:

IEnergyConnection

All Known Subinterfaces:

IEnergyHandler

All Known Implementing Classes:

PipeFluidsEmerald, PipeFluidsWood, PipeItemsEmerald, PipeItemsEmzuli, PipeItemsObsidian, PipeItemsStripes, PipeItemsWood, PipePowerEmerald, PipePowerWood, PowerAdapterPluggable, TileAbstractBuilder, TileAdvancedCraftingTable, TileArchitect, TileAssemblyTable, TileAutoWorkbench, TileBlueprintLibrary, TileBuildCraft, TileBuilder, TileChargingTable, TileConstructionMarker, TileEnergyHandler, TileEngineBase, TileEngineCreative, TileEngineIron, TileEngineStone, TileEngineWithInventory, TileEngineWood, TileFiller, TileFilteredBuffer, TileFloodGate, TileGenericPipe, TileHopper, TileIntegrationTable, TileLaser, TileLaserTableBase, TileMarker, TileMiningWell, TilePackager, TilePathMarker, TileProgrammingTable, TilePump, TileQuarry, TileRefinery, TileRequester, TileStampingTable, TileTank, TileUrbanist, TileZonePlan

public interface IEnergyProvider
extends IEnergyConnection

Implement this interface on Tile Entities which should provide energy, generally storing it in one or more internal IEnergyStorage objects.

A reference implementation is provided TileEnergyHandler.

Method Summary

Modifier and Type	Method and Description
int	extractEnergy(net.minecraftforge.common.util.ForgeDirection from, int maxExtract, boolean simulate) Remove energy from an IEnergyProvider, internal distribution is left entirely to the IEnergyProvider.
int	getEnergyStored(net.minecraftforge.common.util.ForgeDirection from) Returns the amount of energy currently stored.
int	getMaxEnergyStored(net.minecraftforge.common.util.ForgeDirection from) Returns the maximum amount of energy that can be stored.

Methods inherited from interface cofh.api.energy.IEnergyConnection

canConnectEnergy

Method Detail

extractEnergy

int extractEnergy(net.minecraftforge.common.util.ForgeDirection from,
                  int maxExtract,
                  boolean simulate)

Remove energy from an IEnergyProvider, internal distribution is left entirely to the IEnergyProvider.

Parameters:

from - Orientation the energy is extracted from.

maxExtract - Maximum amount of energy to extract.

simulate - If TRUE, the extraction will only be simulated.

Returns:

Amount of energy that was (or would have been, if simulated) extracted.

getEnergyStored

int getEnergyStored(net.minecraftforge.common.util.ForgeDirection from)

Returns the amount of energy currently stored.

getMaxEnergyStored

int getMaxEnergyStored(net.minecraftforge.common.util.ForgeDirection from)

Returns the maximum amount of energy that can be stored.