All Classes and Interfaces
Class
Description
A rectangle that can be pressed, dragged or scrolled over, in page pixels.
Where a book goes when something on a page is pressed.
Where a book model wants its cover lettering, marked in the model itself: an element whose name has
#title
in it is where the book's name goes, one with #subtitle where its subtitle goes, one with #summary
where its summary goes (a book with a summary has its subtitle under its name instead; one without has its subtitle
where the summary would go, if nothing marks a subtitle) (in Blockbench, rename the
cube; a plate, or an invisible box, either works).RULE: a soft rule with a diamond stud at its middle, its line's size its thickness, its width its length.
What is lettered where: the book's name, its subtitle, its summary (up to
lines lines), each its own colour.A marked line: where and how large, and the z of the face it lies on.
What a model marks; either may be null.
A lettering's rows of text and how large:
scale model units to a font pixel, top the first row's y.A band round the spine: from
y0 to y1 up it (0 at the foot, 16 at the head), standing out
off it (in x's units), its face from that part of texture (0 to 1), tinted as a face's "tintindex" says.What a reveal effect draws over a page, faded out towards the page's edges and its fold, so sparks, smoke, light and
runes melt into the paper instead of stopping short at its border.
Each player's own preferences.
A corner of the screen.
Gives the search field the keyboard: the screen's focus and the field's own.
A guide book, as read from
assets/<namespace>/folios/<path>/book.json and the categories and entries beside
it.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, and a page of it (0 for its first).
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, with what applies to it whatever its kind.
A book's, category's or entry's 16-pixel icon: items (
GuideStack, 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
GuideLayout.flow(String, int, String, GuidePage.Part) for: its title, its own part and how tall it is, and its text.What keeps a category, entry or page closed until the player has earned it.
Something the player makes progress on, shown with a bar: an objective of a quest page, and what a quest's entry
shows on its row.
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).
The advancements a player has completed: all of them (
reset), or ones newly completed or revoked.The server opening a book, at an entry or its start.
A client sending what its player has done with a book, to be kept: with the player (
hand -1), or on the
book in that hand, for a book that keeps its own.A client saying its player started or stopped reading the handheld book in a hand (-1 for no hand).
A client saying which spread of the handheld book its player has open, or that none is (
open false);
shut while it is held up shut, about to be opened.How one recipe looks, as the recipe book shows it; empty for a recipe the server doesn't have.
A client asking how recipes look.
The server telling a player which spread someone near them has open in their hands, to read along.
A structure's blocks: its
palette of states, and each block as four numbers in blocks, its x, y and
z and its state's place in the palette.A client asking for structures' blocks.
Leaves in the air: what was open and what is opening (their pages and spreads), and which way they turn.
A place in the book: a part of it ("home", "category:", "entry:", "search:", "bookmarks", "index") and the left page of a spread.
What a reader has done with one book: the entries read, the spreads shown (for reveals that play only on unread
pages), the quests done and what has been celebrated, the bookmarks, and where they left off.
A page of an entry.
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 (
GuideReveal), by id.Guide books on the client: the books loaded from resource packs, and opening them.
An entry's pages, ready to draw: anchors and the pages of its JSON point into them.
Where a link goes.
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).
A structure as the server told of it: its blocks by place, or why there are none.
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.
An entry to link to (its id, with an optional
#anchor), and the words shown for it; empty for its name.One of the books' small pixel-art icons: a white image (its softer pixels part see-through), drawn at its own size,
a pixel to a pixel, tinted with the colour it is drawn in.
The little controls printed on pages: each a pixel icon on a clasp ('X' in its ink, 'o' a softer shade).
A build in the window: a multiblock page's pattern and mapping.
The map: its places, the paths between them (pairs of ids), and a picture under them.
A place on the map: where it is in the window, what it shows, and the entry it opens.
An item handed to the screen, with the colour it was handed with.
A curved page: where a point of it is in the pose's space, and which way its axes point there.