All Classes and Interfaces
Class
Description
Where something sits across a page: an element's text and what it shows, as
"alignment" and
"title_alignment" in JSON ("left", "center", "right" or "justify").A guide book, as read from
assets/<namespace>/folios/<path>/book.json and the categories and entries beside
it.How the front of the book lists its categories:
"categories" in book.json.A book's colour scheme:
"colors" in book.json, each colour "#RRGGBB" (or "#AARRGGBB").Where a book's name and subtitle are lettered on its cover, on the book item and a handheld book alike:
"cover_text" in book.json.A line of lettering: its middle (x, y), how large, and how much room it has across.
What a reader can do while holding a handheld book open:
"handheld" in book.json.Where the things around a page's content sit, in page pixels, in both styles:
"layout" in book.json.A place in a book: an entry, a page of it (0 for its first), and an element of that page (0 for its first; -1 for
the page as a whole).
The models a book is shown with:
"models" in book.json.How a handheld book's leaves turn (
"page_turn" in book.json).Where what is read in a book is kept (
"progress" in book.json): the entries read, the pages shown, the
bookmarks and where the reader left off.The texture layers a book is drawn with, in both styles:
"textures" in book.json, each a texture path.An item that opens a guide book when used.
Guide books from either side: the item that carries one, and opening one for a player from the server.
A category of a book's entries.
An entry of a book: a titled run of pages, in a category.
A page of the entry, or an element of one, written with
"index": listed in the book's index and found by
its search as an entry is, under a name and an icon of its own, and opening the entry at it.A page of the entry, with what applies to it whatever its kind.
The JSON formats books are written in.
Guide books on the client: the books loaded from resource packs, and opening them.
A book's, category's or entry's 16-pixel icon: items (
FoliosStack, e.g.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).
What a page asked
FoliosLayout.flow(java.lang.String, int, java.lang.String, net.ixdarklord.folios.api.client.page.FoliosPageElement.Part) for: its title, its own part and how tall it is, and its text.A named place on the pages a page lays out: the
pageth of them (from 0), from top down to
bottom on it.Kinds of link a book's text can make:
[label](scheme:target) in any book goes to the kind registered for
scheme, which says what the link shows under the pointer and does when pressed.A link's kind and the part of it after the scheme.
What a kind of link does.
What keeps a category, entry, page or element closed until the player has earned it.
A condition the player makes progress on: an objective of a quest page, shown with a bar, and what a lock
(
"requires", FoliosLock) waits for.Values a mod reports for books to follow: an objective
{"source": "mymod:mana", "goal": 100} is as far along
as the source's value is towards its goal.A value to follow, for the local player.
A page of an entry, as its JSON describes it.
A page ready to draw.
Something drawn on a page from a given height down, such as what comes before a page's text.
A laid page that is half of a spread: the book draws its frame joined with the
other half's over the fold, and one page number for both, at the fold.
The types of element a page shows, by the
"type" their JSON names.What a page draws with.
What a dragged rectangle does as the pointer moves while it is held: by how far, in page pixels.
What a rectangle does when the mouse wheel turns over it: by how many notches, away from the reader positive.
The colours a page is drawn in (ARGB).
A small window a link opens over the book: under the pointer while it is over the link's words, and pinned in place
once they are pressed, until the reader presses elsewhere or Esc.
Quests the server follows: those data packs give (
data/<namespace>/folios/quests/<name>.json), checked by the
server alone and rewarded by it.Told when a player finishes a server quest.
How a page's content shows once the page is turned to: everything drawn on it (text, pictures, items, scenes,
whatever a page type draws) asks the effect how it looks at this point of the reveal, by where it is on the page.
How a thing looks: how much it shows (0 not at all, 1 fully; items and scenes, which can't fade, show once past
a half), how far it is moved from its place in page pixels, a colour it is tinted towards (
tint's alpha
is how far: 0 not at all), and what share of its letters, if it is text, show as runes (0 none, 1 all).A reveal: an effect, how long it takes in seconds, whether it plays only the first time each spread is seen this
game (
once; pages of entries read in an earlier game count as seen), and whether it plays only on spreads
the reader has never been shown in full (unread; kept with the player, or with the copy of a book that
keeps its own, so it doesn't play again after a restart or on another computer).The reveal effects books can use (
FoliosReveal), by id.Live lists a book's pages can show: a page element with
"observe": {"source": "mymod:spells", "row": "..."}
writes a line for each row of the source, and is written again whenever the list changes, so content added by addons
or data packs shows in the book without anyone editing it.A row of a source: its id, and its fields by name.
Items as a page names them, worked out only when they're first drawn (item components need the world's registries,
which a book loaded with resources doesn't have yet).
The ways a book can be shown, named by its
book.json's "style".Shows a book.
Text written for a book, set out in lines to a width.
What a line is part of, which decides how it is drawn.
One line, at (x, y) from the text's top left.