buildcraft.api.mj

Interface IBatteryObject

All Known Subinterfaces:

IBatteryIOObject, MjReconfigurator.IConfigurableBatteryObject

All Known Implementing Classes:

BatteryCopy, 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()
void	init(java.lang.Object object, java.lang.reflect.Field storedField, MjBattery battery) Basic initialization method
java.lang.String	kind()
double	maxCapacity()
double	maxReceivedPerCycle()
double	minimumConsumption()
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()

Returns:

Maximal energy amount for this battery.

minimumConsumption

double minimumConsumption()

Returns:

Minimal energy amount for keep your machine in active state

maxReceivedPerCycle

double maxReceivedPerCycle()

Returns:

Maximal energy received per one tick

kind

java.lang.String kind()

Returns:

kind of this energy battery

init

void init(java.lang.Object object,
        java.lang.reflect.Field storedField,
        MjBattery battery)

Basic initialization method

Parameters:

object - Basic object which hold a battery field

storedField - Field for energy storing

battery - Battery data