Struct bevy_backroll::BackrollStage

pub struct BackrollStage<Input> where
    Input: PartialEq + Pod + Zeroable + Send + Sync,  { /* private fields */ }

A Stage that transparently runs and handles Backroll sessions.

Each time the stage runs, it will poll the Backroll session, sample local player inputs for the session, then advance the frame.

The stage will automatically handle Backroll commands by doing the following:

• Command::Save: Saves an immutable copy of the components and resoures from the main app World into a save state.
• Command::Load: Loads a prior saved World state into the main app World.
• Command::AdvanceFrame: Injects the provided GameInput as a resource then runs all simulation based systems once (see: add_rollback_system)
• Command::Event: Forwards all events to Bevy. Can be read out via EventReader. Automatically handles time synchronization by smoothly injecting stall frames when ahead of remote players.

This stage is best used with a FixedTimestep run criteria to ensure that the systems are running at a consistent rate on all players in the game.

This stage will only run when there is a P2PSession with the same Config parameter registered as a resource within the running World. If the stage was added via BackrollPlugin, BackrollCommands::start_backroll_session and BackrollCommands::end_backroll_session can be used to start or end a session.

Trait Implementations

impl<Input> Stage for BackrollStage<Input> where
    Input: PartialEq + Pod + Zeroable + Send + Sync, 

fn run(&mut self, world: &mut World)

Runs the stage; this happens once per update. Implementors must initialize all of their state and systems before running the first time.