Struct Book 

pub struct Book {

    pub id: String,
    pub name: String,
    pub subtitle: Option<String>,
    pub version: u32,
    pub landing_text: String,
    pub nameplate_color: String,
    pub accent: String,
    pub book_texture: String,
    pub categories: Vec<BookCategory>,
    pub entries: Vec<BookEntry>,
    pub i18n: bool,
    pub layouts: Vec<RecipeLayout>,
    pub page_types: Vec<PageType>,
}

A guide book: what a .ybook file holds.

Fields

id: String

The item that opens it (the mod’s namespace if it has none).

name: String

subtitle: Option<String>

The nameplate’s second line when version is 0.

version: u32

The book’s edition: its nameplate says “1st Edition”, “2nd Edition”… (0: the subtitle instead).

landing_text: String

nameplate_color: String

The nameplate’s text color (rrggbb).

accent: String

The color {accent|terms} are shown in (#rrggbb).

book_texture: String

Its sheet: ns:textures/x.png, or Yog’s (yog_book::BOOK_PNG shows its layout).

categories: Vec<BookCategory>

entries: Vec<BookEntry>

i18n: bool

Its texts are translation keys, shown in the game’s language (the build turns it on when a text is a .yres text or a name).

layouts: Vec<RecipeLayout>

Recipe layouts of its own; the build adds the mod’s (.ydef recipe kinds and layouts).

page_types: Vec<PageType>

The mods’ own kinds of page its pages use; the build adds them (.yui components with book_page).

Implementations

impl Book

pub fn read( text: &str, resolver: &mut dyn Resolve, ) -> Result<Read<Book>, Errors>

Reads a .ybook (text), references and texts going through resolver: the book as the game shows it, and what it references.

impl Book

pub fn localized(&self, tr: impl Fn(&str) -> String) -> Book

This book with its texts run through tr — names, descriptions, landing text and every page’s title/text. With Book::i18n on, the texts are translation keys and the renderer shows localized(<current language>) (see yog_book::BookRenderer::set_translator).

Trait Implementations

impl Clone for Book

fn clone(&self) -> Book

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Book

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for Book

fn default() -> Book

Returns the “default value” for a type.

impl Fields for Book

const FIELDS: &'static [(&'static str, &'static str)]

impl Schema for Book

fn encode(&self, __yog_w: &mut Writer)

Writes itself in the binary form, straight — Schema::write’s value encoded, unless the type knows better (derived ones do).

fn decode(__yog_d: &mut Decoder<'_>) -> Option<Book>

Reads itself from the binary form, straight; None when it isn’t what Schema::encode writes — then read_bytes reads the slow way, which says what’s wrong. Through a value unless the type knows better (derived ones do).

fn pack(&self, __yog_p: &mut Packer)

Packs itself into a frame (crate::frame): its binary form as bytes, unless the type packs itself (derived ones and plain types do).

fn unpack(__yog_u: &mut Unpacker<'_>) -> Option<Book>

Reads itself out of a frame; None if the bytes aren’t what Schema::pack writes.

fn shape() -> Shape

What the format looks like.

fn read(v: &ValueRef<'_>, cx: &mut Reader<'_>) -> Option<Book>

Reads v. Problems go to cx at its current path; None when the value couldn’t be read (the problem is in cx).

fn write(&self) -> Value

The value, as the format writes it.

fn absent() -> Option<Self>

The value of a field that isn’t there — None: the field is required.

fn skip(&self) -> bool

Whether a struct leaves this field out when writing it.

fn pack_list(items: &[Self], p: &mut Packer)

A list of these packed: a count, then each one (floats raw).

fn unpack_list(u: &mut Unpacker<'_>) -> Option<Vec<Self>>

A list of these out of a frame.

fn encode_list(items: &[Self], w: &mut Writer)

A list of these written straight (numbers pack theirs).

fn decode_list(d: &mut Decoder<'_>) -> Option<Vec<Self>>

A list of these read straight.