Package com.pixelmonmod.pixelmon.battles.api.rules

Record Class ReasonedBattleRequirement

java.lang.Object
java.lang.Record
com.pixelmonmod.pixelmon.battles.api.rules.ReasonedBattleRequirement
Record Components:
requirement - The battle requirement that must be met.
reason - The reason for the requirement, which will be displayed to the player if the requirement is not met.
public record ReasonedBattleRequirement(BattleRequirement requirement, net.minecraft.network.chat.Component reason) extends Record
A reasoned battle requirement represents a battle requirement and a reason for that requirement, so that we can provide feedback to the player about why their party is not valid for a battle.

  • Field Details

  • Constructor Details

    • ReasonedBattleRequirement

      public ReasonedBattleRequirement(BattleRequirement requirement, String reason)

    • ReasonedBattleRequirement

      public ReasonedBattleRequirement(BattleRequirement requirement, net.minecraft.network.chat.Component reason)
      Creates an instance of a ReasonedBattleRequirement record class.
      Parameters:
      requirement - the value for the requirement record component
      reason - the value for the reason record component

  • Method Details

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

    • requirement

      public BattleRequirement requirement()
      Returns the value of the requirement record component.
      Returns:
      the value of the requirement record component

    • reason

      public net.minecraft.network.chat.Component reason()
      Returns the value of the reason record component.
      Returns:
      the value of the reason record component