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:
FoliosPageElement
public record SpreadPage(Optional<String> title, String text, Optional<net.minecraft.resources.ResourceLocation> image, Optional<String> build, Optional<SpreadPage.Build> multiblock, Optional<SpreadPage.MapLayout> map, int height) extends Record implements FoliosPageElement

  • 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<String> build, Optional<SpreadPage.Build> multiblock, 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
      multiblock - the value for the multiblock 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: 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

    • 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

    • 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<String> build()
      Returns the value of the build record component.
      Returns:
      the value of the build record component

    • multiblock

      public Optional<SpreadPage.Build> multiblock()
      Returns the value of the multiblock record component.
      Returns:
      the value of the multiblock 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