IBaseClass.java

package k4unl.minecraft.Hydraulicraft.api;

import codechicken.multipart.TMultiPart;
import net.minecraft.nbt.NBTTagCompound;
import net.minecraft.network.NetworkManager;
import net.minecraft.network.Packet;
import net.minecraft.network.play.server.S35PacketUpdateTileEntity;
import net.minecraft.tileentity.TileEntity;
import net.minecraftforge.common.util.ForgeDirection;

/**
 * DO NOT IMPLEMENT THIS INTERFACE!
 * @author K-4U
 */
public interface IBaseClass {
	/**
	 * Used for setting a new tier during runtime.
	 * @param newTier
	 */
	public void setPressureTier(PressureTier newTier);
	
	/**
	 * Set the max ammount of fluid this block can handle during runtime
	 * @param maxFluid The ammount of BUCKETS this block can handle
	 */
	public void setMaxStorage(int maxFluid);
	
	
	/**
	 * Forward this function to the Base class
	 * @param tagCompound
	 */
	public void readFromNBTI(NBTTagCompound tagCompound);
	
	/**
	 * Forward this function to the Base class
	 * @param tagCompound
	 */
	public void writeToNBTI(NBTTagCompound tagCompound);
	
	/**
	 * Forward this function to the Base class
	 * @param net
	 * @param packet
	 */
	public void onDataPacketI(NetworkManager net, S35PacketUpdateTileEntity packet);
	
	/**
	 * Forward this function to the Base class
	 * @return
	 */
	public Packet getDescriptionPacketI();

	/**
	 * Gets the ammount of fluid stored
	 * @return the ammount of fluid stored
	 */
	public int getStored();

	/**
	 * Sets the amount of fluid stored 
	 * @param maxStorage
	 * @param isOil
	 * @param doNotify TODO
	 */
	public void setStored(int maxStorage, boolean isOil, boolean doNotify);
	
	/**
	 * 
	 * @return if Oil is stored in the tank.
	 */
	public boolean isOilStored();
	
	/**
	 * Sets if oil is stored or not
	 * @param b
	 */
	public void setIsOilStored(boolean b);

	/**
	 * Forward this function the the Base class
	 */
	public void updateEntityI();
	
	/**
	 * Triggers a world.markBlockForUpdate()
	 */
	public void updateBlock();
	
	/**
	 * Forward this to the base class
	 */
	public void invalidateI();

	/**
	 * Call this function if you want the network to be updated
	 * @param oldPressure
	 */
	public void updateNetworkOnNextTick(float oldPressure);

	/**
	 * Call this function if you want the fluids to be equalized troughout the network
	 */
	public void updateFluidOnNextTick();

	/**
	 * Returns the current pressure
	 * @param dir
	 * @return
	 */
	public float getPressure(ForgeDirection dir);

	/**
	 * Returns the max ammount of pressure this machine can handle
	 * @param isOilStored
	 * @param from
	 * @return
	 */
	public float getMaxPressure(boolean isOilStored, ForgeDirection from);

	/**
	 * Returns the max amount of fluid storage for this block
	 * @return
	 */
	public int getMaxStorage();

	/**
	 * Sets the pressure in the network
	 * @param f
	 * @param facing
	 */
	public void setPressure(float f, ForgeDirection facing);

	/**
	 * Use this to tell the base class to tell its target.
	 * Just use init(this);
	 * @param target
	 */
	public void init(TileEntity target);
	public void init(TMultiPart target);
	
	/**
	 * Takes the pressure to add and checks if there is oil in the system.
	 * Use this function to add pressure from a generator
	 * @param pressureToAdd
	 */
	public void addPressureWithRatio(float pressureToAdd, ForgeDirection from);

	/**
	 * Forward this to the handler.
	 */
	void validateI();

	PressureTier getPressureTier();

	
	
}