From 7d46ec4b1345adc08df2a1c8783b8fd951e0a92b Mon Sep 17 00:00:00 2001 From: DBotThePony Date: Sun, 4 Sep 2022 16:06:50 +0700 Subject: [PATCH] Update docs on IMatteryEnergyStorage to be more clear --- .../mc/otm/capability/IMatteryEnergyStorage.kt | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/src/main/kotlin/ru/dbotthepony/mc/otm/capability/IMatteryEnergyStorage.kt b/src/main/kotlin/ru/dbotthepony/mc/otm/capability/IMatteryEnergyStorage.kt index 97071dba8..d5152878b 100644 --- a/src/main/kotlin/ru/dbotthepony/mc/otm/capability/IMatteryEnergyStorage.kt +++ b/src/main/kotlin/ru/dbotthepony/mc/otm/capability/IMatteryEnergyStorage.kt @@ -7,30 +7,34 @@ import java.math.BigInteger // IEnergyStorage for direct compat with Forge Energy interface IMatteryEnergyStorage : IEnergyStorage { /** - * Such as cables. This is something that would work only with energy storage + * Energy extraction by external interacts * * @return energy extracted */ fun extractEnergyOuter(howMuch: ImpreciseFraction, simulate: Boolean): ImpreciseFraction /** - * for internal needs, e.g. for work - * CAN also be used by something that does evil - * e.g. sucking out energy anomaly should use this + * Energy extraction 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 extracted */ fun extractEnergyInner(howMuch: ImpreciseFraction, simulate: Boolean): ImpreciseFraction /** - * For energy receiving from outside, e.g. cables + * Energy insertion by external interacts * * @return energy accepted */ 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 */