From 0427ab89f1753a44b30cbc35ce021cbbdc845109 Mon Sep 17 00:00:00 2001 From: Foghrye4 Date: Thu, 10 Aug 2017 18:52:45 +0300 Subject: fix missing source folder --- .../net/minecraftforge/fluids/BlockFluidBase.html | 1161 +++++++++++++++++++ .../minecraftforge/fluids/BlockFluidClassic.html | 698 ++++++++++++ .../minecraftforge/fluids/BlockFluidFinite.html | 470 ++++++++ javadoc/net/minecraftforge/fluids/Fluid.html | 1169 ++++++++++++++++++++ .../FluidContainerRegistry.FluidContainerData.html | 344 ++++++ ...tainerRegistry.FluidContainerRegisterEvent.html | 293 +++++ .../fluids/FluidContainerRegistry.html | 586 ++++++++++ .../fluids/FluidEvent.FluidDrainingEvent.html | 374 +++++++ .../fluids/FluidEvent.FluidFillingEvent.html | 374 +++++++ .../fluids/FluidEvent.FluidMotionEvent.html | 300 +++++ .../fluids/FluidEvent.FluidSpilledEvent.html | 301 +++++ javadoc/net/minecraftforge/fluids/FluidEvent.html | 419 +++++++ .../fluids/FluidRegistry.FluidRegisterEvent.html | 308 ++++++ .../net/minecraftforge/fluids/FluidRegistry.html | 488 ++++++++ javadoc/net/minecraftforge/fluids/FluidStack.html | 569 ++++++++++ javadoc/net/minecraftforge/fluids/FluidTank.html | 507 +++++++++ .../net/minecraftforge/fluids/FluidTankInfo.html | 290 +++++ javadoc/net/minecraftforge/fluids/IFluidBlock.html | 294 +++++ .../minecraftforge/fluids/IFluidContainerItem.html | 271 +++++ .../net/minecraftforge/fluids/IFluidHandler.html | 328 ++++++ javadoc/net/minecraftforge/fluids/IFluidTank.html | 295 +++++ .../minecraftforge/fluids/ItemFluidContainer.html | 426 +++++++ .../minecraftforge/fluids/RenderBlockFluid.html | 403 +++++++ .../minecraftforge/fluids/TileFluidHandler.html | 491 ++++++++ .../net/minecraftforge/fluids/package-frame.html | 45 + .../net/minecraftforge/fluids/package-summary.html | 284 +++++ .../net/minecraftforge/fluids/package-tree.html | 174 +++ 27 files changed, 11662 insertions(+) create mode 100644 javadoc/net/minecraftforge/fluids/BlockFluidBase.html create mode 100644 javadoc/net/minecraftforge/fluids/BlockFluidClassic.html create mode 100644 javadoc/net/minecraftforge/fluids/BlockFluidFinite.html create mode 100644 javadoc/net/minecraftforge/fluids/Fluid.html create mode 100644 javadoc/net/minecraftforge/fluids/FluidContainerRegistry.FluidContainerData.html create mode 100644 javadoc/net/minecraftforge/fluids/FluidContainerRegistry.FluidContainerRegisterEvent.html create mode 100644 javadoc/net/minecraftforge/fluids/FluidContainerRegistry.html create mode 100644 javadoc/net/minecraftforge/fluids/FluidEvent.FluidDrainingEvent.html create mode 100644 javadoc/net/minecraftforge/fluids/FluidEvent.FluidFillingEvent.html create mode 100644 javadoc/net/minecraftforge/fluids/FluidEvent.FluidMotionEvent.html create mode 100644 javadoc/net/minecraftforge/fluids/FluidEvent.FluidSpilledEvent.html create mode 100644 javadoc/net/minecraftforge/fluids/FluidEvent.html create mode 100644 javadoc/net/minecraftforge/fluids/FluidRegistry.FluidRegisterEvent.html create mode 100644 javadoc/net/minecraftforge/fluids/FluidRegistry.html create mode 100644 javadoc/net/minecraftforge/fluids/FluidStack.html create mode 100644 javadoc/net/minecraftforge/fluids/FluidTank.html create mode 100644 javadoc/net/minecraftforge/fluids/FluidTankInfo.html create mode 100644 javadoc/net/minecraftforge/fluids/IFluidBlock.html create mode 100644 javadoc/net/minecraftforge/fluids/IFluidContainerItem.html create mode 100644 javadoc/net/minecraftforge/fluids/IFluidHandler.html create mode 100644 javadoc/net/minecraftforge/fluids/IFluidTank.html create mode 100644 javadoc/net/minecraftforge/fluids/ItemFluidContainer.html create mode 100644 javadoc/net/minecraftforge/fluids/RenderBlockFluid.html create mode 100644 javadoc/net/minecraftforge/fluids/TileFluidHandler.html create mode 100644 javadoc/net/minecraftforge/fluids/package-frame.html create mode 100644 javadoc/net/minecraftforge/fluids/package-summary.html create mode 100644 javadoc/net/minecraftforge/fluids/package-tree.html (limited to 'javadoc/net/minecraftforge/fluids') diff --git a/javadoc/net/minecraftforge/fluids/BlockFluidBase.html b/javadoc/net/minecraftforge/fluids/BlockFluidBase.html new file mode 100644 index 0000000..0bc06ce --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/BlockFluidBase.html @@ -0,0 +1,1161 @@ + + + + + +BlockFluidBase (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class BlockFluidBase

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    IFluidBlock
    +
    +
    +
    Direct Known Subclasses:
    +
    BlockFluidClassic, BlockFluidFinite
    +
    +
    +
    +
    public abstract class BlockFluidBase
+extends Block
+implements IFluidBlock
    +
    This is a base implementation for Fluid blocks. + + It is highly recommended that you extend this class or one of the Forge-provided child classes.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        defaultDisplacements

        +
        protected static final java.util.Map<Block,java.lang.Boolean> defaultDisplacements
        +
        • +
      + + + +
        +
      • +

        displacements

        +
        protected java.util.Map<Block,java.lang.Boolean> displacements
        +
        • +
      + + + +
        +
      • +

        quantaPerBlock

        +
        protected int quantaPerBlock
        +
        • +
      + + + +
        +
      • +

        quantaPerBlockFloat

        +
        protected float quantaPerBlockFloat
        +
        • +
      + + + +
        +
      • +

        density

        +
        protected int density
        +
        • +
      + + + +
        +
      • +

        densityDir

        +
        protected int densityDir
        +
        • +
      + + + +
        +
      • +

        temperature

        +
        protected int temperature
        +
        • +
      + + + +
        +
      • +

        tickRate

        +
        protected int tickRate
        +
        • +
      + + + +
        +
      • +

        renderPass

        +
        protected int renderPass
        +
        • +
      + + + +
        +
      • +

        maxScaledLight

        +
        protected int maxScaledLight
        +
        • +
      + + + +
        +
      • +

        fluidName

        +
        protected final java.lang.String fluidName
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BlockFluidBase

        +
        public BlockFluidBase(Fluid fluid,
+              Material material)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setQuantaPerBlock

        +
        public BlockFluidBase setQuantaPerBlock(int quantaPerBlock)
        +
        • +
      + + + + + + + +
        +
      • +

        setTemperature

        +
        public BlockFluidBase setTemperature(int temperature)
        +
        • +
      + + + +
        +
      • +

        setTickRate

        +
        public BlockFluidBase setTickRate(int tickRate)
        +
        • +
      + + + +
        +
      • +

        setRenderPass

        +
        public BlockFluidBase setRenderPass(int renderPass)
        +
        • +
      + + + +
        +
      • +

        setMaxScaledLight

        +
        public BlockFluidBase setMaxScaledLight(int maxScaledLight)
        +
        • +
      + + + +
        +
      • +

        canDisplace

        +
        public boolean canDisplace(IBlockAccess world,
+                  int x,
+                  int y,
+                  int z)
        +
        Returns true if the block at (x, y, z) is displaceable. Does not displace the block.
        +
        • +
      + + + +
        +
      • +

        displaceIfPossible

        +
        public boolean displaceIfPossible(World world,
+                         int x,
+                         int y,
+                         int z)
        +
        Attempt to displace the block at (x, y, z), return true if it was displaced.
        +
        • +
      + + + +
        +
      • +

        getQuantaValue

        +
        public abstract int getQuantaValue(IBlockAccess world,
+                 int x,
+                 int y,
+                 int z)
        +
        • +
      + + + +
        +
      • +

        canCollideCheck

        +
        public abstract boolean canCollideCheck(int meta,
+                      boolean fullHit)
        +
        +
        Overrides:
        +
        canCollideCheck in class Block
        +
        +
        • +
      + + + +
        +
      • +

        getMaxRenderHeightMeta

        +
        public abstract int getMaxRenderHeightMeta()
        +
        • +
      + + + +
        +
      • +

        onBlockAdded

        +
        public void onBlockAdded(World world,
+                int x,
+                int y,
+                int z)
        +
        +
        Overrides:
        +
        onBlockAdded in class Block
        +
        +
        • +
      + + + +
        +
      • +

        onNeighborBlockChange

        +
        public void onNeighborBlockChange(World world,
+                         int x,
+                         int y,
+                         int z,
+                         Block block)
        +
        +
        Overrides:
        +
        onNeighborBlockChange in class Block
        +
        +
        • +
      + + + +
        +
      • +

        func_149698_L

        +
        public boolean func_149698_L()
        +
        +
        Overrides:
        +
        func_149698_L in class Block
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        getItemDropped

        +
        public Item getItemDropped(int par1,
+                  java.util.Random par2Random,
+                  int par3)
        +
        +
        Overrides:
        +
        getItemDropped in class Block
        +
        +
        • +
      + + + +
        +
      • +

        quantityDropped

        +
        public int quantityDropped(java.util.Random par1Random)
        +
        +
        Overrides:
        +
        quantityDropped in class Block
        +
        +
        • +
      + + + +
        +
      • +

        tickRate

        +
        public int tickRate(World world)
        +
        +
        Overrides:
        +
        tickRate in class Block
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getLightValue

        +
        public int getLightValue(IBlockAccess world,
+                int x,
+                int y,
+                int z)
        +
        Description copied from class: Block
        +
        Get a light value for the block at the specified coordinates, normal ranges are between 0 and 15
        +
        +
        Overrides:
        +
        getLightValue in class Block
        +
        Parameters:
        world - The current world
        x - X Position
        y - Y position
        z - Z position
        +
        Returns:
        The light value
        +
        • +
      + + + +
        +
      • +

        getRenderType

        +
        public int getRenderType()
        +
        +
        Overrides:
        +
        getRenderType in class Block
        +
        +
        • +
      + + + +
        +
      • +

        isOpaqueCube

        +
        public boolean isOpaqueCube()
        +
        +
        Overrides:
        +
        isOpaqueCube in class Block
        +
        +
        • +
      + + + +
        +
      • +

        renderAsNormalBlock

        +
        public boolean renderAsNormalBlock()
        +
        +
        Overrides:
        +
        renderAsNormalBlock in class Block
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        shouldSideBeRendered

        +
        public boolean shouldSideBeRendered(IBlockAccess world,
+                           int x,
+                           int y,
+                           int z,
+                           int side)
        +
        +
        Overrides:
        +
        shouldSideBeRendered in class Block
        +
        +
        • +
      + + + +
        +
      • +

        getDensity

        +
        public static final int getDensity(IBlockAccess world,
+             int x,
+             int y,
+             int z)
        +
        • +
      + + + +
        +
      • +

        getTemperature

        +
        public static final int getTemperature(IBlockAccess world,
+                 int x,
+                 int y,
+                 int z)
        +
        • +
      + + + +
        +
      • +

        getFlowDirection

        +
        public static double getFlowDirection(IBlockAccess world,
+                      int x,
+                      int y,
+                      int z)
        +
        • +
      + + + +
        +
      • +

        getQuantaValueBelow

        +
        public final int getQuantaValueBelow(IBlockAccess world,
+                      int x,
+                      int y,
+                      int z,
+                      int belowThis)
        +
        • +
      + + + +
        +
      • +

        getQuantaValueAbove

        +
        public final int getQuantaValueAbove(IBlockAccess world,
+                      int x,
+                      int y,
+                      int z,
+                      int aboveThis)
        +
        • +
      + + + +
        +
      • +

        getQuantaPercentage

        +
        public final float getQuantaPercentage(IBlockAccess world,
+                        int x,
+                        int y,
+                        int z)
        +
        • +
      + + + +
        +
      • +

        getFlowVector

        +
        public Vec3 getFlowVector(IBlockAccess world,
+                 int x,
+                 int y,
+                 int z)
        +
        • +
      + + + +
        +
      • +

        getFluid

        +
        public Fluid getFluid()
        +
        Description copied from interface: IFluidBlock
        +
        Returns the Fluid associated with this Block.
        +
        +
        Specified by:
        +
        getFluid in interface IFluidBlock
        +
        +
        • +
      + + + +
        +
      • +

        getFilledPercentage

        +
        public float getFilledPercentage(World world,
+                        int x,
+                        int y,
+                        int z)
        +
        Description copied from interface: IFluidBlock
        +
        Returns the amount of a single block is filled. Value between 0 and 1. + 1 meaning the entire 1x1x1 cube is full, 0 meaning completely empty. + + If the return value is negative. It will be treated as filling the block + from the top down instead of bottom up.
        +
        +
        Specified by:
        +
        getFilledPercentage in interface IFluidBlock
        +
        Returns:
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/BlockFluidClassic.html b/javadoc/net/minecraftforge/fluids/BlockFluidClassic.html new file mode 100644 index 0000000..aabb44e --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/BlockFluidClassic.html @@ -0,0 +1,698 @@ + + + + + +BlockFluidClassic (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class BlockFluidClassic

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    IFluidBlock
    +
    +
    +
    +
    public class BlockFluidClassic
+extends BlockFluidBase
    +
    This is a fluid block implementation which emulates vanilla Minecraft fluid behavior. + + It is highly recommended that you use/extend this class for "classic" fluid blocks.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        isOptimalFlowDirection

        +
        protected boolean[] isOptimalFlowDirection
        +
        • +
      + + + +
        +
      • +

        flowCost

        +
        protected int[] flowCost
        +
        • +
      + + + + +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BlockFluidClassic

        +
        public BlockFluidClassic(Fluid fluid,
+                 Material material)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        setFluidStackAmount

        +
        public BlockFluidClassic setFluidStackAmount(int amount)
        +
        • +
      + + + + + + + +
        +
      • +

        canCollideCheck

        +
        public boolean canCollideCheck(int meta,
+                      boolean fullHit)
        +
        +
        Specified by:
        +
        canCollideCheck in class BlockFluidBase
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getLightValue

        +
        public int getLightValue(IBlockAccess world,
+                int x,
+                int y,
+                int z)
        +
        Description copied from class: Block
        +
        Get a light value for the block at the specified coordinates, normal ranges are between 0 and 15
        +
        +
        Overrides:
        +
        getLightValue in class BlockFluidBase
        +
        Parameters:
        world - The current world
        x - X Position
        y - Y position
        z - Z position
        +
        Returns:
        The light value
        +
        • +
      + + + +
        +
      • +

        updateTick

        +
        public void updateTick(World world,
+              int x,
+              int y,
+              int z,
+              java.util.Random rand)
        +
        +
        Overrides:
        +
        updateTick in class Block
        +
        +
        • +
      + + + +
        +
      • +

        isFlowingVertically

        +
        public boolean isFlowingVertically(IBlockAccess world,
+                          int x,
+                          int y,
+                          int z)
        +
        • +
      + + + +
        +
      • +

        isSourceBlock

        +
        public boolean isSourceBlock(IBlockAccess world,
+                    int x,
+                    int y,
+                    int z)
        +
        • +
      + + + +
        +
      • +

        getOptimalFlowDirections

        +
        protected boolean[] getOptimalFlowDirections(World world,
+                                 int x,
+                                 int y,
+                                 int z)
        +
        • +
      + + + +
        +
      • +

        calculateFlowCost

        +
        protected int calculateFlowCost(World world,
+                    int x,
+                    int y,
+                    int z,
+                    int recurseDepth,
+                    int side)
        +
        • +
      + + + +
        +
      • +

        flowIntoBlock

        +
        protected void flowIntoBlock(World world,
+                 int x,
+                 int y,
+                 int z,
+                 int meta)
        +
        • +
      + + + +
        +
      • +

        canFlowInto

        +
        protected boolean canFlowInto(IBlockAccess world,
+                  int x,
+                  int y,
+                  int z)
        +
        • +
      + + + +
        +
      • +

        getLargerQuanta

        +
        protected int getLargerQuanta(IBlockAccess world,
+                  int x,
+                  int y,
+                  int z,
+                  int compare)
        +
        • +
      + + + +
        +
      • +

        drain

        +
        public FluidStack drain(World world,
+               int x,
+               int y,
+               int z,
+               boolean doDrain)
        +
        Description copied from interface: IFluidBlock
        +
        Attempt to drain the block. This method should be called by devices such as pumps. + + NOTE: The block is intended to handle its own state changes.
        +
        doDrain - If false, the drain will only be simulated.
        +
        Returns:
        +
        • +
      + + + +
        +
      • +

        canDrain

        +
        public boolean canDrain(World world,
+               int x,
+               int y,
+               int z)
        +
        Description copied from interface: IFluidBlock
        +
        Check to see if a block can be drained. This method should be called by devices such as + pumps.
        +
        Returns:
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/BlockFluidFinite.html b/javadoc/net/minecraftforge/fluids/BlockFluidFinite.html new file mode 100644 index 0000000..aa1e059 --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/BlockFluidFinite.html @@ -0,0 +1,470 @@ + + + + + +BlockFluidFinite (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class BlockFluidFinite

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    IFluidBlock
    +
    +
    +
    +
    public class BlockFluidFinite
+extends BlockFluidBase
    +
    This is a cellular-automata based finite fluid block implementation. + + It is highly recommended that you use/extend this class for finite fluid blocks.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BlockFluidFinite

        +
        public BlockFluidFinite(Fluid fluid,
+                Material material)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        canCollideCheck

        +
        public boolean canCollideCheck(int meta,
+                      boolean fullHit)
        +
        +
        Specified by:
        +
        canCollideCheck in class BlockFluidBase
        +
        +
        • +
      + + + + + + + +
        +
      • +

        updateTick

        +
        public void updateTick(World world,
+              int x,
+              int y,
+              int z,
+              java.util.Random rand)
        +
        +
        Overrides:
        +
        updateTick in class Block
        +
        +
        • +
      + + + +
        +
      • +

        tryToFlowVerticallyInto

        +
        public int tryToFlowVerticallyInto(World world,
+                          int x,
+                          int y,
+                          int z,
+                          int amtToInput)
        +
        • +
      + + + +
        +
      • +

        drain

        +
        public FluidStack drain(World world,
+               int x,
+               int y,
+               int z,
+               boolean doDrain)
        +
        Description copied from interface: IFluidBlock
        +
        Attempt to drain the block. This method should be called by devices such as pumps. + + NOTE: The block is intended to handle its own state changes.
        +
        doDrain - If false, the drain will only be simulated.
        +
        Returns:
        +
        • +
      + + + +
        +
      • +

        canDrain

        +
        public boolean canDrain(World world,
+               int x,
+               int y,
+               int z)
        +
        Description copied from interface: IFluidBlock
        +
        Check to see if a block can be drained. This method should be called by devices such as + pumps.
        +
        Returns:
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/Fluid.html b/javadoc/net/minecraftforge/fluids/Fluid.html new file mode 100644 index 0000000..0b91ec0 --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/Fluid.html @@ -0,0 +1,1169 @@ + + + + + +Fluid (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class Fluid

+
+
+ +
+
    +
  • +
    +
    +
    public class Fluid
+extends java.lang.Object
    +
    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.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        fluidName

        +
        protected final java.lang.String fluidName
        +
        The unique identification name for this fluid.
        +
        • +
      + + + +
        +
      • +

        unlocalizedName

        +
        protected java.lang.String unlocalizedName
        +
        The unlocalized name of this fluid.
        +
        • +
      + + + +
        +
      • +

        stillIcon

        +
        protected IIcon stillIcon
        +
        The Icons for this fluid.
        +
        • +
      + + + +
        +
      • +

        flowingIcon

        +
        protected IIcon flowingIcon
        +
        • +
      + + + +
        +
      • +

        luminosity

        +
        protected int luminosity
        +
        The light level emitted by this fluid. + + Default value is 0, as most fluids do not actively emit light.
        +
        • +
      + + + +
        +
      • +

        density

        +
        protected int density
        +
        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.
        +
        • +
      + + + +
        +
      • +

        temperature

        +
        protected int temperature
        +
        Temperature of the fluid - completely arbitrary; higher temperature indicates that the fluid is + hotter than air. + + Default value is approximately the real-life room temperature of water in degrees Kelvin.
        +
        • +
      + + + +
        +
      • +

        viscosity

        +
        protected int viscosity
        +
        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).
        +
        • +
      + + + +
        +
      • +

        isGaseous

        +
        protected boolean isGaseous
        +
        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.
        +
        • +
      + + + +
        +
      • +

        rarity

        +
        protected EnumRarity rarity
        +
        The rarity of the fluid. + + Used primarily in tool tips.
        +
        • +
      + + + +
        +
      • +

        block

        +
        protected Block block
        +
        If there is a Block implementation of the Fluid, the Block is linked here. + + The default value of null should remain for any Fluid without a Block implementation.
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Fluid

        +
        public Fluid(java.lang.String fluidName)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setUnlocalizedName

        +
        public Fluid setUnlocalizedName(java.lang.String unlocalizedName)
        +
        • +
      + + + +
        +
      • +

        setBlock

        +
        public Fluid setBlock(Block block)
        +
        • +
      + + + +
        +
      • +

        setLuminosity

        +
        public Fluid setLuminosity(int luminosity)
        +
        • +
      + + + +
        +
      • +

        setDensity

        +
        public Fluid setDensity(int density)
        +
        • +
      + + + +
        +
      • +

        setTemperature

        +
        public Fluid setTemperature(int temperature)
        +
        • +
      + + + +
        +
      • +

        setViscosity

        +
        public Fluid setViscosity(int viscosity)
        +
        • +
      + + + +
        +
      • +

        setGaseous

        +
        public Fluid setGaseous(boolean isGaseous)
        +
        • +
      + + + + + + + +
        +
      • +

        getName

        +
        public final java.lang.String getName()
        +
        • +
      + + + +
        +
      • +

        getID

        +
        public final int getID()
        +
        • +
      + + + +
        +
      • +

        getBlock

        +
        public final Block getBlock()
        +
        • +
      + + + +
        +
      • +

        canBePlacedInWorld

        +
        public final boolean canBePlacedInWorld()
        +
        • +
      + + + +
        +
      • +

        getLocalizedName

        +
        public java.lang.String getLocalizedName(FluidStack stack)
        +
        Returns the localized name of this fluid.
        +
        • +
      + + + +
        +
      • +

        getLocalizedName

        +
        @Deprecated
+public java.lang.String getLocalizedName()
        +
        Deprecated. 
        +
        Use the FluidStack sensitive version above
        +
        • +
      + + + +
        +
      • +

        getUnlocalizedName

        +
        public java.lang.String getUnlocalizedName(FluidStack stack)
        +
        A FluidStack sensitive version of getUnlocalizedName
        +
        • +
      + + + +
        +
      • +

        getUnlocalizedName

        +
        public java.lang.String getUnlocalizedName()
        +
        Returns the unlocalized name of this fluid.
        +
        • +
      + + + +
        +
      • +

        getSpriteNumber

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

        getLuminosity

        +
        public final int getLuminosity()
        +
        • +
      + + + +
        +
      • +

        getDensity

        +
        public final int getDensity()
        +
        • +
      + + + +
        +
      • +

        getTemperature

        +
        public final int getTemperature()
        +
        • +
      + + + +
        +
      • +

        getViscosity

        +
        public final int getViscosity()
        +
        • +
      + + + +
        +
      • +

        isGaseous

        +
        public final boolean isGaseous()
        +
        • +
      + + + +
        +
      • +

        getRarity

        +
        public EnumRarity getRarity()
        +
        • +
      + + + +
        +
      • +

        getColor

        +
        public int getColor()
        +
        • +
      + + + +
        +
      • +

        setStillIcon

        +
        public final Fluid setStillIcon(IIcon stillIcon)
        +
        • +
      + + + +
        +
      • +

        setFlowingIcon

        +
        public final Fluid setFlowingIcon(IIcon flowingIcon)
        +
        • +
      + + + +
        +
      • +

        setIcons

        +
        public final Fluid setIcons(IIcon stillIcon,
+             IIcon flowingIcon)
        +
        • +
      + + + +
        +
      • +

        setIcons

        +
        public final Fluid setIcons(IIcon commonIcon)
        +
        • +
      + + + +
        +
      • +

        getIcon

        +
        public IIcon getIcon()
        +
        • +
      + + + +
        +
      • +

        getStillIcon

        +
        public IIcon getStillIcon()
        +
        • +
      + + + +
        +
      • +

        getFlowingIcon

        +
        public IIcon getFlowingIcon()
        +
        • +
      + + + +
        +
      • +

        getLuminosity

        +
        public int getLuminosity(FluidStack stack)
        +
        • +
      + + + +
        +
      • +

        getDensity

        +
        public int getDensity(FluidStack stack)
        +
        • +
      + + + +
        +
      • +

        getTemperature

        +
        public int getTemperature(FluidStack stack)
        +
        • +
      + + + +
        +
      • +

        getViscosity

        +
        public int getViscosity(FluidStack stack)
        +
        • +
      + + + +
        +
      • +

        isGaseous

        +
        public boolean isGaseous(FluidStack stack)
        +
        • +
      + + + + + + + +
        +
      • +

        getColor

        +
        public int getColor(FluidStack stack)
        +
        • +
      + + + + + + + +
        +
      • +

        getLuminosity

        +
        public int getLuminosity(World world,
+                int x,
+                int y,
+                int z)
        +
        • +
      + + + +
        +
      • +

        getDensity

        +
        public int getDensity(World world,
+             int x,
+             int y,
+             int z)
        +
        • +
      + + + +
        +
      • +

        getTemperature

        +
        public int getTemperature(World world,
+                 int x,
+                 int y,
+                 int z)
        +
        • +
      + + + +
        +
      • +

        getViscosity

        +
        public int getViscosity(World world,
+               int x,
+               int y,
+               int z)
        +
        • +
      + + + +
        +
      • +

        isGaseous

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

        getRarity

        +
        public EnumRarity getRarity(World world,
+                   int x,
+                   int y,
+                   int z)
        +
        • +
      + + + +
        +
      • +

        getColor

        +
        public int getColor(World world,
+           int x,
+           int y,
+           int z)
        +
        • +
      + + + +
        +
      • +

        getIcon

        +
        public IIcon getIcon(World world,
+            int x,
+            int y,
+            int z)
        +
        • +
      + + + +
        +
      • +

        registerLegacyName

        +
        public static void registerLegacyName(java.lang.String legacyName,
+                      java.lang.String canonicalName)
        +
        Register a legacy liquid name with the Fluids system
        +
        Parameters:
        legacyName - The legacy name to recognize
        canonicalName - The canonical fluid name it will become
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/FluidContainerRegistry.FluidContainerData.html b/javadoc/net/minecraftforge/fluids/FluidContainerRegistry.FluidContainerData.html new file mode 100644 index 0000000..033bc06 --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/FluidContainerRegistry.FluidContainerData.html @@ -0,0 +1,344 @@ + + + + + +FluidContainerRegistry.FluidContainerData (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class FluidContainerRegistry.FluidContainerData

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    FluidContainerRegistry
    +
    +
    +
    +
    public static class FluidContainerRegistry.FluidContainerData
+extends java.lang.Object
    +
    Wrapper class for the registry entries. Ensures that none of the attempted registrations + contain null references unless permitted.
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/FluidContainerRegistry.FluidContainerRegisterEvent.html b/javadoc/net/minecraftforge/fluids/FluidContainerRegistry.FluidContainerRegisterEvent.html new file mode 100644 index 0000000..9af3599 --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/FluidContainerRegistry.FluidContainerRegisterEvent.html @@ -0,0 +1,293 @@ + + + + + +FluidContainerRegistry.FluidContainerRegisterEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class FluidContainerRegistry.FluidContainerRegisterEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    FluidContainerRegistry
    +
    +
    +
    +
    public static class FluidContainerRegistry.FluidContainerRegisterEvent
+extends Event
    +
    • +
+
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/FluidContainerRegistry.html b/javadoc/net/minecraftforge/fluids/FluidContainerRegistry.html new file mode 100644 index 0000000..2b5be34 --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/FluidContainerRegistry.html @@ -0,0 +1,586 @@ + + + + + +FluidContainerRegistry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class FluidContainerRegistry

+
+
+ +
+
    +
  • +
    +
    +
    public abstract class FluidContainerRegistry
+extends java.lang.Object
    +
    Register simple items that contain fluids here. Useful for buckets, bottles, and things that have + ID/metadata mappings. + + For more complex items, use IFluidContainerItem instead.
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        registerFluidContainer

        +
        public static boolean registerFluidContainer(FluidStack stack,
+                             ItemStack filledContainer,
+                             ItemStack emptyContainer)
        +
        Register a new fluid containing item.
        +
        Parameters:
        stack - FluidStack containing the type and amount of the fluid stored in the item.
        filledContainer - ItemStack representing the container when it is full.
        emptyContainer - ItemStack representing the container when it is empty.
        +
        Returns:
        True if container was successfully registered; false if it already is.
        +
        • +
      + + + +
        +
      • +

        registerFluidContainer

        +
        public static boolean registerFluidContainer(Fluid fluid,
+                             ItemStack filledContainer,
+                             ItemStack emptyContainer)
        +
        Register a new fluid containing item. The item is assumed to hold 1000 mB of fluid. Also + registers the Fluid if possible.
        +
        Parameters:
        fluid - Fluid type that is stored in the item.
        filledContainer - ItemStack representing the container when it is full.
        emptyContainer - ItemStack representing the container when it is empty.
        +
        Returns:
        True if container was successfully registered; false if it already is.
        +
        • +
      + + + +
        +
      • +

        registerFluidContainer

        +
        public static boolean registerFluidContainer(FluidStack stack,
+                             ItemStack filledContainer)
        +
        Register a new fluid containing item that does not have an empty container.
        +
        Parameters:
        stack - FluidStack containing the type and amount of the fluid stored in the item.
        filledContainer - ItemStack representing the container when it is full.
        +
        Returns:
        True if container was successfully registered; false if it already is.
        +
        • +
      + + + +
        +
      • +

        registerFluidContainer

        +
        public static boolean registerFluidContainer(Fluid fluid,
+                             ItemStack filledContainer)
        +
        Register a new fluid containing item that does not have an empty container. The item is + assumed to hold 1000 mB of fluid. Also registers the Fluid if possible.
        +
        Parameters:
        fluid - Fluid type that is stored in the item.
        filledContainer - ItemStack representing the container when it is full.
        +
        Returns:
        True if container was successfully registered; false if it already is.
        +
        • +
      + + + + + + + +
        +
      • +

        getFluidForFilledItem

        +
        public static FluidStack getFluidForFilledItem(ItemStack container)
        +
        Determines the fluid type and amount inside a container.
        +
        Parameters:
        container - The fluid container.
        +
        Returns:
        FluidStack representing stored fluid.
        +
        • +
      + + + +
        +
      • +

        fillFluidContainer

        +
        public static ItemStack fillFluidContainer(FluidStack fluid,
+                           ItemStack container)
        +
        Attempts to fill an empty container with a fluid. + + NOTE: Returns null on fail, NOT the empty container.
        +
        Parameters:
        fluid - FluidStack containing the type and amount of fluid to fill.
        container - ItemStack representing the empty container.
        +
        Returns:
        Filled container if successful, otherwise null.
        +
        • +
      + + + +
        +
      • +

        drainFluidContainer

        +
        public static ItemStack drainFluidContainer(ItemStack container)
        +
        Attempts to empty a full container.
        +
        Parameters:
        container - ItemStack representing the full container.
        +
        Returns:
        Empty container if successful, otherwise null.
        +
        • +
      + + + +
        +
      • +

        getContainerCapacity

        +
        public static int getContainerCapacity(ItemStack container)
        +
        Determines the capacity of a full container.
        +
        Parameters:
        container - The full container.
        +
        Returns:
        The containers capacity, or 0 if the ItemStack does not represent + a registered container.
        +
        • +
      + + + +
        +
      • +

        getContainerCapacity

        +
        public static int getContainerCapacity(FluidStack fluid,
+                       ItemStack container)
        +
        Determines the capacity of a container.
        +
        Parameters:
        fluid - FluidStack containing the type of fluid the capacity should be + determined for (ignored for full containers).
        container - The container (full or empty).
        +
        Returns:
        The containers capacity, or 0 if the ItemStack does not represent + a registered container or the FluidStack is not registered with + the empty container.
        +
        • +
      + + + +
        +
      • +

        containsFluid

        +
        public static boolean containsFluid(ItemStack container,
+                    FluidStack fluid)
        +
        Determines if a container holds a specific fluid.
        +
        • +
      + + + +
        +
      • +

        isBucket

        +
        public static boolean isBucket(ItemStack container)
        +
        • +
      + + + +
        +
      • +

        isContainer

        +
        public static boolean isContainer(ItemStack container)
        +
        • +
      + + + +
        +
      • +

        isEmptyContainer

        +
        public static boolean isEmptyContainer(ItemStack container)
        +
        • +
      + + + +
        +
      • +

        isFilledContainer

        +
        public static boolean isFilledContainer(ItemStack container)
        +
        • +
      + + + + +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/FluidEvent.FluidDrainingEvent.html b/javadoc/net/minecraftforge/fluids/FluidEvent.FluidDrainingEvent.html new file mode 100644 index 0000000..403acca --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/FluidEvent.FluidDrainingEvent.html @@ -0,0 +1,374 @@ + + + + + +FluidEvent.FluidDrainingEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class FluidEvent.FluidDrainingEvent

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + + + + + +
        +
      • +

        amount

        +
        public final int amount
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FluidEvent.FluidDrainingEvent

        +
        @Deprecated
+public FluidEvent.FluidDrainingEvent(FluidStack fluid,
+                                        World world,
+                                        int x,
+                                        int y,
+                                        int z,
+                                        IFluidTank tank)
        +
        Deprecated. Will be removed in 1.8
        +
        • +
      + + + +
        +
      • +

        FluidEvent.FluidDrainingEvent

        +
        public FluidEvent.FluidDrainingEvent(FluidStack fluid,
+                             World world,
+                             int x,
+                             int y,
+                             int z,
+                             IFluidTank tank,
+                             int amount)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/FluidEvent.FluidFillingEvent.html b/javadoc/net/minecraftforge/fluids/FluidEvent.FluidFillingEvent.html new file mode 100644 index 0000000..0e121a0 --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/FluidEvent.FluidFillingEvent.html @@ -0,0 +1,374 @@ + + + + + +FluidEvent.FluidFillingEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class FluidEvent.FluidFillingEvent

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + + + + + +
        +
      • +

        amount

        +
        public final int amount
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FluidEvent.FluidFillingEvent

        +
        @Deprecated
+public FluidEvent.FluidFillingEvent(FluidStack fluid,
+                                       World world,
+                                       int x,
+                                       int y,
+                                       int z,
+                                       IFluidTank tank)
        +
        Deprecated. Will be removed in 1.8
        +
        • +
      + + + +
        +
      • +

        FluidEvent.FluidFillingEvent

        +
        public FluidEvent.FluidFillingEvent(FluidStack fluid,
+                            World world,
+                            int x,
+                            int y,
+                            int z,
+                            IFluidTank tank,
+                            int amount)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/FluidEvent.FluidMotionEvent.html b/javadoc/net/minecraftforge/fluids/FluidEvent.FluidMotionEvent.html new file mode 100644 index 0000000..fc7f16a --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/FluidEvent.FluidMotionEvent.html @@ -0,0 +1,300 @@ + + + + + +FluidEvent.FluidMotionEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class FluidEvent.FluidMotionEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    FluidEvent
    +
    +
    +
    +
    public static class FluidEvent.FluidMotionEvent
+extends FluidEvent
    +
    Mods should fire this event when they move fluids around.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FluidEvent.FluidMotionEvent

        +
        public FluidEvent.FluidMotionEvent(FluidStack fluid,
+                           World world,
+                           int x,
+                           int y,
+                           int z)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/FluidEvent.FluidSpilledEvent.html b/javadoc/net/minecraftforge/fluids/FluidEvent.FluidSpilledEvent.html new file mode 100644 index 0000000..b3e6f83 --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/FluidEvent.FluidSpilledEvent.html @@ -0,0 +1,301 @@ + + + + + +FluidEvent.FluidSpilledEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class FluidEvent.FluidSpilledEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    FluidEvent
    +
    +
    +
    +
    public static class FluidEvent.FluidSpilledEvent
+extends FluidEvent
    +
    Mods should fire this event when a fluid "spills", for example, if a block containing fluid + is broken.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FluidEvent.FluidSpilledEvent

        +
        public FluidEvent.FluidSpilledEvent(FluidStack fluid,
+                            World world,
+                            int x,
+                            int y,
+                            int z)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ +
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/FluidEvent.html b/javadoc/net/minecraftforge/fluids/FluidEvent.html new file mode 100644 index 0000000..bf39397 --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/FluidEvent.html @@ -0,0 +1,419 @@ + + + + + +FluidEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class FluidEvent

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + + + + + +
        +
      • +

        x

        +
        public final int x
        +
        • +
      + + + +
        +
      • +

        y

        +
        public final int y
        +
        • +
      + + + +
        +
      • +

        z

        +
        public final int z
        +
        • +
      + + + +
        +
      • +

        world

        +
        public final World world
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FluidEvent

        +
        public FluidEvent(FluidStack fluid,
+          World world,
+          int x,
+          int y,
+          int z)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        fireEvent

        +
        public static final void fireEvent(FluidEvent event)
        +
        A handy shortcut for firing the various fluid events.
        +
        Parameters:
        event -
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/FluidRegistry.FluidRegisterEvent.html b/javadoc/net/minecraftforge/fluids/FluidRegistry.FluidRegisterEvent.html new file mode 100644 index 0000000..d72b7bc --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/FluidRegistry.FluidRegisterEvent.html @@ -0,0 +1,308 @@ + + + + + +FluidRegistry.FluidRegisterEvent (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class FluidRegistry.FluidRegisterEvent

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    FluidRegistry
    +
    +
    +
    +
    public static class FluidRegistry.FluidRegisterEvent
+extends Event
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        fluidName

        +
        public final java.lang.String fluidName
        +
        • +
      + + + +
        +
      • +

        fluidID

        +
        public final int fluidID
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FluidRegistry.FluidRegisterEvent

        +
        public FluidRegistry.FluidRegisterEvent(java.lang.String fluidName,
+                                int fluidID)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/FluidRegistry.html b/javadoc/net/minecraftforge/fluids/FluidRegistry.html new file mode 100644 index 0000000..ae3c6bf --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/FluidRegistry.html @@ -0,0 +1,488 @@ + + + + + +FluidRegistry (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class FluidRegistry

+
+
+ +
+
    +
  • +
    +
    +
    public abstract class FluidRegistry
+extends java.lang.Object
    +
    Handles Fluid registrations. Fluids MUST be registered in order to function.
    +
    • +
+
+
+
    +
  • + + + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static FluidgetFluid(int fluidID) 
      static FluidgetFluid(java.lang.String fluidName) 
      static intgetFluidID(java.lang.String fluidName) 
      static java.lang.StringgetFluidName(FluidStack stack) 
      static java.lang.StringgetFluidName(int fluidID) 
      static FluidStackgetFluidStack(java.lang.String fluidName, + int amount) 
      static intgetMaxID() 
      static java.util.Map<java.lang.String,java.lang.Integer>getRegisteredFluidIDs() +
      Returns a read-only map containing Fluid Names and their associated IDs.
      +
      static java.util.Map<java.lang.String,Fluid>getRegisteredFluids() +
      Returns a read-only map containing Fluid Names and their associated Fluids.
      +
      static voidinitFluidIDs(com.google.common.collect.BiMap<java.lang.String,java.lang.Integer> newfluidIDs) +
      Called by Forge to prepare the ID map for server -> client sync.
      +
      static booleanisFluidRegistered(Fluid fluid) 
      static booleanisFluidRegistered(java.lang.String fluidName) 
      static FluidlookupFluidForBlock(Block block) 
      static booleanregisterFluid(Fluid fluid) +
      Register a new Fluid.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        WATER

        +
        public static final Fluid WATER
        +
        • +
      + + + +
        +
      • +

        LAVA

        +
        public static final Fluid LAVA
        +
        • +
      + + + +
        +
      • +

        renderIdFluid

        +
        public static int renderIdFluid
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        initFluidIDs

        +
        public static void initFluidIDs(com.google.common.collect.BiMap<java.lang.String,java.lang.Integer> newfluidIDs)
        +
        Called by Forge to prepare the ID map for server -> client sync. + Modders, DO NOT call this.
        +
        • +
      + + + +
        +
      • +

        registerFluid

        +
        public static boolean registerFluid(Fluid fluid)
        +
        Register a new Fluid. If a fluid with the same name already exists, registration is denied.
        +
        Parameters:
        fluid - The fluid to register.
        +
        Returns:
        True if the fluid was successfully registered; false if there is a name clash.
        +
        • +
      + + + +
        +
      • +

        isFluidRegistered

        +
        public static boolean isFluidRegistered(Fluid fluid)
        +
        • +
      + + + +
        +
      • +

        isFluidRegistered

        +
        public static boolean isFluidRegistered(java.lang.String fluidName)
        +
        • +
      + + + +
        +
      • +

        getFluid

        +
        public static Fluid getFluid(java.lang.String fluidName)
        +
        • +
      + + + +
        +
      • +

        getFluid

        +
        public static Fluid getFluid(int fluidID)
        +
        • +
      + + + +
        +
      • +

        getFluidName

        +
        public static java.lang.String getFluidName(int fluidID)
        +
        • +
      + + + +
        +
      • +

        getFluidName

        +
        public static java.lang.String getFluidName(FluidStack stack)
        +
        • +
      + + + +
        +
      • +

        getFluidID

        +
        public static int getFluidID(java.lang.String fluidName)
        +
        • +
      + + + +
        +
      • +

        getFluidStack

        +
        public static FluidStack getFluidStack(java.lang.String fluidName,
+                       int amount)
        +
        • +
      + + + +
        +
      • +

        getRegisteredFluids

        +
        public static java.util.Map<java.lang.String,Fluid> getRegisteredFluids()
        +
        Returns a read-only map containing Fluid Names and their associated Fluids.
        +
        • +
      + + + +
        +
      • +

        getRegisteredFluidIDs

        +
        public static java.util.Map<java.lang.String,java.lang.Integer> getRegisteredFluidIDs()
        +
        Returns a read-only map containing Fluid Names and their associated IDs.
        +
        • +
      + + + +
        +
      • +

        lookupFluidForBlock

        +
        public static Fluid lookupFluidForBlock(Block block)
        +
        • +
      + + + +
        +
      • +

        getMaxID

        +
        public static int getMaxID()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/FluidStack.html b/javadoc/net/minecraftforge/fluids/FluidStack.html new file mode 100644 index 0000000..ec97065 --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/FluidStack.html @@ -0,0 +1,569 @@ + + + + + +FluidStack (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class FluidStack

+
+
+ +
+
    +
  • +
    +
    +
    public class FluidStack
+extends java.lang.Object
    +
    ItemStack substitute for Fluids. + + NOTE: Equality is based on the Fluid, not the amount. Use + isFluidStackIdentical(FluidStack) to determine if FluidID, Amount and NBT Tag are all + equal.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        fluidID

        +
        public int fluidID
        +
        • +
      + + + +
        +
      • +

        amount

        +
        public int amount
        +
        • +
      + + + + +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FluidStack

        +
        public FluidStack(Fluid fluid,
+          int amount)
        +
        • +
      + + + +
        +
      • +

        FluidStack

        +
        public FluidStack(int fluidID,
+          int amount)
        +
        • +
      + + + +
        +
      • +

        FluidStack

        +
        public FluidStack(int fluidID,
+          int amount,
+          NBTTagCompound nbt)
        +
        • +
      + + + +
        +
      • +

        FluidStack

        +
        public FluidStack(FluidStack stack,
+          int amount)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        loadFluidStackFromNBT

        +
        public static FluidStack loadFluidStackFromNBT(NBTTagCompound nbt)
        +
        This provides a safe method for retrieving a FluidStack - if the Fluid is invalid, the stack + will return as null.
        +
        • +
      + + + + + + + +
        +
      • +

        getFluid

        +
        public final Fluid getFluid()
        +
        • +
      + + + +
        +
      • +

        getLocalizedName

        +
        public java.lang.String getLocalizedName()
        +
        • +
      + + + +
        +
      • +

        getUnlocalizedName

        +
        public java.lang.String getUnlocalizedName()
        +
        • +
      + + + +
        +
      • +

        copy

        +
        public FluidStack copy()
        +
        Returns:
        A copy of this FluidStack
        +
        • +
      + + + +
        +
      • +

        isFluidEqual

        +
        public boolean isFluidEqual(FluidStack other)
        +
        Determines if the FluidIDs and NBT Tags are equal. This does not check amounts.
        +
        Parameters:
        other - The FluidStack for comparison
        +
        Returns:
        true if the Fluids (IDs and NBT Tags) are the same
        +
        • +
      + + + +
        +
      • +

        areFluidStackTagsEqual

        +
        public static boolean areFluidStackTagsEqual(FluidStack stack1,
+                             FluidStack stack2)
        +
        Determines if the NBT Tags are equal. Useful if the FluidIDs are known to be equal.
        +
        • +
      + + + +
        +
      • +

        containsFluid

        +
        public boolean containsFluid(FluidStack other)
        +
        Determines if the Fluids are equal and this stack is larger.
        +
        Parameters:
        other -
        +
        Returns:
        true if this FluidStack contains the other FluidStack (same fluid and >= amount)
        +
        • +
      + + + +
        +
      • +

        isFluidStackIdentical

        +
        public boolean isFluidStackIdentical(FluidStack other)
        +
        Determines if the FluidIDs, Amounts, and NBT Tags are all equal.
        +
        Parameters:
        other - - the FluidStack for comparison
        +
        Returns:
        true if the two FluidStacks are exactly the same
        +
        • +
      + + + +
        +
      • +

        isFluidEqual

        +
        public boolean isFluidEqual(ItemStack other)
        +
        Determines if the FluidIDs and NBT Tags are equal compared to a registered container + ItemStack. This does not check amounts.
        +
        Parameters:
        other - The ItemStack for comparison
        +
        Returns:
        true if the Fluids (IDs and NBT Tags) are the same
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public final int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public final boolean equals(java.lang.Object o)
        +
        Default equality comparison for a FluidStack. Same functionality as isFluidEqual(). + + This is included for use in data structures.
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/FluidTank.html b/javadoc/net/minecraftforge/fluids/FluidTank.html new file mode 100644 index 0000000..bd7c390 --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/FluidTank.html @@ -0,0 +1,507 @@ + + + + + +FluidTank (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class FluidTank

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    IFluidTank
    +
    +
    +
    +
    public class FluidTank
+extends java.lang.Object
+implements IFluidTank
    +
    Reference implementation of IFluidTank. Use/extend this or implement your own.
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FluidTank

        +
        public FluidTank(int capacity)
        +
        • +
      + + + +
        +
      • +

        FluidTank

        +
        public FluidTank(FluidStack stack,
+         int capacity)
        +
        • +
      + + + +
        +
      • +

        FluidTank

        +
        public FluidTank(Fluid fluid,
+         int amount,
+         int capacity)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + +
        +
      • +

        setFluid

        +
        public void setFluid(FluidStack fluid)
        +
        • +
      + + + +
        +
      • +

        setCapacity

        +
        public void setCapacity(int capacity)
        +
        • +
      + + + +
        +
      • +

        getFluid

        +
        public FluidStack getFluid()
        +
        +
        Specified by:
        +
        getFluid in interface IFluidTank
        +
        Returns:
        FluidStack representing the fluid in the tank, null if the tank is empty.
        +
        • +
      + + + +
        +
      • +

        getFluidAmount

        +
        public int getFluidAmount()
        +
        +
        Specified by:
        +
        getFluidAmount in interface IFluidTank
        +
        Returns:
        Current amount of fluid in the tank.
        +
        • +
      + + + +
        +
      • +

        getCapacity

        +
        public int getCapacity()
        +
        +
        Specified by:
        +
        getCapacity in interface IFluidTank
        +
        Returns:
        Capacity of this fluid tank.
        +
        • +
      + + + +
        +
      • +

        getInfo

        +
        public FluidTankInfo getInfo()
        +
        Description copied from interface: IFluidTank
        +
        Returns a wrapper object FluidTankInfo containing the capacity of the tank and the + FluidStack it holds. + + Should prevent manipulation of the IFluidTank. See FluidTank.
        +
        +
        Specified by:
        +
        getInfo in interface IFluidTank
        +
        Returns:
        State information for the IFluidTank.
        +
        • +
      + + + +
        +
      • +

        fill

        +
        public int fill(FluidStack resource,
+       boolean doFill)
        +
        +
        Specified by:
        +
        fill in interface IFluidTank
        +
        Parameters:
        resource - FluidStack attempting to fill the tank.
        doFill - If false, the fill will only be simulated.
        +
        Returns:
        Amount of fluid that was accepted by the tank.
        +
        • +
      + + + +
        +
      • +

        drain

        +
        public FluidStack drain(int maxDrain,
+               boolean doDrain)
        +
        +
        Specified by:
        +
        drain in interface IFluidTank
        +
        Parameters:
        maxDrain - Maximum amount of fluid to be removed from the container.
        +
        Returns:
        Amount of fluid that was removed from the tank.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/FluidTankInfo.html b/javadoc/net/minecraftforge/fluids/FluidTankInfo.html new file mode 100644 index 0000000..62788dd --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/FluidTankInfo.html @@ -0,0 +1,290 @@ + + + + + +FluidTankInfo (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class FluidTankInfo

+
+
+ +
+
    +
  • +
    +
    +
    public final class FluidTankInfo
+extends java.lang.Object
    +
    Wrapper class used to encapsulate information about an IFluidTank.
    +
    • +
+
+
+
    +
  • + + + + + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + + + + + +
        +
      • +

        capacity

        +
        public final int capacity
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        FluidTankInfo

        +
        public FluidTankInfo(FluidStack fluid,
+             int capacity)
        +
        • +
      + + + +
        +
      • +

        FluidTankInfo

        +
        public FluidTankInfo(IFluidTank tank)
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/IFluidBlock.html b/javadoc/net/minecraftforge/fluids/IFluidBlock.html new file mode 100644 index 0000000..6d3ebea --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/IFluidBlock.html @@ -0,0 +1,294 @@ + + + + + +IFluidBlock (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.fluids
+

Interface IFluidBlock

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleancanDrain(World world, + int x, + int y, + int z) +
      Check to see if a block can be drained.
      +
      FluidStackdrain(World world, + int x, + int y, + int z, + boolean doDrain) +
      Attempt to drain the block.
      +
      floatgetFilledPercentage(World world, + int x, + int y, + int z) +
      Returns the amount of a single block is filled.
      +
      FluidgetFluid() +
      Returns the Fluid associated with this Block.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFluid

        +
        Fluid getFluid()
        +
        Returns the Fluid associated with this Block.
        +
        • +
      + + + +
        +
      • +

        drain

        +
        FluidStack drain(World world,
+               int x,
+               int y,
+               int z,
+               boolean doDrain)
        +
        Attempt to drain the block. This method should be called by devices such as pumps. + + NOTE: The block is intended to handle its own state changes.
        +
        Parameters:
        doDrain - If false, the drain will only be simulated.
        +
        Returns:
        +
        • +
      + + + +
        +
      • +

        canDrain

        +
        boolean canDrain(World world,
+               int x,
+               int y,
+               int z)
        +
        Check to see if a block can be drained. This method should be called by devices such as + pumps.
        +
        Parameters:
        doDrain - If false, the drain will only be simulated.
        +
        Returns:
        +
        • +
      + + + +
        +
      • +

        getFilledPercentage

        +
        float getFilledPercentage(World world,
+                        int x,
+                        int y,
+                        int z)
        +
        Returns the amount of a single block is filled. Value between 0 and 1. + 1 meaning the entire 1x1x1 cube is full, 0 meaning completely empty. + + If the return value is negative. It will be treated as filling the block + from the top down instead of bottom up.
        +
        Returns:
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/IFluidContainerItem.html b/javadoc/net/minecraftforge/fluids/IFluidContainerItem.html new file mode 100644 index 0000000..247bdc1 --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/IFluidContainerItem.html @@ -0,0 +1,271 @@ + + + + + +IFluidContainerItem (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.fluids
+

Interface IFluidContainerItem

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    ItemFluidContainer
    +
    +
    +
    +
    public interface IFluidContainerItem
    +
    Implement this interface on Item classes that support external manipulation of their internal + fluid storage. + + A reference implementation is provided ItemFluidContainer. + + NOTE: Use of NBT data on the containing ItemStack is encouraged.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFluid

        +
        FluidStack getFluid(ItemStack container)
        +
        Parameters:
        container - ItemStack which is the fluid container.
        +
        Returns:
        FluidStack representing the fluid in the container, null if the container is empty.
        +
        • +
      + + + +
        +
      • +

        getCapacity

        +
        int getCapacity(ItemStack container)
        +
        Parameters:
        container - ItemStack which is the fluid container.
        +
        Returns:
        Capacity of this fluid container.
        +
        • +
      + + + +
        +
      • +

        fill

        +
        int fill(ItemStack container,
+       FluidStack resource,
+       boolean doFill)
        +
        Parameters:
        container - ItemStack which is the fluid container.
        resource - FluidStack attempting to fill the container.
        doFill - If false, the fill will only be simulated.
        +
        Returns:
        Amount of fluid that was (or would have been, if simulated) filled into the + container.
        +
        • +
      + + + +
        +
      • +

        drain

        +
        FluidStack drain(ItemStack container,
+               int maxDrain,
+               boolean doDrain)
        +
        Parameters:
        container - ItemStack which is the fluid container.
        maxDrain - Maximum amount of fluid to be removed from the container.
        doFill - If false, the drain will only be simulated.
        +
        Returns:
        Amount of fluid that was (or would have been, if simulated) drained from the + container.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/IFluidHandler.html b/javadoc/net/minecraftforge/fluids/IFluidHandler.html new file mode 100644 index 0000000..a3ee123 --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/IFluidHandler.html @@ -0,0 +1,328 @@ + + + + + +IFluidHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.fluids
+

Interface IFluidHandler

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    TileFluidHandler
    +
    +
    +
    +
    public interface IFluidHandler
    +
    Implement this interface on TileEntities which should handle fluids, generally storing them in + one or more internal IFluidTank objects. + + A reference implementation is provided TileFluidHandler.
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      booleancanDrain(ForgeDirection from, + Fluid fluid) +
      Returns true if the given fluid can be extracted from the given direction.
      +
      booleancanFill(ForgeDirection from, + Fluid fluid) +
      Returns true if the given fluid can be inserted into the given direction.
      +
      FluidStackdrain(ForgeDirection from, + FluidStack resource, + boolean doDrain) +
      Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler.
      +
      FluidStackdrain(ForgeDirection from, + int maxDrain, + boolean doDrain) +
      Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler.
      +
      intfill(ForgeDirection from, + FluidStack resource, + boolean doFill) +
      Fills fluid into internal tanks, distribution is left entirely to the IFluidHandler.
      +
      FluidTankInfo[]getTankInfo(ForgeDirection from) +
      Returns an array of objects which represent the internal tanks.
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        fill

        +
        int fill(ForgeDirection from,
+       FluidStack resource,
+       boolean doFill)
        +
        Fills fluid into internal tanks, distribution is left entirely to the IFluidHandler.
        +
        Parameters:
        from - Orientation the Fluid is pumped in from.
        resource - FluidStack representing the Fluid and maximum amount of fluid to be filled.
        doFill - If false, fill will only be simulated.
        +
        Returns:
        Amount of resource that was (or would have been, if simulated) filled.
        +
        • +
      + + + +
        +
      • +

        drain

        +
        FluidStack drain(ForgeDirection from,
+               FluidStack resource,
+               boolean doDrain)
        +
        Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler.
        +
        Parameters:
        from - Orientation the Fluid is drained to.
        resource - FluidStack representing the Fluid and maximum amount of fluid to be drained.
        doDrain - If false, drain will only be simulated.
        +
        Returns:
        FluidStack representing the Fluid and amount that was (or would have been, if + simulated) drained.
        +
        • +
      + + + +
        +
      • +

        drain

        +
        FluidStack drain(ForgeDirection from,
+               int maxDrain,
+               boolean doDrain)
        +
        Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler. + + This method is not Fluid-sensitive.
        +
        Parameters:
        from - Orientation the fluid is drained to.
        maxDrain - Maximum amount of fluid to drain.
        doDrain - If false, drain will only be simulated.
        +
        Returns:
        FluidStack representing the Fluid and amount that was (or would have been, if + simulated) drained.
        +
        • +
      + + + +
        +
      • +

        canFill

        +
        boolean canFill(ForgeDirection from,
+              Fluid fluid)
        +
        Returns true if the given fluid can be inserted into the given direction. + + More formally, this should return true if fluid is able to enter from the given direction.
        +
        • +
      + + + +
        +
      • +

        canDrain

        +
        boolean canDrain(ForgeDirection from,
+               Fluid fluid)
        +
        Returns true if the given fluid can be extracted from the given direction. + + More formally, this should return true if fluid is able to leave from the given direction.
        +
        • +
      + + + +
        +
      • +

        getTankInfo

        +
        FluidTankInfo[] getTankInfo(ForgeDirection from)
        +
        Returns an array of objects which represent the internal tanks. These objects cannot be used + to manipulate the internal tanks. See FluidTankInfo.
        +
        Parameters:
        from - Orientation determining which tanks should be queried.
        +
        Returns:
        Info for the relevant internal tanks.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/IFluidTank.html b/javadoc/net/minecraftforge/fluids/IFluidTank.html new file mode 100644 index 0000000..9e87672 --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/IFluidTank.html @@ -0,0 +1,295 @@ + + + + + +IFluidTank (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + +
+
net.minecraftforge.fluids
+

Interface IFluidTank

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    FluidTank
    +
    +
    +
    +
    public interface IFluidTank
    +
    A tank is the unit of interaction with Fluid inventories. + + A reference implementation can be found at FluidTank.
    +
    • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFluid

        +
        FluidStack getFluid()
        +
        Returns:
        FluidStack representing the fluid in the tank, null if the tank is empty.
        +
        • +
      + + + +
        +
      • +

        getFluidAmount

        +
        int getFluidAmount()
        +
        Returns:
        Current amount of fluid in the tank.
        +
        • +
      + + + +
        +
      • +

        getCapacity

        +
        int getCapacity()
        +
        Returns:
        Capacity of this fluid tank.
        +
        • +
      + + + +
        +
      • +

        getInfo

        +
        FluidTankInfo getInfo()
        +
        Returns a wrapper object FluidTankInfo containing the capacity of the tank and the + FluidStack it holds. + + Should prevent manipulation of the IFluidTank. See FluidTank.
        +
        Returns:
        State information for the IFluidTank.
        +
        • +
      + + + +
        +
      • +

        fill

        +
        int fill(FluidStack resource,
+       boolean doFill)
        +
        Parameters:
        resource - FluidStack attempting to fill the tank.
        doFill - If false, the fill will only be simulated.
        +
        Returns:
        Amount of fluid that was accepted by the tank.
        +
        • +
      + + + +
        +
      • +

        drain

        +
        FluidStack drain(int maxDrain,
+               boolean doDrain)
        +
        Parameters:
        maxDrain - Maximum amount of fluid to be removed from the container.
        doFill - If false, the fill will only be simulated.
        +
        Returns:
        Amount of fluid that was removed from the tank.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
    +
  • Detail: 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/ItemFluidContainer.html b/javadoc/net/minecraftforge/fluids/ItemFluidContainer.html new file mode 100644 index 0000000..f9e01a3 --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/ItemFluidContainer.html @@ -0,0 +1,426 @@ + + + + + +ItemFluidContainer (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class ItemFluidContainer

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        capacity

        +
        protected int capacity
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ItemFluidContainer

        +
        public ItemFluidContainer(int itemID)
        +
        • +
      + + + +
        +
      • +

        ItemFluidContainer

        +
        public ItemFluidContainer(int itemID,
+                  int capacity)
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getFluid

        +
        public FluidStack getFluid(ItemStack container)
        +
        +
        Specified by:
        +
        getFluid in interface IFluidContainerItem
        +
        Parameters:
        container - ItemStack which is the fluid container.
        +
        Returns:
        FluidStack representing the fluid in the container, null if the container is empty.
        +
        • +
      + + + +
        +
      • +

        getCapacity

        +
        public int getCapacity(ItemStack container)
        +
        +
        Specified by:
        +
        getCapacity in interface IFluidContainerItem
        +
        Parameters:
        container - ItemStack which is the fluid container.
        +
        Returns:
        Capacity of this fluid container.
        +
        • +
      + + + +
        +
      • +

        fill

        +
        public int fill(ItemStack container,
+       FluidStack resource,
+       boolean doFill)
        +
        +
        Specified by:
        +
        fill in interface IFluidContainerItem
        +
        Parameters:
        container - ItemStack which is the fluid container.
        resource - FluidStack attempting to fill the container.
        doFill - If false, the fill will only be simulated.
        +
        Returns:
        Amount of fluid that was (or would have been, if simulated) filled into the + container.
        +
        • +
      + + + +
        +
      • +

        drain

        +
        public FluidStack drain(ItemStack container,
+               int maxDrain,
+               boolean doDrain)
        +
        +
        Specified by:
        +
        drain in interface IFluidContainerItem
        +
        Parameters:
        container - ItemStack which is the fluid container.
        maxDrain - Maximum amount of fluid to be removed from the container.
        +
        Returns:
        Amount of fluid that was (or would have been, if simulated) drained from the + container.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/RenderBlockFluid.html b/javadoc/net/minecraftforge/fluids/RenderBlockFluid.html new file mode 100644 index 0000000..e4dae0f --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/RenderBlockFluid.html @@ -0,0 +1,403 @@ + + + + + +RenderBlockFluid (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class RenderBlockFluid

+
+
+ +
+ +
+
+ +
+
+ +
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/TileFluidHandler.html b/javadoc/net/minecraftforge/fluids/TileFluidHandler.html new file mode 100644 index 0000000..50a53aa --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/TileFluidHandler.html @@ -0,0 +1,491 @@ + + + + + +TileFluidHandler (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
net.minecraftforge.fluids
+

Class TileFluidHandler

+
+
+ +
+ +
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TileFluidHandler

        +
        public TileFluidHandler()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + +
        +
      • +

        fill

        +
        public int fill(ForgeDirection from,
+       FluidStack resource,
+       boolean doFill)
        +
        Description copied from interface: IFluidHandler
        +
        Fills fluid into internal tanks, distribution is left entirely to the IFluidHandler.
        +
        +
        Specified by:
        +
        fill in interface IFluidHandler
        +
        Parameters:
        from - Orientation the Fluid is pumped in from.
        resource - FluidStack representing the Fluid and maximum amount of fluid to be filled.
        doFill - If false, fill will only be simulated.
        +
        Returns:
        Amount of resource that was (or would have been, if simulated) filled.
        +
        • +
      + + + +
        +
      • +

        drain

        +
        public FluidStack drain(ForgeDirection from,
+               FluidStack resource,
+               boolean doDrain)
        +
        Description copied from interface: IFluidHandler
        +
        Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler.
        +
        +
        Specified by:
        +
        drain in interface IFluidHandler
        +
        Parameters:
        from - Orientation the Fluid is drained to.
        resource - FluidStack representing the Fluid and maximum amount of fluid to be drained.
        doDrain - If false, drain will only be simulated.
        +
        Returns:
        FluidStack representing the Fluid and amount that was (or would have been, if + simulated) drained.
        +
        • +
      + + + +
        +
      • +

        drain

        +
        public FluidStack drain(ForgeDirection from,
+               int maxDrain,
+               boolean doDrain)
        +
        Description copied from interface: IFluidHandler
        +
        Drains fluid out of internal tanks, distribution is left entirely to the IFluidHandler. + + This method is not Fluid-sensitive.
        +
        +
        Specified by:
        +
        drain in interface IFluidHandler
        +
        Parameters:
        from - Orientation the fluid is drained to.
        maxDrain - Maximum amount of fluid to drain.
        doDrain - If false, drain will only be simulated.
        +
        Returns:
        FluidStack representing the Fluid and amount that was (or would have been, if + simulated) drained.
        +
        • +
      + + + +
        +
      • +

        canFill

        +
        public boolean canFill(ForgeDirection from,
+              Fluid fluid)
        +
        Description copied from interface: IFluidHandler
        +
        Returns true if the given fluid can be inserted into the given direction. + + More formally, this should return true if fluid is able to enter from the given direction.
        +
        +
        Specified by:
        +
        canFill in interface IFluidHandler
        +
        +
        • +
      + + + +
        +
      • +

        canDrain

        +
        public boolean canDrain(ForgeDirection from,
+               Fluid fluid)
        +
        Description copied from interface: IFluidHandler
        +
        Returns true if the given fluid can be extracted from the given direction. + + More formally, this should return true if fluid is able to leave from the given direction.
        +
        +
        Specified by:
        +
        canDrain in interface IFluidHandler
        +
        +
        • +
      + + + +
        +
      • +

        getTankInfo

        +
        public FluidTankInfo[] getTankInfo(ForgeDirection from)
        +
        Description copied from interface: IFluidHandler
        +
        Returns an array of objects which represent the internal tanks. These objects cannot be used + to manipulate the internal tanks. See FluidTankInfo.
        +
        +
        Specified by:
        +
        getTankInfo in interface IFluidHandler
        +
        Parameters:
        from - Orientation determining which tanks should be queried.
        +
        Returns:
        Info for the relevant internal tanks.
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/package-frame.html b/javadoc/net/minecraftforge/fluids/package-frame.html new file mode 100644 index 0000000..a060527 --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/package-frame.html @@ -0,0 +1,45 @@ + + + + + +net.minecraftforge.fluids (Forge API) + + + + +

net.minecraftforge.fluids

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/javadoc/net/minecraftforge/fluids/package-summary.html b/javadoc/net/minecraftforge/fluids/package-summary.html new file mode 100644 index 0000000..cbefdef --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/package-summary.html @@ -0,0 +1,284 @@ + + + + + +net.minecraftforge.fluids (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package net.minecraftforge.fluids

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/javadoc/net/minecraftforge/fluids/package-tree.html b/javadoc/net/minecraftforge/fluids/package-tree.html new file mode 100644 index 0000000..0313551 --- /dev/null +++ b/javadoc/net/minecraftforge/fluids/package-tree.html @@ -0,0 +1,174 @@ + + + + + +net.minecraftforge.fluids Class Hierarchy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package net.minecraftforge.fluids

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + -- cgit v1.2.3