Package net.neoforged.neoforge.common.crafting

Class BlockTagIngredient

java.lang.Object
net.neoforged.neoforge.common.crafting.BlockTagIngredient
All Implemented Interfaces:
ICustomIngredient
public class BlockTagIngredient extends Object implements ICustomIngredient
Ingredient that matches ItemStacks of Blocks from a TagKey<Block>, useful in cases like "minecraft:convertable_to_mud" where there isn't an accompanying item tag

Notice: This should not be used as a replacement for the normal item tag ingredient. This should only be used when there is no way an item tag can be used in your use case

  • Field Details

  • Constructor Details

    • BlockTagIngredient

      public BlockTagIngredient(TagKey<Block> tag)

  • Method Details

    • dissolve

      protected HolderSet<Item> dissolve()

    • 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

    • test

      public boolean test(@Nullable @Nullable 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

    • getTag

      public TagKey<Block> getTag()

    • 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

    • display

      public SlotDisplay display()
      Description copied from interface: ICustomIngredient
      Returns the display for this ingredient.

      The display is synced to the client, and is also used to retrieve the ItemStacks that are shown to the client.

      Specified by:
      display in interface ICustomIngredient

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object