Ingredient (SpongeAPI 7.3.0 API)

All Superinterfaces:

Predicate<ItemStack>
```
public interface Ingredient
extends Predicate<ItemStack>
```
An Ingredient for a crafting recipe.
Crafting recipes can only be crafted when all of the ingredients match the items in the input grid.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface Ingredient.Builder
Builder for Ingredients.

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Ingredient.Builder` Builder for `Ingredient`s.

Field Summary

Fields
Modifier and Type Field and Description

static Ingredient NONE
An empty ingredient.

Fields
Modifier and Type	Field and Description
`static Ingredient`	`NONE` An empty ingredient.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static Ingredient.Builder`	`builder()` Creates a new `Ingredient.Builder` to build an `Ingredient`.
`List<ItemStackSnapshot>`	`displayedItems()` Returns the list of `ItemStack`s used to display the ingredient in a recipe.
`static Ingredient`	`of(GameDictionary.Entry... entries)` Creates a new `Ingredient` for the provided `GameDictionary.Entry`s.
`static Ingredient`	`of(ItemStack... itemStacks)` Creates a new `Ingredient` for the provided `ItemStack`s.
`static Ingredient`	`of(ItemStackSnapshot... snapshots)` Creates a new `Ingredient` for the provided `ItemStackSnapshot`s.
`static Ingredient`	`of(ItemType... itemTypes)` Creates a new `Ingredient` for the provided `ItemType`s.
`boolean`	`test(ItemStack itemStack)`

Methods inherited from interface java.util.function.Predicate
and, isEqual, negate, or

- Field Detail
  - NONE
```
static final Ingredient NONE
```
    An empty ingredient.
- Method Detail
  - test
```
boolean test(ItemStack itemStack)
```
    Specified by:
    
    test in interface Predicate<ItemStack>
  - displayedItems
```
List<ItemStackSnapshot> displayedItems()
```
    Returns the list of ItemStacks used to display the ingredient in a recipe. These are not necessarily all the items that this Ingredient can match.
    
    Returns:
    
    The list of items to display the Ingredient in a recipe.
  - builder
```
static Ingredient.Builder builder()
```
    Creates a new Ingredient.Builder to build an Ingredient.
    
    Returns:
    
    The new builder
  - of
```
static Ingredient of(@Nullable
                     ItemStackSnapshot... snapshots)
```
    Creates a new Ingredient for the provided ItemStackSnapshots.
    
    Parameters:
    
    snapshots - The snapshots
    
    Returns:
    
    The new ingredient
  - of
```
static Ingredient of(@Nullable
                     ItemStack... itemStacks)
```
    Creates a new Ingredient for the provided ItemStacks.
    
    Parameters:
    
    itemStacks - The itemStacks
    
    Returns:
    
    The new ingredient
  - of
```
static Ingredient of(@Nullable
                     ItemType... itemTypes)
```
    Creates a new Ingredient for the provided ItemTypes.
    
    Parameters:
    
    itemTypes - The items
    
    Returns:
    
    The new ingredient
  - of
```
static Ingredient of(@Nullable
                     GameDictionary.Entry... entries)
```
    Creates a new Ingredient for the provided GameDictionary.Entrys.
    
    Parameters:
    
    entries - The GameDictionary Entries
    
    Returns:
    
    The new ingredient

Interface Ingredient

Nested Class Summary

Field Summary

Method Summary

Methods inherited from interface java.util.function.Predicate

Field Detail

NONE

Method Detail

test

displayedItems

builder

of

of

of

of