bevy_intro_screen 0.1.2

Highly customizable introductio n(splash) screen library for Bevy games
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

use std::time::Duration;

use bevy::{prelude::*, state::state::FreelyMutableState};

use crate::splash_screen::{ShowIntroScreen, IntroPreferences, IntroState};

use super::{FixedDuration, IntroDuration};

/// Represents the possible states of a dynamic duration.
#[derive(States, Clone, PartialEq, Eq, Hash, Debug, Default)]

pub enum DynamicDurationState {
    /// Indicates a failure during the dynamic duration calculation.
    Failure,
    /// Indicates that the dynamic duration has completed.
    Completed,
    /// Indicates that the dynamic duration is currently running.
    #[default]
    Running,
}

/// Represents a generic dynamic duration with a maximum duration.
///
/// Provides a basic implementation for dynamic durations by initializing the state and starting a maximum duration countdown.
/// Applications should implement logic to transition from `Running` to either `Failure` or `Completed` based on specific conditions.

#[derive(Clone, Debug, Resource)]
pub struct GenericDynamicDuration {
    /// Maximum allowed duration for the dynamic process.
    max_duration: FixedDuration<DynamicDurationState>,
}

impl GenericDynamicDuration {
    /// Creates a new `GenericDynamicDuration` instance with the specified maximum duration.
    ///
    /// # Arguments
    /// * `max_duration`: The maximum allowed duration. Can be any type that can be converted into a `Duration`.
    ///
    /// # Returns
    /// A new `GenericDynamicDuration` instance.
    pub fn new(max_duration: impl Into<Duration>) -> Self {
        let max_duration =
            FixedDuration::new_with_duration(max_duration.into(), DynamicDurationState::Failure);

        Self { max_duration }
    }
}

impl AsRef<FixedDuration<DynamicDurationState>> for GenericDynamicDuration {
    fn as_ref(&self) -> &FixedDuration<DynamicDurationState> {
        &self.max_duration
    }
}

impl IntroDuration for GenericDynamicDuration {
    fn configure_duration<S, D, U>(&self, app: &mut App, preferences: &IntroPreferences<S, D, U>)
    where
        S: States + FreelyMutableState,
        D: IntroDuration,
        U: ShowIntroScreen,
    {
        app.init_state::<DynamicDurationState>();
        app.insert_resource(self.clone());

        app.add_systems(
            Update,
            Self::only_run_if(
                finish_splash::<S, D, U>.run_if(in_state(DynamicDurationState::Completed)),
            ),
        );

        app.add_systems(
            Update,
            Self::only_run_if(change_to_failure.run_if(in_state(DynamicDurationState::Failure))),
        );

        self.max_duration.configure_duration(app, preferences);
    }
}

fn finish_splash<S, D, U>(
    mut next_state: ResMut<NextState<S>>,
    preferences: Res<IntroPreferences<S, D, U>>,
) where
    S: bevy::prelude::States + FreelyMutableState + Clone,
    D: IntroDuration,
    U: ShowIntroScreen,
{
    next_state.set(preferences.transition_to.clone())
}

fn change_to_failure(mut next_state: ResMut<NextState<IntroState>>) {
    next_state.set(IntroState::Failure)
}