Struct iyes_progress::ProgressPlugin

pub struct ProgressPlugin<S: StateData> {
    pub state: S,
    pub next_state: Option<S>,
    pub track_assets: bool,
}

Add this plugin to your app, to use this crate for the specified state.

If you have multiple different states that need progress tracking, you can add the plugin for each one.

If you want the optional assets tracking (“assets” cargo feature), enable it with .track_assets().

Warning: Progress tracking will only work in some stages!

If not using iyes_loopless, it is only allowed in CoreStage::Update.

If using iyes_loopless, it is allowed in all stages after the StateTransitionStage responsible for your state type, up to and including CoreStage::Last.

You must ensure to not add any progress-tracked systems to any other stages!

app.add_plugin(ProgressPlugin::new(MyState::GameLoading).continue_to(MyState::InGame));
app.add_plugin(ProgressPlugin::new(MyState::Splash).continue_to(MyState::MainMenu));

Fields

state: S

The loading state during which progress will be tracked

next_state: Option<S>

The next state to transition to, when all progress completes

track_assets: bool

Whether to enable the optional assets tracking feature

Implementations

impl<S: StateData> ProgressPlugin<S>

pub fn new(state: S) -> Self

Create a ProgressPlugin running during the given State

pub fn continue_to(self, next_state: S) -> Self

Configure the ProgressPlugin to move on to the given state as soon as all Progress in the loading state is completed.

Trait Implementations

impl<S: StateData> Plugin for ProgressPlugin<S>

fn build(&self, app: &mut App)

Configures the App to which this plugin is added.

fn name(&self) -> &str

Configures a name for the Plugin which is primarily used for debugging.

fn is_unique(&self) -> bool

If the plugin can be meaningfully instantiated several times in an App, override this method to return false.