cofh.api.energy

Class ItemEnergyContainer

java.lang.Object

net.minecraft.item.Item

cofh.api.energy.ItemEnergyContainer

All Implemented Interfaces:

IEnergyContainerItem

public class ItemEnergyContainer
extends net.minecraft.item.Item
implements IEnergyContainerItem

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

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraft.item.Item

net.minecraft.item.Item.ToolMaterial

Field Summary

Fields

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

Fields inherited from class net.minecraft.item.Item

bFull3D, canRepair, field_111210_e, hasSubtypes, iconString, itemIcon, itemRand, itemRegistry, maxStackSize

Constructor Summary

Constructors

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

Method Summary

Methods

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.
ItemEnergyContainer	setCapacity(int capacity)
void	setMaxExtract(int maxExtract)
void	setMaxReceive(int maxReceive)
void	setMaxTransfer(int maxTransfer)

Methods inherited from class net.minecraft.item.Item

addInformation, canHarvestBlock, canItemEditBlocks, createEntity, doesContainerItemLeaveCraftingGrid, doesSneakBypassUse, func_150893_a, func_150897_b, getArmorModel, getArmorTexture, getAttributeModifiers, getChestGenBase, getColorFromItemStack, getContainerItem, getContainerItem, getCreativeTab, getCreativeTabs, getDamage, getDigSpeed, getDisplayDamage, getDurabilityForDisplay, getEntityLifespan, getFontRenderer, getHarvestLevel, getHasSubtypes, getIcon, getIcon, getIconFromDamage, getIconFromDamageForRenderPass, getIconIndex, getIconString, getIdFromItem, getIsRepairable, getItemAttributeModifiers, getItemById, getItemEnchantability, getItemEnchantability, getItemFromBlock, getItemStackDisplayName, getItemStackLimit, getItemStackLimit, getItemUseAction, getMaxDamage, getMaxDamage, getMaxItemUseDuration, getMetadata, getMovingObjectPositionFromPlayer, getPotionEffect, getRarity, getRenderPasses, getShareTag, getSmeltingExperience, getSpriteNumber, getSubItems, getToolClasses, getUnlocalizedName, getUnlocalizedName, getUnlocalizedNameInefficiently, hasContainerItem, hasContainerItem, hasCustomEntity, hasEffect, hasEffect, hitEntity, isBookEnchantable, isDamageable, isDamaged, isFull3D, isItemTool, isMap, isPotionIngredient, isRepairable, isValidArmor, itemInteractionForEntity, onArmorTick, onBlockDestroyed, onBlockStartBreak, onCreated, onDroppedByPlayer, onEaten, onEntityItemUpdate, onEntitySwing, onItemRightClick, onItemUse, onItemUseFirst, onLeftClickEntity, onPlayerStoppedUsing, onUpdate, onUsingTick, registerIcons, registerItems, renderHelmetOverlay, requiresMultipleRenderPasses, setContainerItem, setCreativeTab, setDamage, setFull3D, setHarvestLevel, setHasSubtypes, setMaxDamage, setMaxStackSize, setNoRepair, setPotionEffect, setTextureName, setUnlocalizedName, shouldRotateAroundWhenRendering, showDurabilityBar

Methods inherited from class java.lang.Object

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

Field Detail

capacity

protected int capacity

maxReceive

protected int maxReceive

maxExtract

protected int maxExtract

Constructor Detail

ItemEnergyContainer

public ItemEnergyContainer()

ItemEnergyContainer

public ItemEnergyContainer(int capacity)

ItemEnergyContainer

public ItemEnergyContainer(int capacity,
                   int maxTransfer)

ItemEnergyContainer

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

Method Detail

setCapacity

public ItemEnergyContainer setCapacity(int capacity)

setMaxTransfer

public void setMaxTransfer(int maxTransfer)

setMaxReceive

public void setMaxReceive(int maxReceive)

setMaxExtract

public void setMaxExtract(int maxExtract)

receiveEnergy

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

Description copied from interface: IEnergyContainerItem

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.

Specified by:

receiveEnergy in interface IEnergyContainerItem

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

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

Description copied from interface: IEnergyContainerItem

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.

Specified by:

extractEnergy in interface IEnergyContainerItem

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

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

Description copied from interface: IEnergyContainerItem

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

Specified by:

getEnergyStored in interface IEnergyContainerItem

getMaxEnergyStored

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

Description copied from interface: IEnergyContainerItem

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

Specified by:

getMaxEnergyStored in interface IEnergyContainerItem