Record Class TextPage

java.lang.Object
java.lang.Record
net.ixdarklord.folios.internal.client.page.TextPage
All Implemented Interfaces:
GuidePage
public record TextPage(Optional<String> title, String text, List<GuidePage> elements) extends Record implements GuidePage

  • Field Details

    • CODEC

      public static final com.mojang.serialization.MapCodec<TextPage> CODEC

  • Constructor Details

    • TextPage

      public TextPage(Optional<String> title, String text, List<GuidePage> elements)
      Creates an instance of a TextPage record class.
      Parameters:
      title - the value for the title record component
      text - the value for the text record component
      elements - the value for the elements record component

  • Method Details

    • lay

      public List<GuidePage.Laid> lay(GuideLayout layout)
      Description copied from interface: GuidePage
      Sets the page out: one or more pages, each drawn on its own.
      Specified by:
      lay in interface GuidePage

    • searchText

      public String searchText()
      Description copied from interface: GuidePage
      Words of the page a search should find it by.
      Specified by:
      searchText in interface GuidePage

    • items

      public List<GuideStack> items()
      Description copied from interface: GuidePage
      The items this page is about: anywhere in the book, pressing one of them opens this page.
      Specified by:
      items in interface GuidePage

    • objectives

      public List<GuideObjective> objectives()
      Description copied from interface: GuidePage
      What the page asks the player to do, if it is a quest: an entry with objectives shows how far along they are on its row, and a toast says when they are all done.
      Specified by:
      objectives in interface GuidePage

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

    • title

      public Optional<String> title()
      Returns the value of the title record component.
      Returns:
      the value of the title record component

    • text

      public String text()
      Returns the value of the text record component.
      Returns:
      the value of the text record component

    • elements

      public List<GuidePage> elements()
      Returns the value of the elements record component.
      Returns:
      the value of the elements record component