Record Class TextPage

java.lang.Object
java.lang.Record
net.ixdarklord.folios.internal.client.page.TextPage
All Implemented Interfaces:
FoliosPageElement
public record TextPage(Optional<String> title, String text, List<TextPage.Item> elements, ElementLayout settings, boolean single, @Nullable Observed observed) extends Record implements FoliosPageElement

  • Field Details

    • CODEC

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

  • Constructor Details

    • TextPage

      public TextPage(Optional<String> title, String text, List<TextPage.Item> elements, ElementLayout settings, boolean single, @Nullable Observed observed)
      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
      settings - the value for the settings record component
      single - the value for the single record component
      observed - the value for the observed record component

  • Method Details

    • single

      public static TextPage single(FoliosPageElement element, ElementLayout settings, @Nullable Observed observed)
      A page of one element, set as its JSON says (it lays itself out as its type does when it can't be set so).

    • with

      public TextPage with(ElementLayout settings, @Nullable Observed observed)
      This page, set as its JSON says, its text observing a source (null for none).

    • lay

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

    • searchText

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

    • spread

      public boolean spread()
      Description copied from interface: FoliosPageElement
      Whether the page spreads over both pages of an open book: its laid pages then come in pairs, a left page and the right page beside it, and it starts on a left page (an empty page is put before it if need be).
      Specified by:
      spread in interface FoliosPageElement

    • items

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

    • objectives

      public List<FoliosObjective> objectives()
      Description copied from interface: FoliosPageElement
      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 FoliosPageElement

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

    • 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<TextPage.Item> elements()
      Returns the value of the elements record component.
      Returns:
      the value of the elements record component

    • settings

      public ElementLayout settings()
      Returns the value of the settings record component.
      Returns:
      the value of the settings record component

    • single

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

    • observed

      public @Nullable Observed observed()
      Returns the value of the observed record component.
      Returns:
      the value of the observed record component