buildcraft.core.inventory

Class BatteryCopy

java.lang.Object

buildcraft.core.inventory.BatteryCopy

All Implemented Interfaces:

IBatteryObject

public class BatteryCopy
extends java.lang.Object
implements IBatteryObject

Creates a deep copy of an existing IInventory. Useful for performing inventory manipulations and then examining the results without affecting the original inventory.

Constructor Summary

Constructors

Constructor and Description
BatteryCopy(IBatteryObject orignal)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

BatteryCopy

public BatteryCopy(IBatteryObject orignal)

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)

Description copied from interface: IBatteryObject

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)

Description copied from interface: IBatteryObject

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

getEnergyStored

public double getEnergyStored()

Specified by:

getEnergyStored in interface IBatteryObject

Returns:

Current stored energy amount in this battery

setEnergyStored

public void setEnergyStored(double mj)

Description copied from interface: IBatteryObject

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