cofh.api.energy

Interface IEnergyStorage

All Known Implementing Classes:

EnergyStorage, RFBattery

public interface IEnergyStorage

An energy storage is the unit of interaction with Energy inventories.
This is not to be implemented on TileEntities. This is for internal use only.

A reference implementation can be found at EnergyStorage.

Method Summary

Methods

Modifier and Type	Method and Description
int	extractEnergy(int maxExtract, boolean simulate) Removes energy from the storage.
int	getEnergyStored() Returns the amount of energy currently stored.
int	getMaxEnergyStored() Returns the maximum amount of energy that can be stored.
int	receiveEnergy(int maxReceive, boolean simulate) Adds energy to the storage.

Method Detail

receiveEnergy

int receiveEnergy(int maxReceive,
                boolean simulate)

Adds energy to the storage. Returns quantity of energy that was accepted.

Parameters:

maxReceive - Maximum amount of energy to be inserted.

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

Returns:

Amount of energy that was (or would have been, if simulated) accepted by the storage.

extractEnergy

int extractEnergy(int maxExtract,
                boolean simulate)

Removes energy from the storage. Returns quantity of energy that was removed.

Parameters:

maxExtract - Maximum amount of energy to be extracted.

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

Returns:

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

getEnergyStored

int getEnergyStored()

Returns the amount of energy currently stored.

getMaxEnergyStored

int getMaxEnergyStored()

Returns the maximum amount of energy that can be stored.