Record Class GuideCategory

java.lang.Object
java.lang.Record
net.ixdarklord.folios.api.client.GuideCategory
Record Components:
name - raw, as written (title() reads it)
description - raw marked-up text shown above its entries; empty for none
sort - lower comes first, then by name
color - its tab's colour (RGB, "color" in its JSON); -1 for the book's own
public record GuideCategory(String id, String name, String description, GuideIcon icon, int sort, GuideLock lock, int color) extends Record
A category of a book's entries. Read from categories/<id>.json in the book's folder.

  • Constructor Details

    • GuideCategory

      public GuideCategory(String id, String name, String description, GuideIcon icon, int sort, GuideLock lock, int color)
      Creates an instance of a GuideCategory record class.
      Parameters:
      id - the value for the id record component
      name - the value for the name record component
      description - the value for the description record component
      icon - the value for the icon record component
      sort - the value for the sort record component
      lock - the value for the lock record component
      color - the value for the color record component

  • Method Details

    • title

      public net.minecraft.network.chat.Component title()

    • isOpen

      public boolean isOpen()

    • isVisible

      public boolean isVisible()

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

    • id

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

    • name

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

    • description

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

    • icon

      public GuideIcon icon()
      Returns the value of the icon record component.
      Returns:
      the value of the icon record component

    • sort

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

    • lock

      public GuideLock lock()
      Returns the value of the lock record component.
      Returns:
      the value of the lock record component

    • color

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