Struct iyes_progress::ProgressCounter

pub struct ProgressCounter { /* private fields */ }

Resource for tracking overall progress

This resource is automatically created when entering a state that was configured using ProgressPlugin, and removed when exiting it.

Implementations

impl ProgressCounter

pub fn progress(&self) -> Progress

Get the latest overall progress information

This is the combined total of all systems.

To get correct information, make sure that you call this function only after all your systems that track progress finished.

This does not include “hidden” progress. To get the full “real” total, use progress_complete.

Use this method for progress bars and other things that indicate/report progress information to the user.

pub fn progress_complete(&self) -> Progress

Get the latest overall progress information

This is the combined total of all systems.

To get correct information, make sure that you call this function only after all your systems that track progress finished

This includes “hidden” progress. To get only the “visible” progress, use progress.

This is the method to be used for things like state transitions, and other use cases that must account for the “true” actual progress of the registered systems.

pub fn manually_track(&self, progress: Progress)

Add some amount of progress to the running total for the current frame.

In most cases you do not want to call this function yourself. Let your systems return a Progress and wrap them in [track] instead.

pub fn manually_track_hidden(&self, progress: HiddenProgress)

Add some amount of “hidden” progress to the running total for the current frame.

Hidden progress counts towards the true total (like for triggering the state transition) as reported by the progress_complete method, but is not counted by the progress method. The intention is that it should not affect things like progress bars and other user-facing indicators.

In most cases you do not want to call this function yourself. Let your systems return a Progress and wrap them in [track] instead.

pub fn persist_progress(&mut self, progress: Progress)

Persist progress for the rest of the current state

pub fn persist_progress_hidden(&mut self, progress: HiddenProgress)

Persist hidden progress for the rest of the current state

Trait Implementations

impl Default for ProgressCounter

fn default() -> ProgressCounter

Returns the “default value” for a type.

impl Resource for ProgressCounterwhere
    Self: Send + Sync + 'static,