Package net.neoforged.neoforge.common.crafting

Record Class CustomDisplayIngredient

java.lang.Object
java.lang.Record
net.neoforged.neoforge.common.crafting.CustomDisplayIngredient
All Implemented Interfaces:
ICustomIngredient
public record CustomDisplayIngredient(Ingredient base, SlotDisplay display) extends Record implements ICustomIngredient
Ingredient that wraps another ingredient to override its SlotDisplay.

  • Field Details

    • base

      private final Ingredient base
      The field for the base record component.

    • display

      private final SlotDisplay display
      The field for the display record component.

    • CODEC

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

  • Constructor Details

    • CustomDisplayIngredient

      public CustomDisplayIngredient(Ingredient base, SlotDisplay display)
      Creates an instance of a CustomDisplayIngredient record class.
      Parameters:
      base - the value for the base record component
      display - the value for the display record component

  • Method Details

    • of

      public static Ingredient of(Ingredient base, SlotDisplay display)

    • test

      public boolean test(ItemStack stack)
      Description copied from interface: ICustomIngredient
      Checks if a stack matches this ingredient. The stack must not be modified in any way.
      Specified by:
      test in interface ICustomIngredient
      Parameters:
      stack - the stack to test
      Returns:
      true if the stack matches this ingredient, false otherwise

    • items

      public Stream<Holder<Item>> items()
      Description copied from interface: ICustomIngredient
      Returns the list of items that this ingredient accepts.

      The following guidelines should be followed for good compatibility:

      • At least one item must be returned for the ingredient not to be considered empty. Empty ingredients invalidate the entire recipe.
      • The ingredient should return all Items it might possible accept. This allows mods that inspect the ingredient to figure out which stacks it might accept.
      • Returned items might not always be accepted by the ingredient, as an ingredient might still perform additional NBT-dependent tests.
      • An exception is ingredients that are simple, for which testing a stack is equivalent to testing if the item is in the returned list.

      Note: no caching needs to be done by the implementation, this is already handled by the ingredient itself.

      Specified by:
      items in interface ICustomIngredient
      Returns:
      the list of items that this ingredient accepts

    • isSimple

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

    • getType

      public IngredientType<?> getType()
      Description copied from interface: ICustomIngredient
      Returns the type of this ingredient.

      The type must be registered to NeoForgeRegistries.INGREDIENT_TYPES.

      Specified by:
      getType in interface ICustomIngredient
      Returns:
      the type of this ingredient

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • base

      public Ingredient base()
      Returns the value of the base record component.
      Returns:
      the value of the base record component

    • display

      public SlotDisplay display()
      Returns the value of the display record component.
      Specified by:
      display in interface ICustomIngredient
      Returns:
      the value of the display record component