q_screens 0.1.0

Screens extension for bevy
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

pub use crate::prelude::*;

/// An empty settings parameter.
#[derive(Resource, Default)]
pub struct NoSettings;

/// How should the screen load its assets?
/// If `LoadingStrategy` is Blocking, the screen's systems will not run until
/// loading is complete. If it is Nonblocking, the screen's systems will run
/// regardless of asset completion status.
#[derive(Default, Copy, Clone, Debug, PartialEq, Eq, Reflect)]
pub enum LoadStrategy {
    /// Block the screen running its [Update] schedules until loading is finished.
    #[default]
    Blocking,
    /// Do not block the screen running its [Update] schedules until loading is finished.
    Nonblocking,
}

/// Implementation trait for Screen components.
pub trait Screen: Component + Reflect + Default + Sized + Send + Sync + 'static {
    /// The screen's public name. Used for serialization. Defaults to the short type path.
    fn name() -> String {
        let default = Self::default();
        Reflect::as_reflect(&default)
            .reflect_short_type_path()
            .to_owned()
    }

    /// Get the builder for this screen. Used to scope systems.
    /// Don't forget to register your screen! [App::register_screen]
    fn builder(builder: ScreenScopeBuilder<Self>) -> ScreenScopeBuilder<Self>;
}