bevy_gearbox 0.3.0

State machine system for the bevy game engine
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

use bevy::{prelude::*, reflect::Reflect, platform::collections::HashSet};

/// A component that enables history behavior for a state.
/// When a state with this component is exited and later re-entered,
/// it will restore previously active substates instead of using InitialState.
/// Defines the type of history behavior for a state.
#[derive(Component, Reflect, Debug, Clone, Copy, PartialEq, Eq, Default)]
#[reflect(Component)]
pub enum History {
    /// Remember only the direct child state that was active when last exited.
    /// On re-entry, restore that direct child and follow normal InitialState logic from there.
    #[default]
    Shallow,
    /// Remember the entire hierarchy of substates that were active when last exited.
    /// On re-entry, restore the exact nested hierarchy that was previously active.
    Deep,
}

/// A component that stores the previously active states for history restoration.
/// This is automatically managed by the history systems.
#[derive(Component, Reflect, Default)]
#[reflect(Component)]
pub struct HistoryState(pub HashSet<Entity>);