cofh.api.energy

Class EnergyStorage

java.lang.Object

cofh.api.energy.EnergyStorage

All Implemented Interfaces:

IEnergyStorage

public class EnergyStorage
extends java.lang.Object
implements IEnergyStorage

Reference implementation of IEnergyStorage. Use/extend this or implement your own.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	capacity
protected int	energy
protected int	maxExtract
protected int	maxReceive

Constructor Summary

Constructors

Constructor and Description
EnergyStorage(int capacity)
EnergyStorage(int capacity, int maxTransfer)
EnergyStorage(int capacity, int maxReceive, int maxExtract)

Method Summary

Methods

Modifier and Type	Method and Description
int	extractEnergy(int maxExtract, boolean simulate) Removes energy from the storage.
int	getEnergyStored() Returns the amount of energy currently stored.
int	getMaxEnergyStored() Returns the maximum amount of energy that can be stored.
int	getMaxExtract()
int	getMaxReceive()
void	modifyEnergyStored(int energy) This function is included to allow the containing tile to directly and efficiently modify the energy contained in the EnergyStorage.
EnergyStorage	readFromNBT(net.minecraft.nbt.NBTTagCompound nbt)
int	receiveEnergy(int maxReceive, boolean simulate) Adds energy to the storage.
void	setCapacity(int capacity)
void	setEnergyStored(int energy) This function is included to allow for server -> client sync.
void	setMaxExtract(int maxExtract)
void	setMaxReceive(int maxReceive)
void	setMaxTransfer(int maxTransfer)
net.minecraft.nbt.NBTTagCompound	writeToNBT(net.minecraft.nbt.NBTTagCompound nbt)

Methods inherited from class java.lang.Object

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

Field Detail

energy

protected int energy

capacity

protected int capacity

maxReceive

protected int maxReceive

maxExtract

protected int maxExtract

Constructor Detail

EnergyStorage

public EnergyStorage(int capacity)

EnergyStorage

public EnergyStorage(int capacity,
             int maxTransfer)

EnergyStorage

public EnergyStorage(int capacity,
             int maxReceive,
             int maxExtract)

Method Detail

readFromNBT

public EnergyStorage readFromNBT(net.minecraft.nbt.NBTTagCompound nbt)

writeToNBT

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

setCapacity

public void setCapacity(int capacity)

setMaxTransfer

public void setMaxTransfer(int maxTransfer)

setMaxReceive

public void setMaxReceive(int maxReceive)

setMaxExtract

public void setMaxExtract(int maxExtract)

getMaxReceive

public int getMaxReceive()

getMaxExtract

public int getMaxExtract()

setEnergyStored

public void setEnergyStored(int energy)

This function is included to allow for server -> client sync. Do not call this externally to the containing Tile Entity, as not all IEnergyHandlers are guaranteed to have it.

Parameters:

energy -

modifyEnergyStored

public void modifyEnergyStored(int energy)

This function is included to allow the containing tile to directly and efficiently modify the energy contained in the EnergyStorage. Do not rely on this externally, as not all IEnergyHandlers are guaranteed to have it.

Parameters:

energy -

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