ForgePatch/common/net/minecraftforge/fluids/Fluid.java

package net.minecraftforge.fluids;

import java.util.Locale;

import net.minecraft.block.Block;
import net.minecraft.util.Icon;
import net.minecraft.util.StatCollector;
import net.minecraft.world.World;
import net.minecraftforge.common.ForgeDummyContainer;
import cpw.mods.fml.common.FMLLog;
import cpw.mods.fml.common.LoaderException;
import cpw.mods.fml.relauncher.Side;
import cpw.mods.fml.relauncher.SideOnly;

/**
 * Minecraft Forge Fluid Implementation
 * 
 * This class is a fluid (liquid or gas) equivalent to "Item." It describes the nature of a fluid
 * and contains its general properties.
 * 
 * These properties do not have inherent gameplay mechanics - they are provided so that mods may
 * choose to take advantage of them.
 * 
 * Fluid implementations are not required to actively use these properties, nor are objects
 * interfacing with fluids required to make use of them, but it is encouraged.
 * 
 * The default values can be used as a reference point for mods adding fluids such as oil or heavy
 * water.
 * 
 * @author King Lemming
 * 
 */
public class Fluid {

    /** The unique identification name for this fluid. */
    protected final String fluidName;

    /** The unlocalized name of this fluid. */
    protected String unlocalizedName;

    /** The Icons for this fluid. */
    @SideOnly(Side.CLIENT)
    protected Icon stillIcon;
    @SideOnly(Side.CLIENT)
    protected Icon flowingIcon;

    /**
     * The light level emitted by this fluid.
     * 
     * Default value is 0, as most fluids do not actively emit light.
     */
    protected int luminosity = 0;

    /**
     * Density of the fluid - completely arbitrary; negative density indicates that the fluid is
     * lighter than air.
     * 
     * Default value is approximately the real-life density of water in kg/m^3.
     */
    protected int density = 1000;

    /**
     * Viscosity ("thickness") of the fluid - completely arbitrary; negative values are not
     * permissible.
     * 
     * Default value is approximately the real-life density of water in m/s^2 (x10^-3).
     */
    protected int viscosity = 1000;

    /**
     * This indicates if the fluid is gaseous.
     * 
     * Useful for rendering the fluid in containers and the world.
     * 
     * Generally this is associated with negative density fluids.
     */
    protected boolean isGaseous;

    /**
     * If there is a Block implementation of the Fluid, the BlockID is linked here.
     * 
     * The default value of -1 should remain for any Fluid without a Block implementation.
     */
    protected int blockID = -1;

    public Fluid(String fluidName) {

        this.fluidName = fluidName.toLowerCase(Locale.ENGLISH);
        this.unlocalizedName = fluidName;
    }

    public Fluid setUnlocalizedName(String unlocalizedName) {

        this.unlocalizedName = unlocalizedName;
        return this;
    }

    public Fluid setBlockID(int blockID) {

        if (this.blockID == -1 || this.blockID == blockID) {
            this.blockID = blockID;
        } else if (!ForgeDummyContainer.forceDuplicateFluidBlockCrash) {
            FMLLog.warning("A mod has attempted to assign BlockID " + blockID + " to the Fluid '" + fluidName + "' but this Fluid has already been linked to BlockID "
                    + this.blockID + ". Configure your mods to prevent this from happening.");
        } else {
            FMLLog.severe("A mod has attempted to assign BlockID " + blockID + " to the Fluid '" + fluidName + "' but this Fluid has already been linked to BlockID "
                    + this.blockID + ". Configure your mods to prevent this from happening.");
            throw new LoaderException(new RuntimeException("A mod has attempted to assign BlockID " + blockID + " to the Fluid '" + fluidName
                    + "' but this Fluid has already been linked to BlockID " + this.blockID + ". Configure your mods to prevent this from happening."));
        }
        return this;
    }

    public Fluid setBlockID(Block block) {

        return setBlockID(block.blockID);
    }

    public Fluid setLuminosity(int luminosity) {

        this.luminosity = luminosity;
        return this;
    }

    public Fluid setDensity(int density) {

        this.density = density;
        return this;
    }

    public Fluid setViscosity(int viscosity) {

        this.viscosity = viscosity;
        return this;
    }

    public Fluid setGaseous(boolean isGaseous) {

        this.isGaseous = isGaseous;
        return this;
    }

    public final String getName() {

        return this.fluidName;
    }

    public final int getID() {

        return FluidRegistry.getFluidID(this.fluidName);
    }

    public final int getBlockID() {

        return blockID;
    }

    public final boolean canBePlacedInWorld() {

        return blockID != -1;
    }

    /**
     * Returns the localized name of this fluid.
     */
    public String getLocalizedName() {

        String s = this.getUnlocalizedName();
        return s == null ? "" : StatCollector.translateToLocal(s);
    }

    /**
     * Returns the unlocalized name of this fluid.
     */
    public String getUnlocalizedName() {

        return "fluid." + this.unlocalizedName;
    }

    /**
     * Returns 0 for "/terrain.png". ALL FLUID TEXTURES MUST BE ON THIS SHEET.
     */
    public final int getSpriteNumber() {

        return 0;
    }

    /* Default Accessors */
    public final int getLuminosity() {

        return this.luminosity;
    }

    public final int getDensity() {

        return this.density;
    }

    public final int getViscosity() {

        return this.viscosity;
    }

    public final boolean isGaseous() {

        return this.isGaseous;
    }

    public int getColor() {

        return 0xFFFFFF;
    }

    /* Stack-based Accessors */
    public int getLuminosity(FluidStack stack) {

        return getLuminosity();
    }

    public int getDensity(FluidStack stack) {

        return getDensity();
    }

    public int getViscosity(FluidStack stack) {

        return getViscosity();
    }

    public boolean isGaseous(FluidStack stack) {

        return isGaseous();
    }

    public int getColor(FluidStack stack) {

        return getColor();
    }

    /* World-based Accessors */
    public int getLuminosity(World world, int x, int y, int z) {

        return getLuminosity();
    }

    public int getDensity(World world, int x, int y, int z) {

        return getDensity();
    }

    public int getViscosity(World world, int x, int y, int z) {

        return getViscosity();
    }

    public boolean isGaseous(World world, int x, int y, int z) {

        return isGaseous();
    }

    public int getColor(World world, int x, int y, int z) {

        return getColor();
    }

    @SideOnly(Side.CLIENT)
    public final Fluid setStillIcon(Icon stillIcon) {

        this.stillIcon = stillIcon;
        return this;
    }

    @SideOnly(Side.CLIENT)
    public final Fluid setFlowingIcon(Icon flowingIcon) {

        this.flowingIcon = flowingIcon;
        return this;
    }

    @SideOnly(Side.CLIENT)
    public final Fluid setIcons(Icon stillIcon, Icon flowingIcon) {

        this.stillIcon = stillIcon;
        this.flowingIcon = flowingIcon;
        return this;
    }

    @SideOnly(Side.CLIENT)
    public final Fluid setIcons(Icon commonIcon) {

        this.stillIcon = commonIcon;
        this.flowingIcon = commonIcon;
        return this;
    }

    @SideOnly(Side.CLIENT)
    public Icon getIcon() {

        return getStillIcon();
    }

    @SideOnly(Side.CLIENT)
    public Icon getIcon(FluidStack stack) {

        return getIcon();
    }

    @SideOnly(Side.CLIENT)
    public Icon getIcon(World world, int x, int y, int z) {

        return getIcon();
    }

    @SideOnly(Side.CLIENT)
    public Icon getStillIcon() {

        return this.stillIcon;
    }

    @SideOnly(Side.CLIENT)
    public Icon getFlowingIcon() {

        return this.flowingIcon;
    }

}