net.minecraftforge.fluids

Class FluidAttributes

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	BUCKET_VOLUME

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static FluidAttributes.Builder	builder(ResourceLocation stillTexture, ResourceLocation flowingTexture)
boolean	canBePlacedInWorld(IEnviromentBlockReader reader, BlockPos pos, FluidStack state)
boolean	canBePlacedInWorld(IEnviromentBlockReader reader, BlockPos pos, IFluidState state)
boolean	doesVaporize(IEnviromentBlockReader reader, BlockPos pos, FluidStack fluidStack) Determines if this fluid should vaporize in dimensions where water vaporizes when placed.
BlockState	getBlock(IEnviromentBlockReader reader, BlockPos pos, IFluidState state)
ItemStack	getBucket(FluidStack stack)
int	getColor()
int	getColor(FluidStack stack)
int	getColor(IEnviromentBlockReader world, BlockPos pos)
int	getDensity()
int	getDensity(FluidStack stack)
int	getDensity(IEnviromentBlockReader world, BlockPos pos)
ITextComponent	getDisplayName(FluidStack stack) Returns the localized name of this fluid.
SoundEvent	getEmptySound()
SoundEvent	getEmptySound(FluidStack stack)
SoundEvent	getEmptySound(IEnviromentBlockReader world, BlockPos pos)
SoundEvent	getFillSound()
SoundEvent	getFillSound(FluidStack stack)
SoundEvent	getFillSound(IEnviromentBlockReader world, BlockPos pos)
ResourceLocation	getFlowing(FluidStack stack)
ResourceLocation	getFlowing(IEnviromentBlockReader world, BlockPos pos)
ResourceLocation	getFlowingTexture()
int	getLuminosity()
int	getLuminosity(FluidStack stack)
int	getLuminosity(IEnviromentBlockReader world, BlockPos pos)
ResourceLocation	getOverlayTexture()
Rarity	getRarity()
Rarity	getRarity(FluidStack stack)
Rarity	getRarity(IEnviromentBlockReader world, BlockPos pos)
IFluidState	getStateForPlacement(IEnviromentBlockReader reader, BlockPos pos, FluidStack state)
ResourceLocation	getStill(FluidStack stack)
ResourceLocation	getStill(IEnviromentBlockReader world, BlockPos pos)
ResourceLocation	getStillTexture()
int	getTemperature()
int	getTemperature(FluidStack stack)
int	getTemperature(IEnviromentBlockReader 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(IEnviromentBlockReader world, BlockPos pos)
boolean	isGaseous()
boolean	isGaseous(FluidStack stack)
boolean	isGaseous(IEnviromentBlockReader 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

Constructor Detail

FluidAttributes

protected FluidAttributes(FluidAttributes.Builder builder,
                          Fluid fluid)

Method Detail

getBucket

public ItemStack getBucket(FluidStack stack)

getBlock

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

getStateForPlacement

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

canBePlacedInWorld

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

canBePlacedInWorld

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

isLighterThanAir

public final boolean isLighterThanAir()

doesVaporize

public boolean doesVaporize(IEnviromentBlockReader 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)

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(IEnviromentBlockReader world,
                         BlockPos pos)

getDensity

public int getDensity(IEnviromentBlockReader world,
                      BlockPos pos)

getTemperature

public int getTemperature(IEnviromentBlockReader world,
                          BlockPos pos)

getViscosity

public int getViscosity(IEnviromentBlockReader world,
                        BlockPos pos)

isGaseous

public boolean isGaseous(IEnviromentBlockReader world,
                         BlockPos pos)

getRarity

public Rarity getRarity(IEnviromentBlockReader world,
                        BlockPos pos)

getColor

public int getColor(IEnviromentBlockReader world,
                    BlockPos pos)

getStill

public ResourceLocation getStill(IEnviromentBlockReader world,
                                 BlockPos pos)

getFlowing

public ResourceLocation getFlowing(IEnviromentBlockReader world,
                                   BlockPos pos)

getFillSound

public SoundEvent getFillSound(IEnviromentBlockReader world,
                               BlockPos pos)

getEmptySound

public SoundEvent getEmptySound(IEnviromentBlockReader world,
                                BlockPos pos)

builder

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

getTextures

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