buildcraft.api.mj

Interface IBatteryObject

All Known Subinterfaces:

IBatteryIOObject

All Known Implementing Classes:

BatteryObject

public interface IBatteryObject

Method Summary

Methods

Modifier and Type	Method and Description
double	addEnergy(double mj) Add energy to this battery
double	addEnergy(double mj, boolean ignoreCycleLimit) Add energy to this battery
double	getEnergyRequested()
double	getEnergyStored()
java.lang.String	kind()
double	maxCapacity() Can be overrided via reconfigure(double, double, double)
double	maxReceivedPerCycle() Can be overrided via reconfigure(double, double, double)
double	minimumConsumption() Can be overrided via reconfigure(double, double, double)
IBatteryObject	reconfigure(double maxCapacity, double maxReceivedPerCycle, double minimumConsumption) Allow to dynamically reconfigure your battery.
void	setEnergyStored(double mj) Set current stored energy amount.

Method Detail

getEnergyRequested

double getEnergyRequested()

Returns:

Current energy requirement for keeping machine state

addEnergy

double addEnergy(double mj)

Add energy to this battery

Parameters:

mj - Energy amount

Returns:

Used energy

addEnergy

double addEnergy(double mj,
               boolean ignoreCycleLimit)

Add energy to this battery

Parameters:

mj - Energy amount

ignoreCycleLimit - Force add all energy even if "maxReceivedPerCycle" limit is reached

Returns:

Used energy

getEnergyStored

double getEnergyStored()

Returns:

Current stored energy amount in this battery

setEnergyStored

void setEnergyStored(double mj)

Set current stored energy amount. Doesn't use it for your machines! Decrease your battery field directly.

Parameters:

mj - New energy amount

maxCapacity

double maxCapacity()

Can be overrided via reconfigure(double, double, double)

Returns:

Maximal energy amount for this battery.

minimumConsumption

double minimumConsumption()

Can be overrided via reconfigure(double, double, double)

Returns:

Minimal energy amount for keep your machine in active state

maxReceivedPerCycle

double maxReceivedPerCycle()

Can be overrided via reconfigure(double, double, double)

Returns:

Maximal energy received per one tick

reconfigure

IBatteryObject reconfigure(double maxCapacity,
                         double maxReceivedPerCycle,
                         double minimumConsumption)

Allow to dynamically reconfigure your battery. Usually it's not very good change battery parameters for already present machines, but if you want...

Parameters:

maxCapacity - maxCapacity()

maxReceivedPerCycle - maxReceivedPerCycle()

minimumConsumption - minimumConsumption()

Returns:

Current battery object instance

kind

java.lang.String kind()

Returns:

kind of this energy battery