made changes

This commit is contained in:
brandon3055 committed 2014-07-25 08:18:24 +10:00
1 parent ed7de6f643
commit c047d24fbd
46 files changed
+2152 -225

No files matched your search

@@ -1,7 +1,7 @@
package cofh.api.energy;
/**
* An energy storage is the unit of interaction with EnergyHelper inventories.
* An energy internalGenBuffer is the unit of interaction with EnergyHelper inventories.
*
* A reference implementation can be found at {@link EnergyStorage}.
*
@@ -11,24 +11,24 @@ package cofh.api.energy;
public interface IEnergyStorage {
/**
* Adds energy to the storage. Returns quantity of energy that was accepted.
* Adds energy to the internalGenBuffer. Returns quantity of energy that was accepted.
*
* @param maxReceive
* Maximum amount of energy to be inserted.
* @param simulate
* If TRUE, the insertion will only be simulated.
* @return Amount of energy that was (or would have been, if simulated) accepted by the storage.
* @return Amount of energy that was (or would have been, if simulated) accepted by the internalGenBuffer.
*/
int receiveEnergy(int maxReceive, boolean simulate);
/**
* Removes energy from the storage. Returns quantity of energy that was removed.
* Removes energy from the internalGenBuffer. Returns quantity of energy that was removed.
*
* @param maxExtract
* Maximum amount of energy to be extracted.
* @param simulate
* If TRUE, the extraction will only be simulated.
* @return Amount of energy that was (or would have been, if simulated) extracted from the storage.
* @return Amount of energy that was (or would have been, if simulated) extracted from the internalGenBuffer.
*/
int extractEnergy(int maxExtract, boolean simulate);