Package net.ixdarklord.folios.api.client

Class GuideStyles

java.lang.Object
net.ixdarklord.folios.api.client.GuideStyles
public final class GuideStyles extends Object
The ways a book can be shown, named by its book.json's "style". Two are built in, and any page shows in either:
  • SCREEN ("screen", the default): a screen with the book's categories down the side, search, bookmarks, and an entry's pages two at a time.
  • HANDHELD ("handheld"): the book itself, held open in the player's hands in the world, its leaves turned by hand; the pointer is free to press what is on its pages.
A mod can add its own: GuideStyles.register(MyMod.id("scroll"), (book, at, hand) -> ...).

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static interface 
    GuideStyles.Style
    Shows a book.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final net.minecraft.resources.ResourceLocation
    HANDHELD
     
    static final net.minecraft.resources.ResourceLocation
    SCREEN
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static @Nullable GuideStyles.Style
    get(net.minecraft.resources.ResourceLocation id)
     
    static net.minecraft.resources.ResourceLocation
    id(String written)
    A style as written in a book: a bare name is CoolCatLib's.
    static void
    register(net.minecraft.resources.ResourceLocation id, GuideStyles.Style style)
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • SCREEN

      public static final net.minecraft.resources.ResourceLocation SCREEN

    • HANDHELD

      public static final net.minecraft.resources.ResourceLocation HANDHELD

  • Method Details

    • register

      public static void register(net.minecraft.resources.ResourceLocation id, GuideStyles.Style style)

    • get

      @Nullable public static @Nullable GuideStyles.Style get(net.minecraft.resources.ResourceLocation id)

    • id

      public static net.minecraft.resources.ResourceLocation id(String written)
      A style as written in a book: a bare name is CoolCatLib's.