Package com.minecolonies.api.crafting

Record Class CountedIngredient

java.lang.Object
java.lang.Record
com.minecolonies.api.crafting.CountedIngredient
Record Components:
child - the underlying ingredient.
count - the number of items required.
All Implemented Interfaces:
net.neoforged.neoforge.common.crafting.ICustomIngredient
public record CountedIngredient(@NotNull net.minecraft.world.item.crafting.Ingredient child, int count) extends Record implements net.neoforged.neoforge.common.crafting.ICustomIngredient
An ingredient that can be used in a vanilla recipe to require more than one item in a particular input slot. Similar to SizedIngredient, but this deliberately skips the count check in test(ItemStack) to more easily support consuming across multiple inventory slots -- and unlike that, it participates as a custom ingredient directly. { "type": "minecolonies:counted", "item": { "item": "minecraft:cobblestone" // could be a tag or something else }, "count": 16 }

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final com.mojang.serialization.MapCodec<CountedIngredient>
    CODEC
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    CountedIngredient(@NotNull net.minecraft.world.item.crafting.Ingredient child, int count)
    Creates an instance of a CountedIngredient record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull net.minecraft.world.item.crafting.Ingredient
    child()
    Returns the value of the child record component.
    int
    count()
    Returns the value of the count record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    @NotNull Stream<net.minecraft.world.item.ItemStack>
    getItems()
     
    @NotNull net.neoforged.neoforge.common.crafting.IngredientType<?>
    getType()
     
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    isSimple()
     
    static net.minecraft.world.item.crafting.Ingredient
    of(@NotNull net.minecraft.world.item.crafting.Ingredient child, int count)
    Creates a counted ingredient.
    boolean
    test(@Nullable net.minecraft.world.item.ItemStack stack)
    Tests if the given stack matches the base ingredient.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface net.neoforged.neoforge.common.crafting.ICustomIngredient

    toVanilla

  • Field Details

    • CODEC

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

  • Constructor Details

    • CountedIngredient

      public CountedIngredient(@NotNull @NotNull net.minecraft.world.item.crafting.Ingredient child, int count)
      Creates an instance of a CountedIngredient record class.
      Parameters:
      child - the value for the child record component
      count - the value for the count record component

  • Method Details

    • of

      public static net.minecraft.world.item.crafting.Ingredient of(@NotNull @NotNull net.minecraft.world.item.crafting.Ingredient child, int count)
      Creates a counted ingredient.
      Parameters:
      child - the underlying ingredient.
      count - the number of items required.
      Returns:
      the counted ingredient.

    • test

      public boolean test(@Nullable @Nullable net.minecraft.world.item.ItemStack stack)
      Tests if the given stack matches the base ingredient. Note: deliberately does *not* verify the count.
      Specified by:
      test in interface net.neoforged.neoforge.common.crafting.ICustomIngredient
      Parameters:
      stack - the stack to test
      Returns:
      true if the stack is the matching ingredient, regardless of count.

    • isSimple

      public boolean isSimple()
      Specified by:
      isSimple in interface net.neoforged.neoforge.common.crafting.ICustomIngredient

    • getType

      @NotNull public @NotNull net.neoforged.neoforge.common.crafting.IngredientType<?> getType()
      Specified by:
      getType in interface net.neoforged.neoforge.common.crafting.ICustomIngredient

    • getItems

      @NotNull public @NotNull Stream<net.minecraft.world.item.ItemStack> getItems()
      Specified by:
      getItems in interface net.neoforged.neoforge.common.crafting.ICustomIngredient

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • child

      @NotNull public @NotNull net.minecraft.world.item.crafting.Ingredient child()
      Returns the value of the child record component.
      Returns:
      the value of the child record component

    • count

      public int count()
      Returns the value of the count record component.
      Returns:
      the value of the count record component