EnergyContainer.java

package com.team.futurecraft.tileentity;

import net.minecraft.nbt.NBTTagCompound;
import net.minecraft.server.gui.IUpdatePlayerListBox;
import net.minecraft.tileentity.TileEntity;

/**
 * This is the class that all energy-storing TileEntities extend.
 * The only methods you'll be overriding from here will be 
 * writeToNBT(NBTTagCompound tag) and readFromNBT(NBTTagCompound tag).
 * Note that you must call super(tag) in them for this class to save energy data.
 * 
 * @author Joseph
 */
public abstract class EnergyContainer extends TileEntity implements IUpdatePlayerListBox {
	private int energy = 0;
	private int energyTransferred;
	private int maxEnergy;
	
	public EnergyContainer(int maxEnergy, int energyTransfer) {
		this.maxEnergy = maxEnergy;
		this.energyTransferred = energyTransfer;
	}
	
	/**
	 * Does exactly what you think it does, returns the energy.
	 */
	public int getEnergy() {
		return this.energy;
	}
	
	/**
	 * Gets the maximum energy this can hold.
	 */
	public int getMaxEnergy() {
		return this.maxEnergy;
	}
	
	/**
	 * Gets how much energy is transferred every tick.
	 */
	public int energyTransferred() {
		return this.energyTransferred;
	}
	
	/**
	 * Returns if this TE's energy count is full.
	 */
	public boolean isFull() {
		return this.energy == this.maxEnergy;
	}
	
	/**
	 * Adds energy to this TE. Dont worry about exceeding the maxEnergy limit, this sets it to the limit
	 * automatically if you increase it higher than the limit. But note that energy will be destroyed.
	 */
	public void addEnergy(int amount) {
		this.energy += amount;
		if (this.energy > this.maxEnergy)
			this.energy = this.maxEnergy;
	}
	
	/**
	 * Sets this TE's energy. Dont worry about exceeding the maxEnergy limit, this will set it to the limit if
	 * the amount is higher.
	 */
	public void setEnergy(int amount) {
		if (amount > this.maxEnergy) this.energy = this.maxEnergy;
		else this.energy = amount;
	}
	
	/**
	 * Remove energy from this TE. Automatically checks for negative values and sets them to 0.
	 */
	public void removeEnergy(int amount) {
		this.energy -= amount;
		if (this.energy < 0) this.energy = 0;
	}
	
	/**
	 * Any class that extends this method MUST call super(tag) or else it wont save energy values.
	 */
	@Override
	public void writeToNBT(NBTTagCompound tag) {
		tag.setInteger("energy", this.energy);
		super.writeToNBT(tag);
	}
	
	/**
	 * Any class that extends this method MUST call super(tag) or else it wont read energy values.
	 */
	@Override
	public void readFromNBT(NBTTagCompound tag) {
		this.energy = tag.getInteger("energy");
		super.readFromNBT(tag);
	}
	
	/**
	 * Gets the energy amount inbetween 0 and scale. Usually used for energy level gui's.
	 */
	public int getEnergyAmountScaled(int scale) {
		return this.energy * scale / this.maxEnergy;
	}
}