shrubbery 0.1.1

Composable Berhavior 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
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

//! Null types for making bts that don't do anything for testing purposes

use crate::prelude::*;
use derive_more::From;

/// Null [`ShrubberyBT`] type
pub type NullBT = ShrubberyBT<NullHandler, StandardDecorator>;

/// Null [`BTBuilder`] type
pub type NullBTBuilder = BTBuilder<NullHandler, StandardDecorator>;

#[derive(Default, Debug, Clone)]
pub struct NullHandler;

impl ActionHandler for NullHandler {
    type Bb = Null;

    type Execute = SimpleExecutors;

    type Condition = SimpleConditionals;
}

/// Useless [`Blackboard`]
#[derive(Default, Clone, Copy, Debug)]
pub struct Null;

/// Either [`FailConditional`] or [`PassConditional`]
#[derive(Clone, Copy, Debug, From)]
pub enum SimpleConditionals {
    Fail(FailConditional),
    Pass(PassConditional),
}

impl Conditional<Null> for SimpleConditionals {
    fn conditional(&self, blackboard: &Null) -> Status {
        match self {
            SimpleConditionals::Fail(f) => f.conditional(blackboard),
            SimpleConditionals::Pass(p) => p.conditional(blackboard),
        }
    }
    fn name(&self) -> Option<String> {
        match self {
            SimpleConditionals::Fail(f) => f.name(),
            SimpleConditionals::Pass(p) => p.name(),
        }
    }
    fn details(&self) -> Option<String> {
        match self {
            SimpleConditionals::Fail(f) => f.details(),
            SimpleConditionals::Pass(p) => p.details(),
        }
    }
}

/// [`Conditional`] that always fails
#[derive(Default, Clone, Copy, Debug)]
pub struct FailConditional;

impl Conditional<Null> for FailConditional {
    fn conditional(&self, _: &Null) -> Status {
        Status::Failure
    }
    fn name(&self) -> Option<String> {
        Some("FailConditional".to_string())
    }
    fn details(&self) -> Option<String> {
        Some("Always fails".to_string())
    }
}

/// [`Conditional`] that always passes
#[derive(Default, Clone, Copy, Debug)]
pub struct PassConditional;

impl Conditional<Null> for PassConditional {
    fn conditional(&self, _: &Null) -> Status {
        Status::Success
    }
    fn name(&self) -> Option<String> {
        Some("PassConditional".to_string())
    }
    fn details(&self) -> Option<String> {
        Some("Always passes".to_string())
    }
}

/// Either [`FailExecutor`] or [`PassExecutor`]
#[derive(Clone, Copy, Debug, From)]
pub enum SimpleExecutors {
    Fail(FailExecutor),
    Pass(PassExecutor),
}

impl Executor<Null> for SimpleExecutors {
    fn execute(&self, blackboard: &mut Null) -> Status {
        match self {
            SimpleExecutors::Fail(f) => f.execute(blackboard),
            SimpleExecutors::Pass(p) => p.execute(blackboard),
        }
    }
    fn name(&self) -> Option<String> {
        match self {
            SimpleExecutors::Fail(f) => f.name(),
            SimpleExecutors::Pass(p) => p.name(),
        }
    }
    fn details(&self) -> Option<String> {
        match self {
            SimpleExecutors::Fail(f) => f.details(),
            SimpleExecutors::Pass(p) => p.details(),
        }
    }
}

/// [`Executor`] that always fails
#[derive(Default, Clone, Copy, Debug)]
pub struct FailExecutor;

impl Executor<Null> for FailExecutor {
    fn execute(&self, _: &mut Null) -> Status {
        Status::Failure
    }
    fn name(&self) -> Option<String> {
        Some("FailExecutor".to_string())
    }
    fn details(&self) -> Option<String> {
        Some("Always fails".to_string())
    }
}

/// [`Executor`] that always succeeds
#[derive(Default, Clone, Copy, Debug)]
pub struct PassExecutor;

impl Executor<Null> for PassExecutor {
    fn execute(&self, _: &mut Null) -> Status {
        Status::Success
    }
    fn name(&self) -> Option<String> {
        Some("PassExecutor".to_string())
    }
    fn details(&self) -> Option<String> {
        Some("Always passes".to_string())
    }
}