Package net.ixdarklord.folios.api.client

Record Class GuideBook.Textures

java.lang.Object
java.lang.Record
net.ixdarklord.folios.api.client.GuideBook.Textures
Record Components:
page - the paper of each page, stretched to it (136 by 180)
frame - drawn over the paper, under what is on the page; its alpha is how strong each part is
cover - the cover around the pages, and a handheld book's boards
tab - a ribbon tab, its tip at the right; stretched to the tab's length, tinted by its category's colour
tabPlate - drawn on a tab under its icon, tinted with the paper's colour, so the icon reads on any ribbon
backdrop - drawn over the whole screen behind a screen book; null for the world, dimmed
Enclosing class:
GuideBook
public static record GuideBook.Textures(net.minecraft.resources.ResourceLocation page, net.minecraft.resources.ResourceLocation frame, net.minecraft.resources.ResourceLocation cover, net.minecraft.resources.ResourceLocation tab, net.minecraft.resources.ResourceLocation tabPlate, @Nullable net.minecraft.resources.ResourceLocation backdrop) extends Record
The texture layers a book is drawn with, in both styles: "textures" in book.json, each a texture path. They are grey or white and tinted by the book's colours (paper by the paper's colour in light or dark mode, the cover by "cover", the frame by the page's lines, tabs by their state), so one set suits any book. Folios's own are at folios:textures/book/: a resource pack replacing them changes every book that doesn't name its own.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final GuideBook.Textures
    DEFAULT
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    Textures(net.minecraft.resources.ResourceLocation page, net.minecraft.resources.ResourceLocation frame, net.minecraft.resources.ResourceLocation cover, net.minecraft.resources.ResourceLocation tab, net.minecraft.resources.ResourceLocation tabPlate, @Nullable net.minecraft.resources.ResourceLocation backdrop)
    Creates an instance of a Textures record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable net.minecraft.resources.ResourceLocation
    backdrop()
    Returns the value of the backdrop record component.
    net.minecraft.resources.ResourceLocation
    cover()
    Returns the value of the cover record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    net.minecraft.resources.ResourceLocation
    frame()
    Returns the value of the frame record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    net.minecraft.resources.ResourceLocation
    page()
    Returns the value of the page record component.
    net.minecraft.resources.ResourceLocation
    tab()
    Returns the value of the tab record component.
    net.minecraft.resources.ResourceLocation
    tabPlate()
    Returns the value of the tabPlate 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

  • Field Details

  • Constructor Details

    • Textures

      public Textures(net.minecraft.resources.ResourceLocation page, net.minecraft.resources.ResourceLocation frame, net.minecraft.resources.ResourceLocation cover, net.minecraft.resources.ResourceLocation tab, net.minecraft.resources.ResourceLocation tabPlate, @Nullable @Nullable net.minecraft.resources.ResourceLocation backdrop)
      Creates an instance of a Textures record class.
      Parameters:
      page - the value for the page record component
      frame - the value for the frame record component
      cover - the value for the cover record component
      tab - the value for the tab record component
      tabPlate - the value for the tabPlate record component
      backdrop - the value for the backdrop record component

  • Method Details

    • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • page

      public net.minecraft.resources.ResourceLocation page()
      Returns the value of the page record component.
      Returns:
      the value of the page record component

    • frame

      public net.minecraft.resources.ResourceLocation frame()
      Returns the value of the frame record component.
      Returns:
      the value of the frame record component

    • cover

      public net.minecraft.resources.ResourceLocation cover()
      Returns the value of the cover record component.
      Returns:
      the value of the cover record component

    • tab

      public net.minecraft.resources.ResourceLocation tab()
      Returns the value of the tab record component.
      Returns:
      the value of the tab record component

    • tabPlate

      public net.minecraft.resources.ResourceLocation tabPlate()
      Returns the value of the tabPlate record component.
      Returns:
      the value of the tabPlate record component

    • backdrop

      @Nullable public @Nullable net.minecraft.resources.ResourceLocation backdrop()
      Returns the value of the backdrop record component.
      Returns:
      the value of the backdrop record component