cofh.api.energy

Class TileEnergyHandler

java.lang.Object

net.minecraft.tileentity.TileEntity

cofh.api.energy.TileEnergyHandler

All Implemented Interfaces:

IEnergyConnection, IEnergyHandler, IEnergyProvider, IEnergyReceiver

public class TileEnergyHandler
extends net.minecraft.tileentity.TileEntity
implements IEnergyHandler

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

Field Summary

Fields

Modifier and Type	Field and Description
protected EnergyStorage	storage

Fields inherited from class net.minecraft.tileentity.TileEntity

blockMetadata, blockType, INFINITE_EXTENT_AABB, tileEntityInvalid, worldObj, xCoord, yCoord, zCoord

Constructor Summary

Constructors

Constructor and Description
TileEnergyHandler()

Method Summary

Modifier and Type	Method and Description
boolean	canConnectEnergy(net.minecraftforge.common.util.ForgeDirection from) Returns TRUE if the TileEntity can connect on a given side.
int	extractEnergy(net.minecraftforge.common.util.ForgeDirection from, int maxExtract, boolean simulate) Remove energy from an IEnergyProvider, internal distribution is left entirely to the IEnergyProvider.
int	getEnergyStored(net.minecraftforge.common.util.ForgeDirection from) Returns the amount of energy currently stored.
int	getMaxEnergyStored(net.minecraftforge.common.util.ForgeDirection from) Returns the maximum amount of energy that can be stored.
void	readFromNBT(net.minecraft.nbt.NBTTagCompound nbt)
int	receiveEnergy(net.minecraftforge.common.util.ForgeDirection from, int maxReceive, boolean simulate) Add energy to an IEnergyReceiver, internal distribution is left entirely to the IEnergyReceiver.
void	writeToNBT(net.minecraft.nbt.NBTTagCompound nbt)

Methods inherited from class net.minecraft.tileentity.TileEntity

addMapping, canUpdate, createAndLoadEntity, func_145828_a, getBlockMetadata, getBlockType, getDescriptionPacket, getDistanceFrom, getMaxRenderDistanceSquared, getRenderBoundingBox, getWorldObj, hasWorldObj, invalidate, isInvalid, markDirty, onChunkUnload, onDataPacket, receiveClientEvent, setWorldObj, shouldRefresh, shouldRenderInPass, updateContainingBlockInfo, updateEntity, validate

Methods inherited from class java.lang.Object

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

Field Detail

storage

protected EnergyStorage storage

Constructor Detail

TileEnergyHandler

public TileEnergyHandler()

Method Detail

readFromNBT

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

Overrides:

readFromNBT in class net.minecraft.tileentity.TileEntity

writeToNBT

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

Overrides:

writeToNBT in class net.minecraft.tileentity.TileEntity

canConnectEnergy

public boolean canConnectEnergy(net.minecraftforge.common.util.ForgeDirection from)

Description copied from interface: IEnergyConnection

Returns TRUE if the TileEntity can connect on a given side.

Specified by:

canConnectEnergy in interface IEnergyConnection

receiveEnergy

public int receiveEnergy(net.minecraftforge.common.util.ForgeDirection from,
                         int maxReceive,
                         boolean simulate)

Description copied from interface: IEnergyHandler

Add energy to an IEnergyReceiver, internal distribution is left entirely to the IEnergyReceiver.

Specified by:

receiveEnergy in interface IEnergyHandler

Specified by:

receiveEnergy in interface IEnergyReceiver

Parameters:

from - Orientation the energy is received from.

maxReceive - Maximum amount of energy to receive.

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

Returns:

Amount of energy that was (or would have been, if simulated) received.

extractEnergy

public int extractEnergy(net.minecraftforge.common.util.ForgeDirection from,
                         int maxExtract,
                         boolean simulate)

Description copied from interface: IEnergyHandler

Remove energy from an IEnergyProvider, internal distribution is left entirely to the IEnergyProvider.

Specified by:

extractEnergy in interface IEnergyHandler

Specified by:

extractEnergy in interface IEnergyProvider

Parameters:

from - Orientation the energy is extracted from.

maxExtract - Maximum amount of energy to extract.

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

Returns:

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

getEnergyStored

public int getEnergyStored(net.minecraftforge.common.util.ForgeDirection from)

Description copied from interface: IEnergyHandler

Returns the amount of energy currently stored.

Specified by:

getEnergyStored in interface IEnergyHandler

Specified by:

getEnergyStored in interface IEnergyProvider

Specified by:

getEnergyStored in interface IEnergyReceiver

getMaxEnergyStored

public int getMaxEnergyStored(net.minecraftforge.common.util.ForgeDirection from)

Description copied from interface: IEnergyHandler

Returns the maximum amount of energy that can be stored.

Specified by:

getMaxEnergyStored in interface IEnergyHandler

Specified by:

getMaxEnergyStored in interface IEnergyProvider

Specified by:

getMaxEnergyStored in interface IEnergyReceiver