bhv 0.4.0

A crate providing means to create and use Behavior Trees
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

/// An enum type representing the outcome of calling [`Bhv::update`].
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum Status {
    /// The behavior is still running.
    Running,
    /// The behavior was completed successfully.
    Success,
    /// The behavior failed to complete.
    Failure,
}

/// A trait used to denote that the implementing type can be used as
/// a behavior tree node.
pub trait Bhv {
    /// The context passed to the node every frame.
    type Context;

    /// Update the state of the behavior tree based on some global context.
    fn update(&mut self, ctx: &mut Self::Context) -> Status;

    /// Reset the node to initial status after completion, if needed.
    /// Defaults to nothing.
    fn reset(&mut self, _status: Status) {}

    /// Update the node until it returns a value different from [`Status::Running`].
    ///
    /// Useful for running a whole tree once built.
    ///
    /// If the node was executed successfully, returns `true`, `false` otherwise.
    fn execute(mut self, ctx: &mut Self::Context) -> bool
    where
        Self: Sized,
    {
        loop {
            match self.update(ctx) {
                Status::Running => continue,
                Status::Success => return true,
                Status::Failure => return false,
            }
        }
    }
}