Struct Progress

pub struct Progress<T: ?Sized> { /* private fields */ }

Progress state.

Can be inserted as a Resource to track global progress, or as a Component to track progress for a single entity.

Implementations

impl<T: ?Sized> Progress<T>

pub fn new() -> Self

Creates a new Progress tracker.

Examples found in repository

examples/simple.rs (line 12)

fn main() {
    let mut app = App::new();
    app.add_plugins(ScheduleRunnerPlugin::default());
    app.add_plugins(EntityProgressTrackingPlugin::<Loading>::default());
    app.add_systems(Update, tracking_system);
    app.world_mut().spawn(Progress::<Loading>::new());
    app.observe(completion_observer);
    app.run();
}

impl<T: ?Sized> Progress<T>

pub fn track(&mut self, done: u32, total: u32)

Records progress, including its total work and done work.

Examples found in repository

examples/simple.rs (line 21)

fn tracking_system(
    mut tracked: Query<&mut Progress<Loading>>,
) {
    for mut tracker in &mut tracked {
        tracker.track(128, 128);
    }
}

pub fn work(&self) -> (u64, u64)

Returns the work that has been completed and the units of work

pub fn fract(&self) -> f32

Returns the progress as a fraction, from 0.0 (no work done) to 1.0 (all work done).

Trait Implementations

impl<T: ?Sized> Component for Progress<T>

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

fn register_component_hooks(_hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its ComponentHooks.

impl<T: ?Sized> Default for Progress<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T: ?Sized> Resource for Progress<T>

where Self: Send + Sync + 'static,