Record Class TypeAttachedAdvancedIngredient<STACK,INGREDIENT extends ITypelessAdvancedIngredient<? super STACK>>

java.lang.Object
java.lang.Record
com.petrolpark.core.recipe.ingredient.advanced.TypeAttachedAdvancedIngredient<STACK,INGREDIENT>
All Implemented Interfaces:
IAdvancedIngredient<STACK>, IForcingItemAdvancedIngredient, ITypelessAdvancedIngredient<STACK>, Predicate<STACK>

public record TypeAttachedAdvancedIngredient<STACK,INGREDIENT extends ITypelessAdvancedIngredient<? super STACK>>(INGREDIENT extends ITypelessAdvancedIngredient<? super STACK> untypedIngredient, IAdvancedIngredientType<STACK> type) extends Record implements IAdvancedIngredient<STACK>, IForcingItemAdvancedIngredient
  • Constructor Details

    • TypeAttachedAdvancedIngredient

      public TypeAttachedAdvancedIngredient(INGREDIENT untypedIngredient, IAdvancedIngredientType<STACK> type)
      Creates an instance of a TypeAttachedAdvancedIngredient record class.
      Parameters:
      untypedIngredient - the value for the untypedIngredient record component
      type - the value for the type record component
  • Method Details

    • test

      public boolean test(STACK stack)
      Specified by:
      test in interface Predicate<STACK>
    • modifyExamples

      public Stream<STACK> modifyExamples(Stream<STACK> exampleStacks)
      Description copied from interface: ITypelessAdvancedIngredient
      Modify an example stack so it fulfill this IAdvancedIngredient.
      Specified by:
      modifyExamples in interface ITypelessAdvancedIngredient<STACK>
      Parameters:
      exampleStacks - May be modified
      Returns:
      A stack fulfilling this Ingredient, possibly the same object reference, or null if that stack can never fulfill this Ingredient
    • modifyCounterExamples

      public Stream<STACK> modifyCounterExamples(Stream<STACK> counterExampleStacks)
      Description copied from interface: ITypelessAdvancedIngredient
      Modify an example stack so it does not fulfill this IAdvancedIngredient.
      Specified by:
      modifyCounterExamples in interface ITypelessAdvancedIngredient<STACK>
      Parameters:
      counterExampleStacks - May be modified
      Returns:
      A stack not fulfilling this Ingredient, possibly the same object reference, or null if that stack always fulfills this Ingredient
    • addToDescription

      public void addToDescription(Lang.IndentedTooltipBuilder description)
      Specified by:
      addToDescription in interface ITypelessAdvancedIngredient<STACK>
    • addToCounterDescription

      public void addToCounterDescription(Lang.IndentedTooltipBuilder description)
      Specified by:
      addToCounterDescription in interface ITypelessAdvancedIngredient<STACK>
    • forceLootItemFunction

      @Nonnull public Optional<net.minecraft.world.item.ItemStack> forceLootItemFunction(net.minecraft.world.level.storage.loot.functions.LootItemFunction function, net.minecraft.world.level.storage.loot.LootContext context, net.minecraft.world.item.ItemStack stack)
      Description copied from interface: IForcingItemAdvancedIngredient
      Attempt to force the output of the given LootItemFunction to conform to this IAdvancedIngredient. This should not return an ItemStack which could not have been generated by the LootItemFunction naturally. It is not guaranteed that the returned ItemStack (if there is one) will conform, but this method should make a best effort.
      Specified by:
      forceLootItemFunction in interface IForcingItemAdvancedIngredient
      Parameters:
      function - The LootItemFunction being called. This will never be a SequenceFunction, as those are unpacked automatically. Also, if it is a LootItemConditionalFunction, then it will have already passed all conditions by the time this method is called.
      context -
      stack - The ItemStack to which the LootItemFunction is being applied
      Returns:
      Non-null Optional, filled if an ItemStack could be generated matching this IAdvancedIngredient, or empty if we could not force the output of the LootItemFunction successfully and it should be called as normal.
    • forbidLootItemFunction

      @Nonnull public Optional<net.minecraft.world.item.ItemStack> forbidLootItemFunction(net.minecraft.world.level.storage.loot.functions.LootItemFunction function, net.minecraft.world.level.storage.loot.LootContext context, net.minecraft.world.item.ItemStack stack)
      Description copied from interface: IForcingItemAdvancedIngredient
      Attempt to force the output of the given LootItemFunction so it does not conform to this IAdvancedIngredient. This should not return an ItemStack which could not have been generated by the LootItemFunction naturally. It is not guaranteed that the returned ItemStack (if there is one) won't conform, but this method should make a best effort.
      Specified by:
      forbidLootItemFunction in interface IForcingItemAdvancedIngredient
      Parameters:
      function - The LootItemFunction being called. This will never be a SequenceFunction, as those are unpacked automatically. Also, if it is a LootItemConditionalFunction, then it will have already passed all conditions by the time this method is called.
      context -
      stack - The ItemStack to which the LootItemFunction is being applied
      Returns:
      Non-null Optional, filled if an ItemStack could be generated not matching this IAdvancedIngredient, or empty if we could not force the output of the LootItemFunction successfully and it should be called as normal.
    • forceTradeListing

      @Nullable public Optional<net.minecraft.world.item.trading.MerchantOffer> forceTradeListing(net.minecraft.world.entity.npc.VillagerTrades.ItemListing tradeListing, net.minecraft.world.entity.Entity trader, net.minecraft.util.RandomSource random)
      Description copied from interface: IForcingItemAdvancedIngredient
      Attempt to force the output of the given VillagerTrades.ItemListing to a MerchantOffer whose output conforms to this IAdvancedIngredient. This should not generate a MerchantOffer which could not have been generated by the VillagerTrades.ItemListing naturally. It is not guaranteed that the result of the returned MerchantOffer (if there is one) will conform, but this method should make a best effort.
      Specified by:
      forceTradeListing in interface IForcingItemAdvancedIngredient
      Parameters:
      tradeListing -
      trader -
      random -
      Returns:
      null if this IAdvancedIngredient could not generate a MerchantOffer with a matching result, an empty Optional if the VillagerTrades.ItemListing should generate no MerchantOffer at all (i.e. return null), or a filled Optional containing a MerchantOffer with a matching result.
    • forbidTradeListing

      @Nullable public Optional<net.minecraft.world.item.trading.MerchantOffer> forbidTradeListing(net.minecraft.world.entity.npc.VillagerTrades.ItemListing tradeListing, net.minecraft.world.entity.Entity trader, net.minecraft.util.RandomSource random)
      Description copied from interface: IForcingItemAdvancedIngredient
      Attempt to force the output of the given VillagerTrades.ItemListing to a MerchantOffer whose output does not conform to this IAdvancedIngredient. This should not generate a MerchantOffer which could not have been generated by the VillagerTrades.ItemListing naturally. It is not guaranteed that the result of the returned MerchantOffer (if there is one) won't conform, but this method should make a best effort.
      Specified by:
      forbidTradeListing in interface IForcingItemAdvancedIngredient
      Parameters:
      tradeListing -
      trader -
      random -
      Returns:
      null if this IAdvancedIngredient could not generate a MerchantOffer with a non-matching result, an empty Optional if the VillagerTrades.ItemListing should generate no MerchantOffer at all (i.e. return null), or a filled Optional containing a MerchantOffer with a non-matching result.
    • getType

      public IAdvancedIngredientType<? super STACK> getType()
      Specified by:
      getType in interface IAdvancedIngredient<STACK>
    • simplify

      public IAdvancedIngredient<? super STACK> simplify()
      Description copied from interface: ITypelessAdvancedIngredient
      The IAdvancedIngredient (not necessarily of the same type) which is the exact same predicate as this, but which has the smallest possible overhead. It is acceptable to mutate this Ingredient while calling this method, so careful caching the unsimplified version. Usually this will just return this.
      Specified by:
      simplify in interface IAdvancedIngredient<STACK>
      Specified by:
      simplify in interface ITypelessAdvancedIngredient<STACK>
    • 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.
    • untypedIngredient

      public INGREDIENT untypedIngredient()
      Returns the value of the untypedIngredient record component.
      Returns:
      the value of the untypedIngredient record component
    • type

      Returns the value of the type record component.
      Returns:
      the value of the type record component