buildcraft.api.power

Class PowerHandler

java.lang.Object

buildcraft.api.power.PowerHandler

public final class PowerHandler
extends java.lang.Object

The PowerHandler is similar to FluidTank in that it holds your power and allows standardized interaction between machines. To receive power to your machine you needs create an instance of PowerHandler and implement IPowerReceptor on the TileEntity. If you plan emit power, you need only implement IPowerEmitter. You do not need a PowerHandler. Engines have a PowerHandler because they can also receive power from other Engines. See TileRefinery for a simple example of a power using machine.

See Also:

IPowerReceptor, IPowerEmitter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PowerHandler.PerditionCalculator Extend this class to create custom Perdition algorithms (its not final).
class	PowerHandler.PowerReceiver
static class	PowerHandler.Type

Field Summary

Fields

Modifier and Type	Field and Description
static PowerHandler.PerditionCalculator	DEFAULT_PERDITION
int[]	powerSources
IPowerReceptor	receptor
static double	ROLLING_AVERAGE_DENOMINATOR
static double	ROLLING_AVERAGE_NUMERATOR
static double	ROLLING_AVERAGE_WEIGHT

Constructor Summary

Constructors

Constructor and Description
PowerHandler(IPowerReceptor receptor, PowerHandler.Type type)

Method Summary

Methods

Modifier and Type	Method and Description
double	addEnergy(double quantity)
void	configure(double minEnergyReceived, double maxEnergyReceived, double activationEnergy, double maxStoredEnergy) Setup your PowerHandler's settings.
void	configurePowerPerdition(int powerLoss, int powerLossRegularity) Allows you define perdition in terms of loss/ticks.
double	getActivationEnergy()
double	getEnergyStored()
double	getMaxEnergyReceived()
double	getMaxEnergyStored()
double	getMinEnergyReceived()
PowerHandler.PerditionCalculator	getPerdition()
PowerHandler.PowerReceiver	getPowerReceiver()
boolean	isPowerSource(net.minecraftforge.common.util.ForgeDirection from)
void	readFromNBT(net.minecraft.nbt.NBTTagCompound data)
void	readFromNBT(net.minecraft.nbt.NBTTagCompound data, java.lang.String tag)
void	setEnergy(double quantity)
void	setPerdition(PowerHandler.PerditionCalculator perdition) Allows you to define a new PerditionCalculator class to handler perdition calculations.
void	update() Ticks the power handler.
double	useEnergy(double min, double max, boolean doUse) Extract energy from the PowerHandler.
void	writeToNBT(net.minecraft.nbt.NBTTagCompound data)
void	writeToNBT(net.minecraft.nbt.NBTTagCompound data, java.lang.String tag)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_PERDITION

public static final PowerHandler.PerditionCalculator DEFAULT_PERDITION

ROLLING_AVERAGE_WEIGHT

public static final double ROLLING_AVERAGE_WEIGHT

See Also:

Constant Field Values

ROLLING_AVERAGE_NUMERATOR

public static final double ROLLING_AVERAGE_NUMERATOR

See Also:

Constant Field Values

ROLLING_AVERAGE_DENOMINATOR

public static final double ROLLING_AVERAGE_DENOMINATOR

See Also:

Constant Field Values

powerSources

public final int[] powerSources

receptor

public final IPowerReceptor receptor

Constructor Detail

PowerHandler

public PowerHandler(IPowerReceptor receptor,
            PowerHandler.Type type)

Method Detail

getPowerReceiver

public PowerHandler.PowerReceiver getPowerReceiver()

getMinEnergyReceived

public double getMinEnergyReceived()

getMaxEnergyReceived

public double getMaxEnergyReceived()

getMaxEnergyStored

public double getMaxEnergyStored()

getActivationEnergy

public double getActivationEnergy()

getEnergyStored

public double getEnergyStored()

configure

public void configure(double minEnergyReceived,
             double maxEnergyReceived,
             double activationEnergy,
             double maxStoredEnergy)

Setup your PowerHandler's settings.

Parameters:

minEnergyReceived - This is the minimum about of power that will be accepted by the PowerHandler. This should generally be greater than the activationEnergy if you plan to use the doWork() callback. Anything greater than 1 will prevent Redstone Engines from powering this Provider.

maxEnergyReceived - The maximum amount of power accepted by the PowerHandler. This should generally be less than 500. Too low and larger engines will overheat while trying to power the machine. Too high, and the engines will never warm up. Greater values also place greater strain on the power net.

activationEnergy - If the stored energy is greater than this value, the doWork() callback is called (once per tick).

maxStoredEnergy - The maximum amount of power this PowerHandler can store. Values tend to range between 100 and 5000. With 1000 and 1500 being common.

configurePowerPerdition

public void configurePowerPerdition(int powerLoss,
                           int powerLossRegularity)

Allows you define perdition in terms of loss/ticks. This function is mostly for legacy implementations. See PerditionCalculator for more complex perdition formulas.

Parameters:

powerLoss -

powerLossRegularity -

See Also:

PowerHandler.PerditionCalculator

setPerdition

public void setPerdition(PowerHandler.PerditionCalculator perdition)

Allows you to define a new PerditionCalculator class to handler perdition calculations. For example if you want exponentially increasing loss based on amount stored.

Parameters:

perdition -

getPerdition

public PowerHandler.PerditionCalculator getPerdition()

update

public void update()

Ticks the power handler. You should call this if you can, but its not required. If you don't call it, the possibility exists for some weirdness with the perdition algorithm and work callback as its possible they will not be called on every tick they otherwise would be. You should be able to design around this though if you are aware of the limitations.

useEnergy

public double useEnergy(double min,
               double max,
               boolean doUse)

Extract energy from the PowerHandler. You must call this even if doWork() triggers.

Parameters:

min -

max -

doUse -

Returns:

amount used

readFromNBT

public void readFromNBT(net.minecraft.nbt.NBTTagCompound data)

readFromNBT

public void readFromNBT(net.minecraft.nbt.NBTTagCompound data,
               java.lang.String tag)

writeToNBT

public void writeToNBT(net.minecraft.nbt.NBTTagCompound data)

writeToNBT

public void writeToNBT(net.minecraft.nbt.NBTTagCompound data,
              java.lang.String tag)

addEnergy

public double addEnergy(double quantity)

Returns:

the amount the power changed by

setEnergy

public void setEnergy(double quantity)

isPowerSource

public boolean isPowerSource(net.minecraftforge.common.util.ForgeDirection from)