Update docs on IMatteryEnergyStorage to be more clear

This commit is contained in:
DBotThePony 2022-09-04 16:06:50 +07:00
parent ca3e5d948c
commit 7d46ec4b13
Signed by: DBot
GPG Key ID: DCC23B5715498507

View File

@ -7,30 +7,34 @@ import java.math.BigInteger
// IEnergyStorage for direct compat with Forge Energy // IEnergyStorage for direct compat with Forge Energy
interface IMatteryEnergyStorage : IEnergyStorage { interface IMatteryEnergyStorage : IEnergyStorage {
/** /**
* Such as cables. This is something that would work only with energy storage * Energy extraction by external interacts
* *
* @return energy extracted * @return energy extracted
*/ */
fun extractEnergyOuter(howMuch: ImpreciseFraction, simulate: Boolean): ImpreciseFraction fun extractEnergyOuter(howMuch: ImpreciseFraction, simulate: Boolean): ImpreciseFraction
/** /**
* for internal needs, e.g. for work * Energy extraction by internal processes
* CAN also be used by something that does evil *
* e.g. sucking out energy anomaly should use this * Nothing stops you from calling this directly, not on yours capability,
* but you really should think before doing this on not own capability.
* *
* @return energy extracted * @return energy extracted
*/ */
fun extractEnergyInner(howMuch: ImpreciseFraction, simulate: Boolean): ImpreciseFraction fun extractEnergyInner(howMuch: ImpreciseFraction, simulate: Boolean): ImpreciseFraction
/** /**
* For energy receiving from outside, e.g. cables * Energy insertion by external interacts
* *
* @return energy accepted * @return energy accepted
*/ */
fun receiveEnergyOuter(howMuch: ImpreciseFraction, simulate: Boolean): ImpreciseFraction fun receiveEnergyOuter(howMuch: ImpreciseFraction, simulate: Boolean): ImpreciseFraction
/** /**
* For energy receiving from inside, e.g. generator generates power * Energy insertion by internal processes
*
* Nothing stops you from calling this directly, not on yours capability,
* but you really should think before doing this on not own capability.
* *
* @return energy accepted * @return energy accepted
*/ */