Package net.ixdarklord.folios.api.client
package net.ixdarklord.folios.api.client
-
ClassDescriptionA guide book, as read from
assets/<namespace>/folios/<path>/book.jsonand 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.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.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.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.The ways a book can be shown, named by itsbook.json's"style".Shows a book.