Record Class CurrencyHelper.Skeleton

java.lang.Object
java.lang.Record
dev.jaxydog.astral.utility.CurrencyHelper.Skeleton
Record Components:
itemId - The representing item's identifier.
requires - A list of required rewards to create this skeleton.
All Implemented Interfaces:
CurrencyHelper.ItemRepresentable
Enclosing interface:
CurrencyHelper

public static record CurrencyHelper.Skeleton(net.minecraft.util.Identifier itemId, List<net.minecraft.util.Identifier> requires) extends Record implements CurrencyHelper.ItemRepresentable
An item created using multiple reward items.
Since:
2.0.0
  • Field Details

  • Constructor Details

    • Skeleton

      public Skeleton(net.minecraft.util.Identifier itemId, List<net.minecraft.util.Identifier> requires)
      Creates an instance of a Skeleton record class.
      Parameters:
      itemId - the value for the itemId record component
      requires - the value for the requires record component
  • Method Details

    • parse

      public static CurrencyHelper.Skeleton 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.Skeleton 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
    • getRequirements

      public List<CurrencyHelper.Reward> getRequirements()
      Returns a list of required reward entries.

      If a requirement's identifier is not found it will be ignored.

      Returns:
      A list of required rewards.
      Since:
      2.0.0
    • hasRequirements

      public boolean hasRequirements(Map<CurrencyHelper.Reward,Integer> rewardCounts)
      Returns whether the provided count map contains the required number of rewards to craft this skeleton.
      Parameters:
      rewardCounts - A map containing the number of each held reward.
      Returns:
      Whether the provided count map contains the required number of rewards to craft this skeleton.
      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. 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.
    • itemId

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

      public List<net.minecraft.util.Identifier> requires()
      Returns the value of the requires record component.
      Returns:
      the value of the requires record component