Enum BookPage 

pub enum BookPage {
    Text {
        text: String,
        title: Option<String>,
        font: Option<String>,
        font_size: Option<f32>,
    },
    Spotlight {
        item: String,
        title: Option<String>,
        text: Option<String>,
    },
    Recipe {
        recipe: String,
        text: Option<String>,
    },
    Image {
        texture: String,
        title: Option<String>,
        text: Option<String>,
    },
    Entity {
        entity: String,
        name: Option<String>,
        text: Option<String>,
    },
    Multiblock {
        name: Option<String>,
        pattern: Vec<Vec<String>>,
        mapping: BTreeMap<String, String>,
        text: Option<String>,
    },
    Relations {
        entries: Vec<String>,
        text: Option<String>,
    },
    Drawn {
        drawer: String,
        title: Option<String>,
        height: f32,
        caption: Option<String>,
        text: Option<String>,
        data: Value,
    },
    Empty,
    Custom(CustomPage),
}

One page of an entry: {"type": "spotlight", "item": "@item:minecraft:stick", …}.

Variants

Text

Text (Yog text: {b|…}, {#rrggbb|…}, {link=…|…}), with an optional title; in another font (a resource-pack font id, e.g. a ttf provider) at font_size pixels a line.

Fields

text: String

title: Option<String>

font: Option<String>

A resource-pack font id.

font_size: Option<f32>

Pixels a line.

Spotlight

An item in a frame, its name (or title) and text.

Fields

item: String

title: Option<String>

text: Option<String>

Recipe

A recipe as its station shows it (a crafting grid, a furnace, …).

Fields

recipe: String

text: Option<String>

Image

An image (a Yog image source: a texture, .svg too).

Fields

texture: String

An image source (mymod:textures/gui/x.png, .svg too).

title: Option<String>

text: Option<String>

Entity

A living entity, turning slowly.

Fields

entity: String

name: Option<String>

text: Option<String>

Multiblock

A structure in 3D, turning: pattern is its layers top to bottom, each a list of rows; each character stands for the block mapping gives it (a block state: minecraft:furnace[facing=north]), for air.

Fields

name: Option<String>

pattern: Vec<Vec<String>>

Layers top to bottom, each a list of rows of characters.

mapping: BTreeMap<String, String>

What each character is: a block, with a state if it matters.

text: Option<String>

Relations

Links to other entries.

Fields

entries: Vec<String>

text: Option<String>

Drawn

A picture the mod’s code draws (Registry::on_book_page) — Hex Casting’s patterns, a mod’s diagram: the drawer registered under that id gets data and a box the page’s width and height high, between the title and a caption line, over the text.

Fields

drawer: String

The id the mod’s drawer is registered under (hexcasting:pattern).

title: Option<String>

height: f32

The picture’s height in book pixels (0: none).

caption: Option<String>

A line under the picture.

text: Option<String>

data: Value

Whatever the drawer reads, as is.

Empty

Nothing (to start the next on a new spread).

Custom(CustomPage)

A page of a mod’s own type (type: "hexcasting:pattern"), laid out by the book’s page_type::PageType of it.

Trait Implementations

impl Clone for BookPage

fn clone(&self) -> BookPage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BookPage

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

Formats the value using the given formatter.

impl Schema for BookPage

fn shape() -> Shape

What the format looks like.

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

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 encode(&self, 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(d: &mut Decoder<'_>) -> Option<Self>

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, 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(u: &mut Unpacker<'_>) -> Option<Self>

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

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.