Package net.ixdarklord.folios.internal.client.page

Record Class SpreadPage

java.lang.Object
java.lang.Record
net.ixdarklord.folios.internal.client.page.SpreadPage
All Implemented Interfaces:
GuidePage
public record SpreadPage(Optional<String> title, String text, Optional<net.minecraft.resources.ResourceLocation> image, Optional<SpreadPage.Build> build, Optional<SpreadPage.MapLayout> map, int height) extends Record implements GuidePage

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final record 
    SpreadPage.Build
    A build in the window: a multiblock page's pattern and mapping.
    static final record 
    SpreadPage.MapLayout
    The map: its places, the paths between them (pairs of ids), and a picture under them.
    static final record 
    SpreadPage.Node
    A place on the map: where it is in the window, what it shows, and the entry it opens.

    Nested classes/interfaces inherited from interface net.ixdarklord.folios.api.client.page.GuidePage

    GuidePage.Laid, GuidePage.SpreadHalf

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final com.mojang.serialization.MapCodec<SpreadPage>
    CODEC
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    SpreadPage(Optional<String> title, String text, Optional<net.minecraft.resources.ResourceLocation> image, Optional<SpreadPage.Build> build, Optional<SpreadPage.MapLayout> map, int height)
    Creates an instance of a SpreadPage record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<SpreadPage.Build>
    build()
    Returns the value of the build record component.
    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.
    int
    height()
    Returns the value of the height record component.
    Optional<net.minecraft.resources.ResourceLocation>
    image()
    Returns the value of the image record component.
    List<GuidePage.Laid>
    lay(GuideLayout layout)
    Sets the page out: one or more pages, each drawn on its own.
    Optional<SpreadPage.MapLayout>
    map()
    Returns the value of the map record component.
    String
    searchText()
    Words of the page a search should find it by.
    boolean
    spread()
    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).
    String
    text()
    Returns the value of the text record component.
    Optional<String>
    title()
    Returns the value of the title record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface net.ixdarklord.folios.api.client.page.GuidePage

    items, objectives

  • Field Details

    • CODEC

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

  • Constructor Details

    • SpreadPage

      public SpreadPage(Optional<String> title, String text, Optional<net.minecraft.resources.ResourceLocation> image, Optional<SpreadPage.Build> build, Optional<SpreadPage.MapLayout> map, int height)
      Creates an instance of a SpreadPage record class.
      Parameters:
      title - the value for the title record component
      text - the value for the text record component
      image - the value for the image record component
      build - the value for the build record component
      map - the value for the map record component
      height - the value for the height record component

  • Method Details

    • spread

      public boolean spread()
      Description copied from interface: GuidePage
      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 GuidePage

    • 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

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

    • image

      public Optional<net.minecraft.resources.ResourceLocation> image()
      Returns the value of the image record component.
      Returns:
      the value of the image record component

    • build

      public Optional<SpreadPage.Build> build()
      Returns the value of the build record component.
      Returns:
      the value of the build record component

    • map

      public Optional<SpreadPage.MapLayout> map()
      Returns the value of the map record component.
      Returns:
      the value of the map record component

    • height

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