buildcraft.core.lib

Class RFBattery

java.lang.Object

buildcraft.core.lib.RFBattery

All Implemented Interfaces:

IEnergyStorage

public class RFBattery
extends java.lang.Object
implements IEnergyStorage

Constructor Summary

Constructors

Constructor and Description
RFBattery(int maxEnergy, int maxReceive, int maxExtract)

Method Summary

Modifier and Type	Method and Description
int	addEnergy(int minReceive, int maxReceive, boolean simulate)
int	extractEnergy(int maxExtract, boolean simulate) Removes energy from the storage.
int	getEnergyStored() Returns the amount of energy currently stored.
int	getMaxEnergyExtract()
int	getMaxEnergyReceive()
int	getMaxEnergyStored() Returns the maximum amount of energy that can be stored.
void	readFromNBT(net.minecraft.nbt.NBTTagCompound tag)
int	receiveEnergy(int maxReceive, boolean simulate) Adds energy to the storage.
void	setEnergy(int iEnergy)
int	useEnergy(int minExtract, int maxExtract, boolean simulate)
void	writeToNBT(net.minecraft.nbt.NBTTagCompound tag)

Methods inherited from class java.lang.Object

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

Constructor Detail

RFBattery

public RFBattery(int maxEnergy,
                 int maxReceive,
                 int maxExtract)

Method Detail

readFromNBT

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

writeToNBT

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

addEnergy

public int addEnergy(int minReceive,
                     int maxReceive,
                     boolean simulate)

useEnergy

public int useEnergy(int minExtract,
                     int maxExtract,
                     boolean simulate)

receiveEnergy

public int receiveEnergy(int maxReceive,
                         boolean simulate)

Description copied from interface: IEnergyStorage

Adds energy to the storage. Returns quantity of energy that was accepted.

Specified by:

receiveEnergy in interface IEnergyStorage

Parameters:

maxReceive - Maximum amount of energy to be inserted.

simulate - If TRUE, the insertion will only be simulated.

Returns:

Amount of energy that was (or would have been, if simulated) accepted by the storage.

extractEnergy

public int extractEnergy(int maxExtract,
                         boolean simulate)

Description copied from interface: IEnergyStorage

Removes energy from the storage. Returns quantity of energy that was removed.

Specified by:

extractEnergy in interface IEnergyStorage

Parameters:

maxExtract - Maximum amount of energy to be extracted.

simulate - If TRUE, the extraction will only be simulated.

Returns:

Amount of energy that was (or would have been, if simulated) extracted from the storage.

getEnergyStored

public int getEnergyStored()

Description copied from interface: IEnergyStorage

Returns the amount of energy currently stored.

Specified by:

getEnergyStored in interface IEnergyStorage

getMaxEnergyStored

public int getMaxEnergyStored()

Description copied from interface: IEnergyStorage

Returns the maximum amount of energy that can be stored.

Specified by:

getMaxEnergyStored in interface IEnergyStorage

getMaxEnergyReceive

public int getMaxEnergyReceive()

getMaxEnergyExtract

public int getMaxEnergyExtract()

setEnergy

public void setEnergy(int iEnergy)