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
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

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

/// A component that holds a set of conditions that must be met for a transition to occur.
#[derive(Component, Reflect, Default)]
#[reflect(Component)]
pub struct Guards {
    /// A set of string identifiers for the guards. For a transition to be allowed,
    /// this set must be empty.
    pub guards: HashSet<String>,
}

impl Guards {
    /// Creates a new, empty set of guards.
    pub fn new() -> Self {
        Self {
            guards: HashSet::new(),
        }
    }

    /// Adds a guard to the set. The guard is identified by its name.
    pub fn add_guard(&mut self, guard: impl Guard) {
        self.guards.insert(guard.name());
    }

    /// Removes a guard from the set.
    pub fn remove_guard(&mut self, guard: impl Guard) {
        self.guards.remove(&guard.name());
    }

    /// Checks if the guard conditions are met. Currently, this just checks if the set is empty.
    pub fn check(&self) -> bool {
        self.guards.is_empty()
    }
}

/// A trait for components that act as a guard. Guards are components that can be
/// added or removed from a `Guards` entity to dynamically enable or disable transitions.
pub trait Guard: Component {
    /// Returns the unique string identifier for this guard type.
    fn name(&self) -> String;
}