Package org.spongepowered.api.item.recipe.cooking

Record Class CookingResult

java.lang.Object
java.lang.Record
org.spongepowered.api.item.recipe.cooking.CookingResult
public record CookingResult(ItemStackSnapshot result, double experience) extends Record
The result of fulfilling a CookingRecipe.

  • Constructor Details

    • CookingResult

      public CookingResult(ItemStackLike result, double experience)
      Creates a new CookingResult.

      Note that this may be replaced with a static of method in the future.

      Parameters:
      result - The result of the cooking recipe
      experience - The experience that should be created from this result

    • CookingResult

      public CookingResult(ItemStackSnapshot result, double experience)
      Creates a new CookingResult.

      Note that this may be replaced with a static of method in the future.

      Parameters:
      result - The result of the cooking recipe
      experience - The experience that should be created from this result

  • Method Details

    • result

      public ItemStackSnapshot result()
      This method should be used instead of the Recipe.exemplaryResult() method, as it customizes the result further depending on the specified ingredient ItemStackSnapshot. It is advised to use the output of Recipe.exemplaryResult(), modify it accordingly, and return it.
      Returns:
      The result of fulfilling the requirements of a CookingRecipe

    • experience

      public double experience()
      Returns the amount of experience released after completing a recipe.
      Returns:
      The amount of experience released after fulfilling the requirements of a CookingRecipe

    • 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.