Record Class QuestPageElement

java.lang.Object
java.lang.Record
net.ixdarklord.folios.internal.client.page.QuestPageElement
All Implemented Interfaces:
FoliosPageElement
public record QuestPageElement(List<FoliosObjective> objectives, Optional<String> title, String text, Optional<String> reward, boolean inOrder, Optional<net.minecraft.resources.Identifier> quest, Optional<String> locked) extends Record implements FoliosPageElement

  • Nested Class Summary

    Nested classes/interfaces inherited from interface FoliosPageElement

    FoliosPageElement.Laid, FoliosPageElement.Part, FoliosPageElement.SpreadHalf

  • Field Summary

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    QuestPageElement(List<FoliosObjective> objectives, Optional<String> title, String text, Optional<String> reward, boolean inOrder, Optional<net.minecraft.resources.Identifier> quest, Optional<String> locked)
    Creates an instance of a QuestPageElement record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    bar(FoliosPainter painter, int x, int y, int width, int height, float fill, int color)
    A bar of a given fill (0 to 1) in a colour, drawn as pixel art.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    static void
    gilded(FoliosPainter painter, int x, int y, int width, float fill)
    The mastery bar, 7 pixels tall from (x, y), kin to the build guide's but its own: a soft shadow under it and to its right; a gilt rim, lighter along its top and darker along its foot, its corners rounded off and nothing standing past it; a dark groove with a faint light line along its floor; the filled length in the book's colour (green once full), lit along its top, shaded along its foot and banded with fine slanting stripes, a glint at its end; and quarters marked by gilt dividers inside the groove.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    inOrder()
    Returns the value of the inOrder record component.
    List<FoliosPageElement.Laid>
    lay(FoliosLayout layout)
    Sets the page out: one or more pages, each drawn on its own.
    Optional<String>
    locked()
    Returns the value of the locked record component.
    List<FoliosObjective>
    objectives()
    Returns the value of the objectives record component.
    Optional<net.minecraft.resources.Identifier>
    quest()
    Returns the value of the quest record component.
    Optional<String>
    reward()
    Returns the value of the reward record component.
    String
    searchText()
    Words of the page a search should find it by.
    static void
    stepped(FoliosPainter painter, int x, int y, int width, float fill, int steps, int color)
    A bar of steps parts, as a category's entries or a quest's objectives, 5 pixels tall from (x, y) and a pixel of shadow under it, drawn as the mastery bar is: a rim with its corners left out, lit along its top and left and shaded along its foot and right; a groove sunk under it, a faint light along its floor; the fill lit along its top, shaded along its foot and crossed by fine slanting stripes, with a glint at its end.
    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 Object

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

    Methods inherited from interface FoliosPageElement

    items, spread

  • Field Details

    • CODEC

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

  • Constructor Details

    • QuestPageElement

      public QuestPageElement(List<FoliosObjective> objectives, Optional<String> title, String text, Optional<String> reward, boolean inOrder, Optional<net.minecraft.resources.Identifier> quest, Optional<String> locked)
      Creates an instance of a QuestPageElement record class.
      Parameters:
      objectives - the value for the objectives record component
      title - the value for the title record component
      text - the value for the text record component
      reward - the value for the reward record component
      inOrder - the value for the inOrder record component
      quest - the value for the quest record component
      locked - the value for the locked record component

  • Method Details

    • objectives

      public List<FoliosObjective> objectives()
      Returns the value of the objectives record component.
      Specified by:
      objectives in interface FoliosPageElement
      Returns:
      the value of the objectives record component

    • 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

    • gilded

      public static void gilded(FoliosPainter painter, int x, int y, int width, float fill)
      The mastery bar, 7 pixels tall from (x, y), kin to the build guide's but its own: a soft shadow under it and to its right; a gilt rim, lighter along its top and darker along its foot, its corners rounded off and nothing standing past it; a dark groove with a faint light line along its floor; the filled length in the book's colour (green once full), lit along its top, shaded along its foot and banded with fine slanting stripes, a glint at its end; and quarters marked by gilt dividers inside the groove.

    • stepped

      public static void stepped(FoliosPainter painter, int x, int y, int width, float fill, int steps, int color)
      A bar of steps parts, as a category's entries or a quest's objectives, 5 pixels tall from (x, y) and a pixel of shadow under it, drawn as the mastery bar is: a rim with its corners left out, lit along its top and left and shaded along its foot and right; a groove sunk under it, a faint light along its floor; the fill lit along its top, shaded along its foot and crossed by fine slanting stripes, with a glint at its end. Where parts meet, small ticks in the rim. Once full it shows color with a light sweeping across it now and then.

    • bar

      public static void bar(FoliosPainter painter, int x, int y, int width, int height, float fill, int color)
      A bar of a given fill (0 to 1) in a colour, drawn as pixel art. Four or more pixels tall: framed as the mastery bar is (a shadow, a rim lit above and shaded below, a sunk track), the fill striped, lit along its top and shaded along its foot, with a bright cap at its leading edge. Thinner: a slim rounded groove with its fill in it (slim()).

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

    • reward

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

    • inOrder

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

    • quest

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

    • locked

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