me.desht.pneumaticcraft.api.crafting.ingredient

Class FluidIngredient

java.lang.Object

net.minecraft.item.crafting.Ingredient

me.desht.pneumaticcraft.api.crafting.ingredient.FluidIngredient

All Implemented Interfaces:

java.util.function.Predicate<net.minecraft.item.ItemStack>

Direct Known Subclasses:

CompoundFluidIngredient

public class FluidIngredient
extends net.minecraft.item.crafting.Ingredient

A fluid ingredient matcher, with fluid tag support. Can also match items; it checks if the item contains the desired fluid.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FluidIngredient.Serializer

Nested classes/interfaces inherited from class net.minecraft.item.crafting.Ingredient

net.minecraft.item.crafting.Ingredient.IItemList, net.minecraft.item.crafting.Ingredient.SingleItemList, net.minecraft.item.crafting.Ingredient.TagList

Field Summary

Fields

Modifier and Type	Field and Description
static FluidIngredient	EMPTY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FluidIngredient(java.util.List<net.minecraft.fluid.Fluid> fluids, int amount, net.minecraft.util.ResourceLocation fluidId, net.minecraft.tags.ITag<net.minecraft.fluid.Fluid> fluidTag, net.minecraft.nbt.CompoundNBT nbt, boolean fuzzyNBT)

Method Summary

Modifier and Type	Method and Description
int	getAmount()
protected java.util.Collection<net.minecraft.fluid.Fluid>	getFluidList()
java.util.List<net.minecraftforge.fluids.FluidStack>	getFluidStacks()
net.minecraft.item.ItemStack[]	getItems()
net.minecraftforge.common.crafting.IIngredientSerializer<? extends net.minecraft.item.crafting.Ingredient>	getSerializer()
boolean	isEmpty()
static FluidIngredient	of(net.minecraftforge.fluids.FluidStack fluidStack) Create a fluid ingredient from the given FluidStack.
static FluidIngredient	of(int amount, net.minecraft.nbt.CompoundNBT nbt, boolean fuzzyNBT, net.minecraft.fluid.Fluid... fluids) Create a fluid ingredient from the given list of fluids
static FluidIngredient	of(int amount, net.minecraft.nbt.CompoundNBT nbt, boolean fuzzyNBT, net.minecraft.tags.ITag<net.minecraft.fluid.Fluid> fluidTag) Create a fluid ingredient from the given fluid tag
static FluidIngredient	of(int amount, net.minecraft.nbt.CompoundNBT nbt, boolean fuzzyNBT, net.minecraft.util.ResourceLocation fluidId) Create a fluid ingredient from the given fluid registry ID.
static FluidIngredient	of(int amount, net.minecraft.fluid.Fluid... fluids) Create a fluid ingredient from the given list of fluids
static FluidIngredient	of(int amount, net.minecraft.tags.ITag<net.minecraft.fluid.Fluid> fluidTag) Create a fluid ingredient from the given fluid tag
static FluidIngredient	of(int amount, net.minecraft.util.ResourceLocation fluidId) Create a fluid ingredient from the given fluid registry ID.
static FluidIngredient	ofFluidStream(java.util.stream.Stream<FluidIngredient> stream) Create a fluid ingredient from the given stream of other fluid ingredients.
boolean	test(net.minecraft.item.ItemStack stack) Test the given item against this ingredient.
boolean	testFluid(net.minecraft.fluid.Fluid fluid) Test the given fluid against this ingredient.
boolean	testFluid(net.minecraftforge.fluids.FluidStack fluidStack) Test the given fluid stack against this ingredient.
com.google.gson.JsonElement	toJson()

Methods inherited from class net.minecraft.item.crafting.Ingredient

fromJson, fromNetwork, fromValues, getStackingIds, invalidate, invalidateAll, isSimple, isVanilla, merge, of, of, of, of, toNetwork, valueFromJson

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Predicate

and, isEqual, negate, or

Field Detail

EMPTY

public static final FluidIngredient EMPTY

Constructor Detail

FluidIngredient

protected FluidIngredient(java.util.List<net.minecraft.fluid.Fluid> fluids,
                          int amount,
                          net.minecraft.util.ResourceLocation fluidId,
                          net.minecraft.tags.ITag<net.minecraft.fluid.Fluid> fluidTag,
                          net.minecraft.nbt.CompoundNBT nbt,
                          boolean fuzzyNBT)

Method Detail

of

public static FluidIngredient of(net.minecraftforge.fluids.FluidStack fluidStack)

Create a fluid ingredient from the given FluidStack. If the FluidStack has any NBT, this will also be required as an ingredient match, in a non-fuzzy way (exact match of all fields required).

Parameters:

fluidStack - the fluidstack to match against

Returns:

the fluid ingredient

of

public static FluidIngredient of(int amount,
                                 @Nullable
                                 net.minecraft.nbt.CompoundNBT nbt,
                                 boolean fuzzyNBT,
                                 net.minecraft.fluid.Fluid... fluids)

Create a fluid ingredient from the given list of fluids

Parameters:

amount - the amount, in mB

nbt - the NBT, or null for no NBT matching

fuzzyNBT - true for a fuzzy match (only fields in the ingredient will be matched), false for an exact match. Ignored if the nbt parameter is null.

fluids - the list of fluids

Returns:

the fluid ingredient

of

public static FluidIngredient of(int amount,
                                 net.minecraft.fluid.Fluid... fluids)

Create a fluid ingredient from the given list of fluids

Parameters:

amount - the amount, in mB

fluids - the list of fluids

Returns:

the fluid ingredient

of

public static FluidIngredient of(int amount,
                                 @Nullable
                                 net.minecraft.nbt.CompoundNBT nbt,
                                 boolean fuzzyNBT,
                                 net.minecraft.tags.ITag<net.minecraft.fluid.Fluid> fluidTag)

Create a fluid ingredient from the given fluid tag

Parameters:

amount - the amount, in mB

nbt - the NBT, or null for no NBT matching

fuzzyNBT - true for a fuzzy match (only fields in the ingredient will be matched), false for an exact match. Ignored if the nbt parameter is null.

fluidTag - the fluid tag

Returns:

the fluid ingredient

of

public static FluidIngredient of(int amount,
                                 net.minecraft.tags.ITag<net.minecraft.fluid.Fluid> fluidTag)

Create a fluid ingredient from the given fluid tag

Parameters:

amount - the amount, in mB

fluidTag - the fluid tag

Returns:

the fluid ingredient

of

public static FluidIngredient of(int amount,
                                 @Nullable
                                 net.minecraft.nbt.CompoundNBT nbt,
                                 boolean fuzzyNBT,
                                 net.minecraft.util.ResourceLocation fluidId)

Create a fluid ingredient from the given fluid registry ID. Use this if the fluid might not exist at runtime (e.g. it's from another mod which may or may not be loaded). If the fluid does not exist at runtime, this ingredient will never match anything.

Parameters:

amount - the amount, in mB

nbt - the NBT, or null for no NBT matching

fuzzyNBT - true for a fuzzy match (only fields in the ingredient will be matched), false for an exact match. Ignored if the nbt parameter is null.

fluidId - the fluid's registry ID

Returns:

the fluid ingredient

of

public static FluidIngredient of(int amount,
                                 net.minecraft.util.ResourceLocation fluidId)

Create a fluid ingredient from the given fluid registry ID. Use this if the fluid might not exist at runtime (e.g. it's from another mod which may or may not be loaded). If the fluid does not exist at runtime, this ingredient will never match anything.

Parameters:

amount - the amount, in mB

fluidId - the fluid's registry ID

Returns:

the fluid ingredient

ofFluidStream

public static FluidIngredient ofFluidStream(java.util.stream.Stream<FluidIngredient> stream)

Create a fluid ingredient from the given stream of other fluid ingredients. This new compound ingredient is effectively a logical OR of all the constituent ingredients.

Parameters:

stream - a stream of ingredients

Returns:

the fluid ingredient

API Note:

this method is called "ofFluidStream" rather than "of" to avoid confusion with Ingredient.of(Stream)

getFluidList

protected java.util.Collection<net.minecraft.fluid.Fluid> getFluidList()

isEmpty

public boolean isEmpty()

Overrides:

isEmpty in class net.minecraft.item.crafting.Ingredient

test

public boolean test(@Nullable
                    net.minecraft.item.ItemStack stack)

Test the given item against this ingredient. The item must be a fluid container item (providing the CapabilityFluidHandler.FLUID_HANDLER_ITEM_CAPABILITY capability) containing fluid which matches this ingredient, AND it must be a container item (IForgeItem.hasContainerItem(ItemStack) must return true).

Specified by:

test in interface java.util.function.Predicate<net.minecraft.item.ItemStack>

Overrides:

test in class net.minecraft.item.crafting.Ingredient

Parameters:

stack - the itemstack to test

Returns:

true if the fluid in the given itemstack matches this ingredient

getItems

public net.minecraft.item.ItemStack[] getItems()

Overrides:

getItems in class net.minecraft.item.crafting.Ingredient

testFluid

public boolean testFluid(net.minecraftforge.fluids.FluidStack fluidStack)

Test the given fluid stack against this ingredient. The fluid must match, and the fluid stack amount must be at least as large. In addition, if the ingredient specifies any NBT, that must also match.

Parameters:

fluidStack - the fluid stack to test

Returns:

true if the fluid stack matches, false otherwise

testFluid

public boolean testFluid(net.minecraft.fluid.Fluid fluid)

Test the given fluid against this ingredient. Just a fluid match; no amount or NBT matching is done.

Parameters:

fluid - the fluid to test

Returns:

true if the fluid matches, false otherwise

toJson

public com.google.gson.JsonElement toJson()

Overrides:

toJson in class net.minecraft.item.crafting.Ingredient

getSerializer

public net.minecraftforge.common.crafting.IIngredientSerializer<? extends net.minecraft.item.crafting.Ingredient> getSerializer()

Overrides:

getSerializer in class net.minecraft.item.crafting.Ingredient

getAmount

public int getAmount()

getFluidStacks

public java.util.List<net.minecraftforge.fluids.FluidStack> getFluidStacks()