Fluid (Forge API)

java.lang.Object
- net.minecraftforge.fluids.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 Summary

Fields
Modifier and Type	Field and Description
`protected Block`	`block` If there is a Block implementation of the Fluid, the Block is linked here.
`static int`	`BUCKET_VOLUME`
`protected int`	`density` Density of the fluid - completely arbitrary; negative density indicates that the fluid is lighter than air.
`protected ResourceLocation`	`flowing`
`protected java.lang.String`	`fluidName` The unique identification name for this fluid.
`protected boolean`	`isGaseous` This indicates if the fluid is gaseous.
`protected int`	`luminosity` The light level emitted by this fluid.
`protected EnumRarity`	`rarity` The rarity of the fluid.
`protected ResourceLocation`	`still`
`protected int`	`temperature` Temperature of the fluid - completely arbitrary; higher temperature indicates that the fluid is hotter than air.
`protected java.lang.String`	`unlocalizedName` The unlocalized name of this fluid.
`protected int`	`viscosity` Viscosity ("thickness") of the fluid - completely arbitrary; negative values are not permissible.

Constructor Summary

Constructors
Constructor and Description

Fluid(java.lang.String fluidName, ResourceLocation still, ResourceLocation flowing)

Constructors
Constructor and Description
`Fluid(java.lang.String fluidName, ResourceLocation still, ResourceLocation flowing)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canBePlacedInWorld()`
`boolean`	`doesVaporize(FluidStack fluidStack)` Determines if this fluid should vaporize in dimensions where water vaporizes when placed.
`Block`	`getBlock()`
`int`	`getColor()`
`int`	`getColor(FluidStack stack)`
`int`	`getColor(World world, BlockPos pos)`
`int`	`getDensity()`
`int`	`getDensity(FluidStack stack)`
`int`	`getDensity(World world, BlockPos pos)`
`SoundEvent`	`getEmptySound()`
`SoundEvent`	`getEmptySound(FluidStack stack)`
`SoundEvent`	`getEmptySound(World world, BlockPos pos)`
`SoundEvent`	`getFillSound()`
`SoundEvent`	`getFillSound(FluidStack stack)`
`SoundEvent`	`getFillSound(World world, BlockPos pos)`
`ResourceLocation`	`getFlowing()`
`ResourceLocation`	`getFlowing(FluidStack stack)`
`ResourceLocation`	`getFlowing(World world, BlockPos pos)`
`java.lang.String`	`getLocalizedName(FluidStack stack)` Returns the localized name of this fluid.
`int`	`getLuminosity()`
`int`	`getLuminosity(FluidStack stack)`
`int`	`getLuminosity(World world, BlockPos pos)`
`java.lang.String`	`getName()`
`EnumRarity`	`getRarity()`
`EnumRarity`	`getRarity(FluidStack stack)`
`EnumRarity`	`getRarity(World world, BlockPos pos)`
`ResourceLocation`	`getStill()`
`ResourceLocation`	`getStill(FluidStack stack)`
`ResourceLocation`	`getStill(World world, BlockPos pos)`
`int`	`getTemperature()`
`int`	`getTemperature(FluidStack stack)`
`int`	`getTemperature(World world, BlockPos pos)`
`java.lang.String`	`getUnlocalizedName()` Returns the unlocalized name of this fluid.
`java.lang.String`	`getUnlocalizedName(FluidStack stack)` A FluidStack sensitive version of getUnlocalizedName
`int`	`getViscosity()`
`int`	`getViscosity(FluidStack stack)`
`int`	`getViscosity(World world, BlockPos pos)`
`boolean`	`isGaseous()`
`boolean`	`isGaseous(FluidStack stack)`
`boolean`	`isGaseous(World world, BlockPos pos)`
`Fluid`	`setBlock(Block block)`
`Fluid`	`setDensity(int density)`
`Fluid`	`setEmptySound(SoundEvent emptySound)`
`Fluid`	`setFillSound(SoundEvent fillSound)`
`Fluid`	`setGaseous(boolean isGaseous)`
`Fluid`	`setLuminosity(int luminosity)`
`Fluid`	`setRarity(EnumRarity rarity)`
`Fluid`	`setTemperature(int temperature)`
`Fluid`	`setUnlocalizedName(java.lang.String unlocalizedName)`
`Fluid`	`setViscosity(int viscosity)`
`void`	`vaporize(EntityPlayer player, World worldIn, BlockPos pos, FluidStack fluidStack)` Called instead of placing the fluid block if `WorldProvider.doesWaterVaporize()` and `doesVaporize(FluidStack)` are true.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- BUCKET_VOLUME
```
public static final int BUCKET_VOLUME
```
  See Also:
  
  Constant Field Values
- 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.
- still
```
protected final ResourceLocation still
```
- flowing
```
protected final ResourceLocation flowing
```
- 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). Higher viscosity means that a fluid flows more slowly, like molasses. Lower viscosity means that a fluid flows more quickly, like helium.
- 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,
             ResourceLocation still,
             ResourceLocation flowing)

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)

setRarity

public Fluid setRarity(EnumRarity rarity)

setFillSound

public Fluid setFillSound(SoundEvent fillSound)

setEmptySound

public Fluid setEmptySound(SoundEvent emptySound)

getName

public final java.lang.String getName()

getBlock
```
public final Block getBlock()
```

canBePlacedInWorld

public final boolean canBePlacedInWorld()

doesVaporize
```
public boolean doesVaporize(FluidStack fluidStack)
```
Determines if this fluid should vaporize in dimensions where water vaporizes when placed. To preserve the intentions of vanilla, fluids that can turn lava into obsidian should vaporize. This prevents players from making the nether safe with a single bucket. Based on ItemBucket.tryPlaceContainedLiquid(EntityPlayer, World, BlockPos)

Parameters:

fluidStack - The fluidStack is trying to be placed.

Returns:

true if this fluid should vaporize in dimensions where water vaporizes when placed.

vaporize
```
public void vaporize(@Nullable
                     EntityPlayer player,
                     World worldIn,
                     BlockPos pos,
                     FluidStack fluidStack)
```
Called instead of placing the fluid block if WorldProvider.doesWaterVaporize() and doesVaporize(FluidStack) are true. Override this to make your explosive liquid blow up instead of the default smoke, etc. Based on ItemBucket.tryPlaceContainedLiquid(EntityPlayer, World, BlockPos)

Parameters:

player - Player who tried to place the fluid. May be null for blocks like dispensers.

worldIn - World to vaporize the fluid in.

pos - The position in the world the fluid block was going to be placed.

fluidStack - The fluidStack that was going to be placed.

getLocalizedName

public java.lang.String getLocalizedName(FluidStack stack)

Returns the localized name of this fluid.

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.

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()
```

getStill
```
public ResourceLocation getStill()
```

getFlowing
```
public ResourceLocation getFlowing()
```

getFillSound
```
public SoundEvent getFillSound()
```

getEmptySound
```
public SoundEvent getEmptySound()
```

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)

getRarity

public EnumRarity getRarity(FluidStack stack)

getColor

public int getColor(FluidStack stack)

getStill

public ResourceLocation getStill(FluidStack stack)

getFlowing

public ResourceLocation getFlowing(FluidStack stack)

getFillSound

public SoundEvent getFillSound(FluidStack stack)

getEmptySound

public SoundEvent getEmptySound(FluidStack stack)

getLuminosity

public int getLuminosity(World world,
                         BlockPos pos)

getDensity

public int getDensity(World world,
                      BlockPos pos)

getTemperature

public int getTemperature(World world,
                          BlockPos pos)

getViscosity

public int getViscosity(World world,
                        BlockPos pos)

isGaseous

public boolean isGaseous(World world,
                         BlockPos pos)

getRarity

public EnumRarity getRarity(World world,
                            BlockPos pos)

getColor

public int getColor(World world,
                    BlockPos pos)

getStill

public ResourceLocation getStill(World world,
                                 BlockPos pos)

getFlowing

public ResourceLocation getFlowing(World world,
                                   BlockPos pos)

getFillSound

public SoundEvent getFillSound(World world,
                               BlockPos pos)

getEmptySound

public SoundEvent getEmptySound(World world,
                                BlockPos pos)

Class Fluid

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BUCKET_VOLUME

fluidName

unlocalizedName

still

flowing

luminosity

density

temperature

viscosity

isGaseous

rarity

block

Constructor Detail

Fluid

Method Detail

setUnlocalizedName

setBlock

setLuminosity

setDensity

setTemperature

setViscosity

setGaseous

setRarity

setFillSound

setEmptySound

getName

getBlock

canBePlacedInWorld

doesVaporize

vaporize

getLocalizedName

getUnlocalizedName

getUnlocalizedName

getLuminosity

getDensity

getTemperature

getViscosity

isGaseous

getRarity

getColor

getStill

getFlowing

getFillSound

getEmptySound

getLuminosity

getDensity

getTemperature

getViscosity

isGaseous

getRarity

getColor

getStill

getFlowing

getFillSound

getEmptySound

getLuminosity

getDensity

getTemperature

getViscosity

isGaseous

getRarity

getColor

getStill

getFlowing

getFillSound

getEmptySound