buildcraft.api.mj

Class BatteryObject

java.lang.Object

buildcraft.api.mj.BatteryObject

All Implemented Interfaces:

IBatteryIOObject, IBatteryObject, MjReconfigurator.IConfigurableBatteryObject

public class BatteryObject
extends java.lang.Object
implements IBatteryIOObject, MjReconfigurator.IConfigurableBatteryObject

A battery object is a wrapper around a battery field in an object. This battery field is of type double, and is the only piece of data specific to this object. Others are class-wide.

Field Summary

Fields

Modifier and Type	Field and Description
protected MjBattery	batteryData
protected java.lang.reflect.Field	energyStored
protected java.lang.Object	obj

Constructor Summary

Constructors

Constructor and Description
BatteryObject()

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
boolean	canReceive()
boolean	canSend()
double	extractEnergy(double mj)
double	extractEnergy(double mj, boolean ignoreCycleLimit)
double	getEnergyRequested()
double	getEnergyStored()
MjBattery	getMjBattery()
void	init(java.lang.Object object, java.lang.reflect.Field storedField, MjBattery battery) Basic initialization method
boolean	isActive()
boolean	isCacheable()
java.lang.String	kind()
double	maxCapacity()
double	maxReceivedPerCycle()
double	maxSendedPerCycle()
double	minimumConsumption()
IOMode	mode()
void	setEnergyStored(double mj) Set current stored energy amount.
void	setMjBattery(MjBattery battery)

Methods inherited from class java.lang.Object

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

Field Detail

energyStored

protected java.lang.reflect.Field energyStored

obj

protected java.lang.Object obj

batteryData

protected MjBattery batteryData

Constructor Detail

BatteryObject

public BatteryObject()

Method Detail

getEnergyRequested

public double getEnergyRequested()

Specified by:

getEnergyRequested in interface IBatteryObject

Returns:

Current energy requirement for keeping machine state

addEnergy

public double addEnergy(double mj)

Add energy to this battery

Specified by:

addEnergy in interface IBatteryObject

Parameters:

mj - Energy amount

Returns:

Used energy

addEnergy

public double addEnergy(double mj,
               boolean ignoreCycleLimit)

Add energy to this battery

Specified by:

addEnergy in interface IBatteryObject

Parameters:

mj - Energy amount

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

Returns:

Used energy

extractEnergy

public double extractEnergy(double mj)

Specified by:

extractEnergy in interface IBatteryIOObject

extractEnergy

public double extractEnergy(double mj,
                   boolean ignoreCycleLimit)

Specified by:

extractEnergy in interface IBatteryIOObject

getEnergyStored

public double getEnergyStored()

Specified by:

getEnergyStored in interface IBatteryObject

Returns:

Current stored energy amount in this battery

setEnergyStored

public void setEnergyStored(double mj)

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

Specified by:

setEnergyStored in interface IBatteryObject

Parameters:

mj - New energy amount

maxCapacity

public double maxCapacity()

Specified by:

maxCapacity in interface IBatteryObject

Returns:

Maximal energy amount for this battery.

minimumConsumption

public double minimumConsumption()

Specified by:

minimumConsumption in interface IBatteryObject

Returns:

Minimal energy amount for keep your machine in active state

maxReceivedPerCycle

public double maxReceivedPerCycle()

Specified by:

maxReceivedPerCycle in interface IBatteryObject

Returns:

Maximal energy received per one tick

kind

public java.lang.String kind()

Specified by:

kind in interface IBatteryObject

Returns:

kind of this energy battery

init

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

Description copied from interface: IBatteryObject

Basic initialization method

Specified by:

init in interface IBatteryObject

Parameters:

object - Basic object which hold a battery field

storedField - Field for energy storing

battery - Battery data

maxSendedPerCycle

public double maxSendedPerCycle()

Specified by:

maxSendedPerCycle in interface IBatteryIOObject

mode

public IOMode mode()

Specified by:

mode in interface IBatteryIOObject

canSend

public boolean canSend()

Specified by:

canSend in interface IBatteryIOObject

canReceive

public boolean canReceive()

Specified by:

canReceive in interface IBatteryIOObject

isActive

public boolean isActive()

Specified by:

isActive in interface IBatteryIOObject

isCacheable

public boolean isCacheable()

Specified by:

isCacheable in interface IBatteryIOObject

getMjBattery

public MjBattery getMjBattery()

Specified by:

getMjBattery in interface MjReconfigurator.IConfigurableBatteryObject

setMjBattery

public void setMjBattery(MjBattery battery)

Specified by:

setMjBattery in interface MjReconfigurator.IConfigurableBatteryObject