FluidAttributes (forge 1.15.2-31.2.47)

java.lang.Object
- net.minecraftforge.fluids.FluidAttributes

Direct Known Subclasses:

FluidAttributes.Water
```
public class FluidAttributes
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.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FluidAttributes.Builder

static class FluidAttributes.Water

Nested Classes
Modifier and Type	Class and Description
`static class`	`FluidAttributes.Builder`
`static class`	`FluidAttributes.Water`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BUCKET_VOLUME`
`private int`	`color` Color used by universal bucket and the ModelFluid baked model.
`private int`	`density` Density of the fluid - completely arbitrary; negative density indicates that the fluid is lighter than air.
`private SoundEvent`	`emptySound`
`private SoundEvent`	`fillSound`
`private ResourceLocation`	`flowingTexture`
`private boolean`	`isGaseous` This indicates if the fluid is gaseous.
`private int`	`luminosity` The light level emitted by this fluid.
`private ResourceLocation`	`overlayTexture`
`private Rarity`	`rarity` The rarity of the fluid.
`private ResourceLocation`	`stillTexture`
`private int`	`temperature` Temperature of the fluid - completely arbitrary; higher temperature indicates that the fluid is hotter than air.
`private java.lang.String`	`translationKey`
`private int`	`viscosity` Viscosity ("thickness") of the fluid - completely arbitrary; negative values are not permissible.

Constructor Summary

Constructors
Modifier Constructor and Description

protected FluidAttributes(FluidAttributes.Builder builder, Fluid fluid)

Constructors
Modifier	Constructor and Description
`protected`	`FluidAttributes(FluidAttributes.Builder builder, Fluid fluid)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static FluidAttributes.Builder`	`builder(ResourceLocation stillTexture, ResourceLocation flowingTexture)`
`boolean`	`canBePlacedInWorld(ILightReader reader, BlockPos pos, FluidStack state)`
`boolean`	`canBePlacedInWorld(ILightReader reader, BlockPos pos, IFluidState state)`
`boolean`	`doesVaporize(ILightReader reader, BlockPos pos, FluidStack fluidStack)` Determines if this fluid should vaporize in dimensions where water vaporizes when placed.
`BlockState`	`getBlock(ILightReader reader, BlockPos pos, IFluidState state)`
`ItemStack`	`getBucket(FluidStack stack)`
`int`	`getColor()`
`int`	`getColor(FluidStack stack)`
`int`	`getColor(ILightReader world, BlockPos pos)`
`int`	`getDensity()`
`int`	`getDensity(FluidStack stack)`
`int`	`getDensity(ILightReader world, BlockPos pos)`
`ITextComponent`	`getDisplayName(FluidStack stack)` Returns the localized name of this fluid.
`SoundEvent`	`getEmptySound()`
`SoundEvent`	`getEmptySound(FluidStack stack)`
`SoundEvent`	`getEmptySound(ILightReader world, BlockPos pos)`
`SoundEvent`	`getFillSound()`
`SoundEvent`	`getFillSound(FluidStack stack)`
`SoundEvent`	`getFillSound(ILightReader world, BlockPos pos)`
`ResourceLocation`	`getFlowingTexture()`
`ResourceLocation`	`getFlowingTexture(FluidStack stack)`
`ResourceLocation`	`getFlowingTexture(ILightReader world, BlockPos pos)`
`int`	`getLuminosity()`
`int`	`getLuminosity(FluidStack stack)`
`int`	`getLuminosity(ILightReader world, BlockPos pos)`
`ResourceLocation`	`getOverlayTexture()`
`Rarity`	`getRarity()`
`Rarity`	`getRarity(FluidStack stack)`
`Rarity`	`getRarity(ILightReader world, BlockPos pos)`
`IFluidState`	`getStateForPlacement(ILightReader reader, BlockPos pos, FluidStack state)`
`ResourceLocation`	`getStillTexture()`
`ResourceLocation`	`getStillTexture(FluidStack stack)`
`ResourceLocation`	`getStillTexture(ILightReader world, BlockPos pos)`
`int`	`getTemperature()`
`int`	`getTemperature(FluidStack stack)`
`int`	`getTemperature(ILightReader world, BlockPos pos)`
`java.util.stream.Stream<ResourceLocation>`	`getTextures()`
`java.lang.String`	`getTranslationKey()` Returns the translation key of this fluid.
`java.lang.String`	`getTranslationKey(FluidStack stack)` A FluidStack sensitive version of getTranslationKey
`int`	`getViscosity()`
`int`	`getViscosity(FluidStack stack)`
`int`	`getViscosity(ILightReader world, BlockPos pos)`
`boolean`	`isGaseous()`
`boolean`	`isGaseous(FluidStack stack)`
`boolean`	`isGaseous(ILightReader world, BlockPos pos)`
`boolean`	`isLighterThanAir()`
`void`	`vaporize(PlayerEntity player, World worldIn, BlockPos pos, FluidStack fluidStack)` Called instead of placing the fluid block if `Dimension.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
- translationKey
```
private java.lang.String translationKey
```
- stillTexture
```
private final ResourceLocation stillTexture
```
- flowingTexture
```
private final ResourceLocation flowingTexture
```
- overlayTexture
```
@Nullable
private final ResourceLocation overlayTexture
```
- fillSound
```
private final SoundEvent fillSound
```
- emptySound
```
private final SoundEvent emptySound
```
- luminosity
```
private final int luminosity
```
  The light level emitted by this fluid. Default value is 0, as most fluids do not actively emit light.
- density
```
private final 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
```
private final 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
```
private final 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
```
private final boolean isGaseous
```
  This indicates if the fluid is gaseous. Generally this is associated with negative density fluids.
- rarity
```
private final Rarity rarity
```
  The rarity of the fluid. Used primarily in tool tips.
- color
```
private final int color
```
  Color used by universal bucket and the ModelFluid baked model. Note that this int includes the alpha so converting this to RGB with alpha would be float r = ((color >> 16) & 0xFF) / 255f; // red float g = ((color >> 8) & 0xFF) / 255f; // green float b = ((color >> 0) & 0xFF) / 255f; // blue float a = ((color >> 24) & 0xFF) / 255f; // alpha

Constructor Detail

FluidAttributes

protected FluidAttributes(FluidAttributes.Builder builder,
                          Fluid fluid)

Method Detail

getBucket

public ItemStack getBucket(FluidStack stack)

getBlock

public BlockState getBlock(ILightReader reader,
                           BlockPos pos,
                           IFluidState state)

getStateForPlacement

public IFluidState getStateForPlacement(ILightReader reader,
                                        BlockPos pos,
                                        FluidStack state)

canBePlacedInWorld

public final boolean canBePlacedInWorld(ILightReader reader,
                                        BlockPos pos,
                                        IFluidState state)

canBePlacedInWorld

public final boolean canBePlacedInWorld(ILightReader reader,
                                        BlockPos pos,
                                        FluidStack state)

isLighterThanAir

public final boolean isLighterThanAir()

doesVaporize
```
public boolean doesVaporize(ILightReader reader,
                            BlockPos pos,
                            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 net.minecraft.item.BucketItem#tryPlaceContainedLiquid(PlayerEntity, 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
                     PlayerEntity player,
                     World worldIn,
                     BlockPos pos,
                     FluidStack fluidStack)
```
Called instead of placing the fluid block if Dimension.doesWaterVaporize() and #doesVaporize(FluidStack) are true. Override this to make your explosive liquid blow up instead of the default smoke, etc. Based on net.minecraft.item.BucketItem#tryPlaceContainedLiquid(PlayerEntity, 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.

getDisplayName

public ITextComponent getDisplayName(FluidStack stack)

Returns the localized name of this fluid.

getTranslationKey
```
public java.lang.String getTranslationKey(FluidStack stack)
```
A FluidStack sensitive version of getTranslationKey

getTranslationKey
```
public java.lang.String getTranslationKey()
```
Returns the translation key 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 Rarity getRarity()
```

getColor
```
public int getColor()
```

getStillTexture

public ResourceLocation getStillTexture()

getFlowingTexture

public ResourceLocation getFlowingTexture()

getOverlayTexture

@Nullable
public ResourceLocation getOverlayTexture()

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 Rarity getRarity(FluidStack stack)

getColor

public int getColor(FluidStack stack)

getStillTexture

public ResourceLocation getStillTexture(FluidStack stack)

getFlowingTexture

public ResourceLocation getFlowingTexture(FluidStack stack)

getFillSound

public SoundEvent getFillSound(FluidStack stack)

getEmptySound

public SoundEvent getEmptySound(FluidStack stack)

getLuminosity

public int getLuminosity(ILightReader world,
                         BlockPos pos)

getDensity

public int getDensity(ILightReader world,
                      BlockPos pos)

getTemperature

public int getTemperature(ILightReader world,
                          BlockPos pos)

getViscosity

public int getViscosity(ILightReader world,
                        BlockPos pos)

isGaseous

public boolean isGaseous(ILightReader world,
                         BlockPos pos)

getRarity

public Rarity getRarity(ILightReader world,
                        BlockPos pos)

getColor

public int getColor(ILightReader world,
                    BlockPos pos)

getStillTexture

public ResourceLocation getStillTexture(ILightReader world,
                                        BlockPos pos)

getFlowingTexture

public ResourceLocation getFlowingTexture(ILightReader world,
                                          BlockPos pos)

getFillSound

public SoundEvent getFillSound(ILightReader world,
                               BlockPos pos)

getEmptySound

public SoundEvent getEmptySound(ILightReader world,
                                BlockPos pos)

builder

public static FluidAttributes.Builder builder(ResourceLocation stillTexture,
                                              ResourceLocation flowingTexture)

getTextures

public java.util.stream.Stream<ResourceLocation> getTextures()

Class FluidAttributes

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BUCKET_VOLUME

translationKey

stillTexture

flowingTexture

overlayTexture

fillSound

emptySound

luminosity

density

temperature

viscosity

isGaseous

rarity

color

Constructor Detail

FluidAttributes

Method Detail

getBucket

getBlock

getStateForPlacement

canBePlacedInWorld

canBePlacedInWorld

isLighterThanAir

doesVaporize

vaporize

getDisplayName

getTranslationKey

getTranslationKey

getLuminosity

getDensity

getTemperature

getViscosity

isGaseous

getRarity

getColor

getStillTexture

getFlowingTexture

getOverlayTexture

getFillSound

getEmptySound

getLuminosity

getDensity

getTemperature

getViscosity

isGaseous

getRarity

getColor

getStillTexture

getFlowingTexture

getFillSound

getEmptySound

getLuminosity

getDensity

getTemperature

getViscosity

isGaseous

getRarity

getColor

getStillTexture

getFlowingTexture

getFillSound

getEmptySound

builder

getTextures