Package net.neoforged.neoforge.fluids.crafting

Class CustomDisplayFluidIngredient

java.lang.Object
net.neoforged.neoforge.fluids.crafting.FluidIngredient
net.neoforged.neoforge.fluids.crafting.CustomDisplayFluidIngredient
All Implemented Interfaces:
Predicate<FluidStack>
public final class CustomDisplayFluidIngredient extends FluidIngredient
FluidIngredient that wraps another fluid ingredient to override its SlotDisplay.

  • Field Details

    • CODEC

      public static final com.mojang.serialization.MapCodec<CustomDisplayFluidIngredient> CODEC

    • STREAM_CODEC

      public static final net.minecraft.network.codec.StreamCodec<net.minecraft.network.RegistryFriendlyByteBuf,CustomDisplayFluidIngredient> STREAM_CODEC

    • base

      private final FluidIngredient base

    • display

      private final net.minecraft.world.item.crafting.display.SlotDisplay display

  • Constructor Details

    • CustomDisplayFluidIngredient

      public CustomDisplayFluidIngredient(FluidIngredient base, net.minecraft.world.item.crafting.display.SlotDisplay display)

  • Method Details

    • of

      public static FluidIngredient of(FluidIngredient base, net.minecraft.world.item.crafting.display.SlotDisplay display)

    • test

      public boolean test(FluidStack stack)
      Description copied from class: FluidIngredient
      Checks if a given fluid stack matches this ingredient. The stack must not be modified in any way.
      Specified by:
      test in interface Predicate<FluidStack>
      Specified by:
      test in class FluidIngredient
      Parameters:
      stack - the stack to test
      Returns:
      true if the stack matches, false otherwise

    • generateFluids

      public Stream<net.minecraft.core.Holder<net.minecraft.world.level.material.Fluid>> generateFluids()
      Description copied from class: FluidIngredient
      Returns a stream of fluids accepted by this ingredient.

      For compatibility reasons, implementations should follow the same guidelines as for custom item ingredients, i.e.:

      • Returned fluids are generally used for display purposes, and need not be exhaustive or perfectly accurate, as ingredients may additionally filter by e.g. data component values.
      • An exception is ingredients that are simple, for which it is important that this stream corresponds exactly all fluids accepted by FluidIngredient.test(FluidStack)!
      • At least one stack should always be returned, so that the ingredient is not considered empty. Empty ingredients may invalidate recipes!

      Note: no caching needs to be done by the implementation, this is already handled by FluidIngredient.fluids!

      Specified by:
      generateFluids in class FluidIngredient
      Returns:
      a stream of all fluid stacks this ingredient accepts.

      Note: No guarantees are made as to the amount of the fluid, as FluidIngredients are generally not meant to match by amount and these stacks are mostly used for display.

      See Also:

    • isSimple

      public boolean isSimple()
      Description copied from class: FluidIngredient
      Returns whether this fluid ingredient always requires direct stack testing.
      Specified by:
      isSimple in class FluidIngredient
      Returns:
      true if this ingredient ignores NBT data when matching stacks, false otherwise
      See Also:

    • getType

      public FluidIngredientType<?> getType()
      Description copied from class: FluidIngredient
      Returns The type of this fluid ingredient..

      The type must be registered to NeoForgeRegistries.FLUID_INGREDIENT_TYPES.

      Specified by:
      getType in class FluidIngredient
      Returns:
      The type of this fluid ingredient.

    • base

      public FluidIngredient base()

    • display

      public net.minecraft.world.item.crafting.display.SlotDisplay display()
      Description copied from class: FluidIngredient
      Returns a slot display for this ingredient, used for display on the client-side.
      Overrides:
      display in class FluidIngredient
      Returns:
      a slot display for this ingredient, used for display on the client-side
      See Also:

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in class FluidIngredient

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in class FluidIngredient

    • toString

      public String toString()
      Overrides:
      toString in class Object