Record Class PlayerDataStorage.Experience

java.lang.Object
java.lang.Record
fr.fidorial.storage.player.PlayerDataStorage.Experience
Record Components:
level - the experience level
progress - how far towards the next level, from 0 to 1 excluded
total - every experience point gained since the player last lost their experience
Enclosing interface:
PlayerDataStorage

public static record PlayerDataStorage.Experience(int level, float progress, int total) extends Record
The experience of a player.
Since:
0.1.0
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    No experience at all: what a new player has.
  • Constructor Summary

    Constructors
    Constructor
    Description
    Experience(int level, float progress, int total)
    Creates an instance of a Experience record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    int
    Returns the value of the level record component.
    float
    Returns the value of the progress record component.
    final String
    Returns a string representation of this record class.
    int
    Returns the value of the total record component.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Field Details

  • Constructor Details

    • Experience

      public Experience(int level, float progress, int total)
      Creates an instance of a Experience record class.
      Parameters:
      level - the value for the level record component
      progress - the value for the progress record component
      total - the value for the total 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 the compare method from their corresponding wrapper classes.
      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.
    • level

      public int level()
      Returns the value of the level record component.
      Returns:
      the value of the level record component
    • progress

      public float progress()
      Returns the value of the progress record component.
      Returns:
      the value of the progress record component
    • total

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