solstack 0.3.2

Enables management of your app's or game's control flow through a simple state stack machine.
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
34
35
36
37
38
39
40
41
42
43
44

use crate::trans::Trans;

#[allow(clippy::module_name_repetitions)]
pub type BoxState<D> = Box<dyn State<D>>;

/// Describes an application state.
///
/// See the crates docs or the book for more information.
/// ### Generics
/// - D: Data available to all [`State`](crate::state::State)s to perform actions to.
pub trait State<D> {

    /// Called when this [`State`](crate::state::State) first enters the stack.
    fn on_start(&mut self, _data: &mut D) {}

    /// Called when this [`State`](crate::state::State) is popped from the stack.
    fn on_stop(&mut self, _data: &mut D) {}

    /// Called when this [`State`](crate::state::State) loses its topmost position in the stack to
    /// another [`State`](crate::state::State) that has been pushed ontop of it.
    fn on_pause(&mut self, _data: &mut D) {}

    /// Called when this [`State`](crate::state::State) regains the first position in the stack.
    /// Id est, when other [`State`](crate::state::State)s above it are popped.
    fn on_resume(&mut self, _data: &mut D) {}

    /// Represents a single tick/update.
    /// It's called when the [`Stack`](crate::stack::Stack)'s `.tick()` is called.
    /// Your loop logic should call your stack's tick, not this directly.
    fn on_tick(&mut self, _data: &mut D) -> Trans<D> { 

        Trans::None
    }

    /// Represents a single tick/update independent of this [`State`](crate::state::State) 
    /// position in the stack.
    /// It's called when the [`Stack`](crate::stack::Stack)'s `.tick()` is called.
    /// NOTE: `on_shadow_tick` is called BEFORE `on_tick`.
    fn on_shadow_tick(&mut self, _data: &mut D) -> Trans<D> {

        Trans::None
    }
}