Struct iyes_progress::ProgressPlugin

source · [−]

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

Expand description

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(LoadingPlugin::new(MyState::GameLoading).continue_to(MyState::InGame));
app.add_plugin(LoadingPlugin::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

source

impl<S: StateData> ProgressPlugin<S>

source

pub fn new(state: S) -> Self

Create a ProgressPlugin running during the given State

source

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

source

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

source

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

Configures the App to which this plugin is added.

source

fn name(&self) -> &str

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

Auto Trait Implementations

impl<S> RefUnwindSafe for ProgressPlugin<S> where
S: RefUnwindSafe,

impl<S> Send for ProgressPlugin<S>

impl<S> Sync for ProgressPlugin<S>

impl<S> Unpin for ProgressPlugin<S> where
S: Unpin,

impl<S> UnwindSafe for ProgressPlugin<S> where
S: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Downcast for T where
T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> DowncastSync for T where
T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more