Struct Engine 

pub struct Engine { /* private fields */ }

Configures and starts the game.

use audio_code::prelude::*;

struct Hello;

impl Scene for Hello {
    fn start(&mut self, ctx: &mut Context) {
        ctx.speech.speak("Hello! Press space to beep, escape to quit.");
    }

    fn update(&mut self, ctx: &mut Context) {
        if ctx.input.pressed(Key::Space) {
            ctx.audio.play_tone(440.0, 0.2);
        }
        if ctx.input.pressed(Key::Escape) {
            ctx.quit();
        }
    }
}

fn main() -> audio_code::Result<()> {
    Engine::new("Hello").run(Hello)
}

Implementations

impl Engine

pub fn new(title: impl Into<String>) -> Self

Creates a new engine configuration. The title is used for the window and is what the screen reader announces when the window gets focus.

Examples found in repository

examples/driving.rs (line 149)

fn main() -> audio_code::Result<()> {
    Engine::new("Driving").run_with(Town::new)
}

examples/menus.rs (line 91)

fn main() -> audio_code::Result<()> {
    Engine::new("Menu demo").echo_speech(true).run(MainMenu)
}

examples/hello.rs (line 30)

fn main() -> audio_code::Result<()> {
    Engine::new("Hello audio-code").echo_speech(true).run(Hello)
}

examples/beacon.rs (line 158)

fn main() -> audio_code::Result<()> {
    Engine::new("Beacon").echo_speech(true).run_with(Maze::new)
}

examples/flight.rs (line 147)

fn main() -> audio_code::Result<()> {
    Engine::new("Flight").echo_speech(true).run_with(Flight::new)
}

examples/platformer.rs (line 109)

fn main() -> audio_code::Result<()> {
    Engine::new("Platformer").gravity(EARTH_GRAVITY * 2.0).echo_speech(true).run_with(Platformer::new)
}

Additional examples can be found in:

• examples/bell_catcher.rs

pub fn fps(self, fps: u32) -> Self

Target frames per second (default 60).

pub fn physics_rate(self, rate: u32) -> Self

Physics and Scene::fixed_update steps per second (default 60).

pub fn gravity(self, gravity: Vec3) -> Self

Gravity of the physics world, e.g. EARTH_GRAVITY. Default is none (top down games). Can be changed later with ctx.physics.set_gravity.

Examples found in repository

examples/platformer.rs (line 109)

fn main() -> audio_code::Result<()> {
    Engine::new("Platformer").gravity(EARTH_GRAVITY * 2.0).echo_speech(true).run_with(Platformer::new)
}

pub fn save_file(self, path: impl Into<PathBuf>) -> Self

File used by Context::storage (default <title>.save in the working directory).

pub fn encrypt_save(self, secret: impl Into<String>) -> Self

Encrypts the save file of Context::storage with a key made from secret (optional, default off). Players can no longer read or edit it, and a changed or damaged file is detected and kept as <file>.broken. An existing plain text save is converted on the next save. See crate::storage for what this protects against.

pub fn sound_dir(self, dir: impl Into<PathBuf>) -> Self

Folder searched for sounds (default "sounds"). See crate::audio.

pub fn lang_dir(self, dir: impl Into<PathBuf>) -> Self

Folder with the translation files <code>.txt (default "lang"). See crate::lang.

pub fn language(self, code: impl Into<String>) -> Self

The language the game starts in, e.g. "de" (default: the system language if the game has texts for it, else English). A language the player chose with Context::set_language still wins.

pub fn echo_speech(self, echo: bool) -> Self

Print everything spoken to the console as well (default false).

Examples found in repository

examples/menus.rs (line 91)

fn main() -> audio_code::Result<()> {
    Engine::new("Menu demo").echo_speech(true).run(MainMenu)
}

examples/hello.rs (line 30)

fn main() -> audio_code::Result<()> {
    Engine::new("Hello audio-code").echo_speech(true).run(Hello)
}

examples/beacon.rs (line 158)

fn main() -> audio_code::Result<()> {
    Engine::new("Beacon").echo_speech(true).run_with(Maze::new)
}

examples/flight.rs (line 147)

fn main() -> audio_code::Result<()> {
    Engine::new("Flight").echo_speech(true).run_with(Flight::new)
}

examples/platformer.rs (line 109)

fn main() -> audio_code::Result<()> {
    Engine::new("Platformer").gravity(EARTH_GRAVITY * 2.0).echo_speech(true).run_with(Platformer::new)
}

pub fn window_size(self, width: u32, height: u32) -> Self

Window size in pixels (default 640×480). The window shows nothing, but sighted helpers can still find and focus it.

pub fn headless(self) -> Self

Use no audio device and print speech to the console instead of using prism. Meant for automated tests and tools.

pub fn run(self, scene: impl Scene) -> Result<()>

Opens the window and runs the game until it quits.

Examples found in repository

examples/menus.rs (line 91)

fn main() -> audio_code::Result<()> {
    Engine::new("Menu demo").echo_speech(true).run(MainMenu)
}

examples/hello.rs (line 30)

fn main() -> audio_code::Result<()> {
    Engine::new("Hello audio-code").echo_speech(true).run(Hello)
}

pub fn run_with<S: Scene>( self, build: impl FnOnce(&mut Context) -> S + 'static, ) -> Result<()>

Like Engine::run, but builds the first scene with access to the Context. Handy when the scene needs to create bodies or load sounds in its constructor:

struct Level { player: BodyId }

impl Level {
    fn new(ctx: &mut Context) -> Self {
        Self { player: ctx.physics.add(Body::kinematic(Vec3::ZERO)) }
    }
}

fn main() -> audio_code::Result<()> {
    Engine::new("Game").run_with(Level::new)
}

Examples found in repository

examples/driving.rs (line 149)

fn main() -> audio_code::Result<()> {
    Engine::new("Driving").run_with(Town::new)
}

examples/beacon.rs (line 158)

fn main() -> audio_code::Result<()> {
    Engine::new("Beacon").echo_speech(true).run_with(Maze::new)
}

examples/flight.rs (line 147)

fn main() -> audio_code::Result<()> {
    Engine::new("Flight").echo_speech(true).run_with(Flight::new)
}

examples/platformer.rs (line 109)

fn main() -> audio_code::Result<()> {
    Engine::new("Platformer").gravity(EARTH_GRAVITY * 2.0).echo_speech(true).run_with(Platformer::new)
}

examples/bell_catcher.rs (lines 23-42)

fn main() -> audio_code::Result<()> {
    Engine::new("Bell Catcher").run_with(|ctx| {
        ctx.audio.register("bell", Synth::sine(1568.0).with(Synth::sine(3136.0).volume(0.3)).length(0.35).decay(9.0).volume(0.6));
        ctx.audio.register("step", Synth::noise().length(0.05).decay(80.0).volume(0.5));
        ctx.audio.register("edge", Synth::sine(110.0).length(0.12).decay(30.0).volume(0.8));
        ctx.audio.register(
            "catch",
            Synth::sine(784.0).length(0.08).then(Synth::sine(1047.0).length(0.08)).then(Synth::sine(1568.0).length(0.2).decay(12.0)).volume(0.4),
        );
        ctx.audio.register("miss", Synth::saw(220.0).sweep_to(80.0).length(0.5).decay(5.0).volume(0.35));

        // Restore the speech settings from the last session.
        if let Some(voice) = ctx.storage.get::<String>("voice") {
            ctx.speech.set_voice(voice);
        }
        let rate: f32 = ctx.storage.get_or("rate", 50.0);
        if rate != 50.0 {
            ctx.speech.set_rate(rate / 100.0);
        }
        Title
    })
}

pub fn run_fn(self, update: impl FnMut(&mut Context) + 'static) -> Result<()>

Runs a game written as a single closure that is called every frame. The closure can keep its own state in captured variables. See crate::run.

pub fn build_fn(self, update: impl FnMut(&mut Context) + 'static) -> Runner

Like Engine::build for a closure game.

pub fn build(self, scene: impl Scene) -> Runner

Creates the Context and runner without a window. Window backends use this; you can use it for tests or to drive the engine from your own loop.

Trait Implementations

impl Clone for Engine

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Engine

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

Formats the value using the given formatter.