Record Class FoliosBook.Handling

java.lang.Object
java.lang.Record
net.ixdarklord.folios.api.client.FoliosBook.Handling
Enclosing class:
FoliosBook
public static record FoliosBook.Handling(boolean lookAround, boolean walk) extends Record
What a reader can do while holding a handheld book open: "handheld" in book.json. 
"handheld": {
  "look_around": true,  // holding the right mouse button turns the reader's head, the book with it
  "walk": true          // the movement keys walk, jump, sneak and sprint (the arrow keys still turn the leaves)
}

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final FoliosBook.Handling
    DEFAULT
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    Handling(boolean lookAround, boolean walk)
    Creates an instance of a Handling record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    lookAround()
    Returns the value of the lookAround record component.
    final String
    toString()
    Returns a string representation of this record class.
    boolean
    walk()
    Returns the value of the walk record component.

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

  • Constructor Details

    • Handling

      public Handling(boolean lookAround, boolean walk)
      Creates an instance of a Handling record class.
      Parameters:
      lookAround - the value for the lookAround record component
      walk - the value for the walk 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.

    • lookAround

      public boolean lookAround()
      Returns the value of the lookAround record component.
      Returns:
      the value of the lookAround record component

    • walk

      public boolean walk()
      Returns the value of the walk record component.
      Returns:
      the value of the walk record component