appeng.api.networking.energy

Interface IEnergyGridProvider

All Known Subinterfaces:

IEnergyGrid

public interface IEnergyGridProvider

internal use only.

Method Summary

Modifier and Type	Method and Description
double	extractProviderPower(double amt, Actionable mode) internal use only Extracts the requested amount from the provider.
double	getProviderEnergyDemand(double d) internal use only Returns the current demand of an provider.
double	getProviderMaxEnergy() internal use only AE currently uses this to enqueue the next visited provider.
double	getProviderStoredEnergy() internal use only AE currently uses this to enqueue the next visited provider.
double	injectProviderPower(double amt, Actionable mode) Injects the offered amount into the provider.
java.util.Collection<IEnergyGridProvider>	providers() internal use only Can return a list of providers behind the current.

Method Detail

providers

@Nonnull
java.util.Collection<IEnergyGridProvider> providers()

internal use only Can return a list of providers behind the current. An example would be something acting as proxy between different IEnergyGrids. This can contain duplicate entries, AE will ensure that each provider is only visited once. internal use only

extractProviderPower

@Nonnegative
double extractProviderPower(@Nonnegative
                                          double amt,
                                          @Nonnull
                                          Actionable mode)

internal use only Extracts the requested amount from the provider. This should never forward a call to another IEnergyGridProvider, instead return them via providers()

Returns:

the used amount

injectProviderPower

@Nonnegative
double injectProviderPower(@Nonnegative
                                         double amt,
                                         @Nonnull
                                         Actionable mode)

Injects the offered amount into the provider. This should never forward a call to another IEnergyGridProvider, instead return them via providers() internal use only

Returns:

the leftover amount

getProviderEnergyDemand

@Nonnegative
double getProviderEnergyDemand(@Nonnegative
                                             double d)

internal use only Returns the current demand of an provider. This should never forward a call to another IEnergyGridProvider, instead return them via providers()

Parameters:

d - the max amount offered, the demand should never exceed it.

Returns:

the total amount demanded

getProviderStoredEnergy

@Nonnegative
double getProviderStoredEnergy()

internal use only AE currently uses this to enqueue the next visited provider. There is no guarantee that this works on in a perfect way. It can be limited to the returns of the past providers(), but not any future one discovered by visiting further providers. E.g. inject into the the lowest one first or extract from the highest one.

Returns:

the current stored amount.

getProviderMaxEnergy

@Nonnegative
double getProviderMaxEnergy()

internal use only AE currently uses this to enqueue the next visited provider. There is no guarantee that this works on in a perfect way. It can be limited to the returns of the past providers(), but not any future one discovered by visiting further providers. E.g. inject into the the lowest one first or extract from the highest one.

Returns:

the maximum amount stored.