cofh.api.energy

Interface IEnergyContainerItem

All Known Implementing Classes:

ItemEnergyContainer, ItemRobot

public interface IEnergyContainerItem

Implement this interface on Item classes that support external manipulation of their internal energy storages.

A reference implementation is provided ItemEnergyContainer.

Method Summary

Modifier and Type	Method and Description
int	extractEnergy(net.minecraft.item.ItemStack container, int maxExtract, boolean simulate) Removes energy from a container item.
int	getEnergyStored(net.minecraft.item.ItemStack container) Get the amount of energy currently stored in the container item.
int	getMaxEnergyStored(net.minecraft.item.ItemStack container) Get the max amount of energy that can be stored in the container item.
int	receiveEnergy(net.minecraft.item.ItemStack container, int maxReceive, boolean simulate) Adds energy to a container item.

Method Detail

receiveEnergy

int receiveEnergy(net.minecraft.item.ItemStack container,
                  int maxReceive,
                  boolean simulate)

Adds energy to a container item. Returns the quantity of energy that was accepted. This should always return 0 if the item cannot be externally charged.

Parameters:

container - ItemStack to be charged.

maxReceive - Maximum amount of energy to be sent into the item.

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

Returns:

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

extractEnergy

int extractEnergy(net.minecraft.item.ItemStack container,
                  int maxExtract,
                  boolean simulate)

Removes energy from a container item. Returns the quantity of energy that was removed. This should always return 0 if the item cannot be externally discharged.

Parameters:

container - ItemStack to be discharged.

maxExtract - Maximum amount of energy to be extracted from the item.

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

Returns:

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

getEnergyStored

int getEnergyStored(net.minecraft.item.ItemStack container)

Get the amount of energy currently stored in the container item.

getMaxEnergyStored

int getMaxEnergyStored(net.minecraft.item.ItemStack container)

Get the max amount of energy that can be stored in the container item.