Package dev.jaxydog.astral.utility

Record Class CurrencyHelper.Reward

java.lang.Object
java.lang.Record
dev.jaxydog.astral.utility.CurrencyHelper.Reward
Record Components:
itemId - The representing item's identifier.
weight - The randomness weight used for reward drops.
All Implemented Interfaces:
CurrencyHelper.ItemRepresentable
Enclosing interface:
CurrencyHelper
public static record CurrencyHelper.Reward(net.minecraft.util.Identifier itemId, int weight) extends Record implements CurrencyHelper.ItemRepresentable
An item given as a reward for converting currency.
Since:
2.0.0

  • Field Details

  • Constructor Details

    • Reward

      public Reward(net.minecraft.util.Identifier itemId, int weight)
      Creates an instance of a Reward record class.
      Parameters:
      itemId - the value for the itemId record component
      weight - the value for the weight record component

  • Method Details

    • parse

      public static CurrencyHelper.Reward parse(net.minecraft.util.Identifier itemId, com.google.gson.JsonObject object) throws com.google.gson.JsonSyntaxException
      Parses a JSON object and creates a new CurrencyHelper.Reward from the resolved data.
      Parameters:
      itemId - The representing item's identifier.
      object - The JSON object.
      Returns:
      A new reward.
      Throws:
      com.google.gson.JsonSyntaxException - If a field is invalid or missing from the given object.
      Since:
      2.0.0

    • getRandom

      public static List<CurrencyHelper.Reward> getRandom(int count)
      Returns a list of randomly generated rewards.
      Parameters:
      count - The number of rewards to generate.
      Returns:
      A list of randomly generated rewards.
      Since:
      2.0.0

    • getItemId

      public net.minecraft.util.Identifier getItemId()
      Description copied from interface: CurrencyHelper.ItemRepresentable
      Returns the associated item identifier, or minecraft:air if the referenced identifier is invalid.
      Specified by:
      getItemId in interface CurrencyHelper.ItemRepresentable
      Returns:
      The associated item identifier, or minecraft:air if the referenced identifier is invalid.

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

    • itemId

      public net.minecraft.util.Identifier itemId()
      Returns the value of the itemId record component.
      Returns:
      the value of the itemId record component

    • weight

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