Struct tuig::Runner

pub struct Runner<G: Game + 'static> { /* private fields */ }

Handles starting up and running a Game and all its agents.

Implementations

impl<G: Game + 'static> Runner<G>

pub fn new(game: G) -> Self

Prepare a game to be run.

pub fn spawn(self, agent: impl Agent<G::Message> + 'static) -> Self

Set an agent to be running at game startup, to process the first round of messages.

pub fn queue(self, msg: G::Message) -> Self

Add a message to be handled in the first round, by the first crop of Self::spawned agents.

pub fn input_tick(self, tick: f32) -> Self

Set the desired time between rounds of messages.

If processing a round takes longer than this, the game is considered to be “lagging”. If it takes less time, then the runner will sit around, just processing input until the round is done.

The exact mechanics of round timing in laggy games is deliberately left unspecified so I can fiddle with it to make it “work nicer”. Broadly, though: If it lags a little and sporadically, the rounds tick over immediately until it “catches up” to approximately match realtime. If it properly lags out, getting too far behind, then the timer resets and starts ticking relative to the end of the lag.

pub fn run(self, iosys: impl IoSystem + 'static, iorun: impl IoRunner) -> G

Start the game running, according to the feature-selected runner.

This function only exits when Game::message or Game::attach returns [Response::Quit]. It returns the Game, primarily for testing purposes.

pub fn load_run(self) -> G

Use crate::io::load! to intelligently pick an iosystem, load it, and Self::run.

This must be run on the main thread. Ideally, you’d run it from main directly.

This function only exits when Game::message or Game::attach returns [Response::Quit]. It returns the Game, primarily for testing purposes. If loading fails, it panics.