Class GuideLayout

java.lang.Object
net.ixdarklord.folios.api.client.page.GuideLayout
public final class GuideLayout extends Object
Where pages are laid out: the page's size and margins, the font, and helpers for the parts most pages have (a title, and text that continues onto further pages).

Every page is 136 by 180 pixels, in both kinds of book; content sits between the margins, from CONTENT_LEFT to CONTENT_RIGHT and CONTENT_TOP to CONTENT_BOTTOM.

  • Field Details

    • PAGE_WIDTH

      public static final int PAGE_WIDTH
      See Also:

    • PAGE_HEIGHT

      public static final int PAGE_HEIGHT
      See Also:

    • MARGIN

      public static final int MARGIN
      See Also:

    • CONTENT_LEFT

      public static final int CONTENT_LEFT
      See Also:

    • CONTENT_RIGHT

      public static final int CONTENT_RIGHT
      See Also:

    • CONTENT_WIDTH

      public static final int CONTENT_WIDTH
      See Also:

    • CONTENT_TOP

      public static final int CONTENT_TOP
      See Also:

    • CONTENT_BOTTOM

      public static final int CONTENT_BOTTOM
      Under this are the page's number and its turn buttons, with 2 pixels between them and what is on the page.
      See Also:

    • TITLE_HEIGHT

      public static final int TITLE_HEIGHT
      How much room a title takes, its rule under it included.
      See Also:

    • SCENE_DETAIL

      public static final int SCENE_DETAIL
      How many texture pixels a scene has for each page pixel it is shown over: enough for it to stay sharp on a handheld book held close and on large screens.
      See Also:

  • Constructor Details

    • GuideLayout

      public GuideLayout(GuideBook book, net.minecraft.client.gui.Font font)

  • Method Details

    • book

      public GuideBook book()

    • font

      public net.minecraft.client.gui.Font font()

    • text

      public GuideText text(String raw)
      Text set out to the content's width.

    • flow

      public List<GuidePage.Laid> flow(@Nullable String title, int reserved, @Nullable String text, @Nullable GuidePage.Part part)
      A page with an optional title, a part of its own reserved pixels tall under it, and text under that; text that doesn't fit runs on over as many more pages as it needs.
      Parameters:
      part - draws the page's own part, given the height it starts at; null for none

    • capture

      public List<GuideLayout.Flow> capture(GuidePage page)
      Lays a page out only as far as what it asks flow(String, int, String, GuidePage.Part) for, to set it inside another page; empty for a page that lays itself out some other way.

    • titleIcon

      public void titleIcon(GuideIcon icon)
      The icon put before the titles of the pages laid out next (as flow(String, int, String, GuidePage.Part) draws them): their entry's, or a page's own. The book sets it as it lays out each page of an entry; GuideIcon.NONE for none.

    • titleIcon

      public GuideIcon titleIcon()

    • title

      public static void title(GuidePainter painter, net.minecraft.network.chat.Component title, int y)
      A page's title: bold, with a line under it.

    • title

      public static void title(GuidePainter painter, net.minecraft.network.chat.Component title, int y, GuideIcon icon)
      As title(GuidePainter, Component, int), with an icon before it, unless none: three quarters of its size, centred over a mark of the book's colour that heads the line under the title, the title starting where the rest of the line does. Without an icon the line runs unbroken.

    • viewport

      public net.ixdarklord.coolcatcanvas.api.client.viewport.SceneViewport viewport(int width, int height)
      A scene for a page to show (an entity, a structure), drawn to a texture of width by height pixels (its size on the page times SCENE_DETAIL). It belongs to this layout: it is closed when the book is laid out again.

    • close

      public void close()
      Closes the scenes made for this layout.