Struct Startup 

pub struct Startup<'a> { /* private fields */ }

The part of InitContext that is typed by no vocabulary of the game’s own, which InitContext::startup returns.

Implementations

impl<'a> Startup<'a>

pub fn saved<K: SaveKey>(&self, key: K) -> K::Value

The value the last run to save key kept, or its fallback where none did, or where what was kept no longer reads as the key’s own value, with a debug log.

Examples found in repository

examples/sprite-adventure.rs (line 1009)

    fn init(ctx: &mut InitContext<'_, Keep>) -> Result<Self, Error> {
        let startup = ctx.startup();
        let gem_taken = startup.saved(Flag::GemTaken);
        let area = if startup.saved(Flag::InCave) {
            Area::Cave
        } else {
            Area::Overworld
        };
        let position = Vec3::new(
            startup.saved(Position::X) as f32,
            0.0,
            startup.saved(Position::Z) as f32,
        );

        Ok(Self {
            area,
            position,
            previous: position,
            facing: Facing::Toward,
            walk_ticks: 0,
            simulated: Duration::ZERO,
            door_opening: gem_taken,
            swing_ticks: if gem_taken { DOOR_SWING_TICKS } else { 0 },
            gem_taken,
            ghost: 0.0,
            reset_requested: false,
        })
    }

pub fn window_size(&self) -> UVec2

The window’s drawing area, in physical pixels; zero while minimized.

pub fn config(&self) -> &Config

The configuration the engine started with.

pub fn font(&self, name: &str) -> Result<FontData, Error>

The font a source loaded under name, to name in an egui::FontDefinitions.

Required if you want the UI to draw in a game’s own font: a source is a .ttf or an .otf Config::with_assets loads, named by its stem. A name no source loaded a font under, or one two sources share, is an error. The ui feature’s own.

Examples found in repository

examples/ui-fonts.rs (line 536)

fn install_family(
    fonts: &mut egui::FontDefinitions,
    startup: &mut Startup,
    family: egui::FontFamily,
    names: &[&str],
) -> Result<(), Error> {
    for &name in names {
        if !fonts.font_data.contains_key(name) {
            fonts
                .font_data
                .insert(name.to_owned(), startup.font(name)?.into());
        }
    }
    let list = fonts.families.entry(family).or_default();
    for &name in names.iter().rev() {
        list.insert(0, name.to_owned());
    }
    Ok(())
}

pub fn set_fonts(&mut self, fonts: FontDefinitions) -> Result<(), Error>

Draws every frame’s UI in fonts, from the first frame on.

Required if you want the UI to draw in a game’s own font. Fails, naming the font, where an entry of font_data does not decode at its own index, and where a family lists a name font_data does not hold. egui’s own fonts stay wherever fonts keeps them, and the last call is what draws. The ui feature’s own.

Examples found in repository

examples/ui-fonts.rs (line 623)

    fn init(ctx: &mut InitContext<'_, Self>) -> Result<Self, Error> {
        let startup = ctx.startup();
        let mut fonts = egui::FontDefinitions::default();
        for (family, names) in [
            (egui::FontFamily::Proportional, &[PROPORTIONAL_FONT][..]),
            (egui::FontFamily::Monospace, &[MONOSPACE_FONT][..]),
            (
                egui::FontFamily::Name(DISPLAY_FAMILY.into()),
                &[DISPLAY_FONT][..],
            ),
            (
                egui::FontFamily::Name(PIXEL_ONLY_FAMILY.into()),
                &[PROPORTIONAL_FONT][..],
            ),
            (
                egui::FontFamily::Name(PROMPT_FAMILY.into()),
                &[PROMPT_FONT, PROPORTIONAL_FONT][..],
            ),
        ] {
            install_family(&mut fonts, startup, family, names)?;
        }
        startup.set_fonts(fonts)?;

        Ok(Self {
            elapsed: Duration::ZERO,
            orbit: Orbit::default(),
            hailed: None,
            dialogue: None,
            sheet_open: false,
        })
    }