Enum BookPage 

pub enum BookPage {
    Text {
        text: String,
        title: Option<String>,
    },
    Spotlight {
        item: ItemDef,
        title: Option<String>,
        text: Option<String>,
    },
    Crafting {
        recipe_id: String,
        text: Option<String>,
    },
    Smelting {
        recipe_id: String,
        text: Option<String>,
    },
    Image {
        texture: String,
        title: Option<String>,
        text: Option<String>,
        border: bool,
    },
    Entity {
        entity_type: String,
        name: Option<String>,
        text: Option<String>,
    },
    Relations {
        entries: Vec<String>,
        text: Option<String>,
    },
    Empty,
    Pattern {
        op_id: String,
        anchor: String,
        input: String,
        output: String,
        text: String,
    },
    Svg {
        data: String,
        title: Option<String>,
        text: Option<String>,
    },
    CustomText {
        text: String,
        font: BookFont,
        color: u32,
    },
}

A single page variant inside a book entry.

The wire format (mod ↔ runtime JSON boundary, produced by BookPage::to_json) is internally tagged with snake_case names — {"type": "spotlight", "item": "yog:ruby", ...} — like Patchouli’s per-page “type” field. The serde attributes below keep Deserialize in exact agreement with to_json.

Variants

Text

Plain formatted text, optionally with a section title (for non-first pages).

Fields

text: String

title: Option<String>

Spotlight

Display an item outlined (tooltip on hover).

Fields

item: ItemDef

On the wire this is the item id string (“yog:ruby”); rich ItemDef maps are accepted too.

title: Option<String>

text: Option<String>

Crafting

Crafting recipe display (autorenders 3×3 grid).

Fields

recipe_id: String

text: Option<String>

Smelting

Smelting recipe display.

Fields

recipe_id: String

text: Option<String>

Image

Image overlay page.

Fields

texture: String

title: Option<String>

text: Option<String>

border: bool

Entity

Entity display page (renders a living entity in a box).

Fields

entity_type: String

name: Option<String>

text: Option<String>

Relations

Link to another entry (like Patchouli’s relations).

Fields

entries: Vec<String>

text: Option<String>

Empty

Empty separator.

Pattern

Custom pattern page for Hexcasting-style mods (like hexcasting:pattern).

Fields

op_id: String

anchor: String

input: String

output: String

text: String

Svg

SVG image page — rasterized at render time via resvg.

Fields

data: String

Raw SVG source string.

title: Option<String>

text: Option<String>

CustomText

Text rendered with a custom TTF/OTF font.

Fields

text: String

font: BookFont

Flattened on the wire: "font_id": …, "size_px": ….

color: u32

ARGB color (0xAARRGGBB).

Implementations

impl BookPage

pub fn to_json(&self) -> String

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<'de> Deserialize<'de> for BookPage

fn deserialize<__D>( __deserializer: __D, ) -> Result<BookPage, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for BookPage

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.