bevior_tree 0.10.0

Behavior tree plugin for Bevy.
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

//! Abstract representation of node of behavior tree.

use bevy::prelude::{Entity, World};
use std::{any::Any, ops::Not};

pub mod prelude {
    pub use super::{Node, NodeResult, NodeState, NodeStateError, NodeStatus, WithState};
    pub use derive_nodestate::NodeState;
    pub use macro_delegatenode::delegate_node;
    pub use macro_withstate::with_state;
}

/// State of pending, work in progress nodes.
/// `#[derive(NodeState)]` is available.
pub trait NodeState: 'static + Send + Sync {
    fn into_any(self: Box<Self>) -> Box<dyn Any>;
}

/// Result of completed nodes.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum NodeResult {
    Success,
    Failure,
}
impl Not for NodeResult {
    type Output = NodeResult;
    fn not(self) -> Self::Output {
        match self {
            NodeResult::Success => NodeResult::Failure,
            NodeResult::Failure => NodeResult::Success,
        }
    }
}

/// Status of execution of the node.
pub enum NodeStatus {
    Beginning,
    Pending(Box<dyn NodeState>),
    Complete(NodeResult),
}
impl NodeStatus {
    pub fn result(&self) -> Option<NodeResult> {
        match self {
            &NodeStatus::Complete(result) => Some(result),
            _ => None,
        }
    }
}

/// Node of behavior trees.
/// Nodes should not hold the state of execution.
/// Nodes take state of execution as argument, do things with it, then return the status of the execution.
pub trait Node: 'static + Send + Sync {
    fn begin(&self, world: &mut World, entity: Entity) -> NodeStatus;
    fn resume(&self, world: &mut World, entity: Entity, state: Box<dyn NodeState>) -> NodeStatus;
    fn force_exit(&self, world: &mut World, entity: Entity, state: Box<dyn NodeState>);
}

/// Trait to pair the node and the state.
/// Also `#[with_state(State)]` is available for simple cases.
///
/// Nodes take `state: Box<dyn NodeState>`, so this trait help downcast it.
pub trait WithState<State: NodeState>: Node {
    fn downcast(state: Box<dyn NodeState>) -> Result<State, NodeStateError> {
        let result = state.into_any().downcast::<State>();
        match result {
            Ok(state) => Ok(*state),
            Err(_) => Err(NodeStateError::InvalidTypeOfState),
        }
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum NodeStateError {
    InvalidTypeOfState,
}

/// Shorthand to delegate node.
/// Also `#[delegate_node(target)]` is available for simple cases.
pub trait DelegateNode: 'static + Send + Sync {
    fn delegate_node(&self) -> &dyn Node;
}
impl<T: DelegateNode> Node for T {
    fn begin(&self, world: &mut World, entity: Entity) -> NodeStatus {
        self.delegate_node().begin(world, entity)
    }
    fn resume(&self, world: &mut World, entity: Entity, state: Box<dyn NodeState>) -> NodeStatus {
        self.delegate_node().resume(world, entity, state)
    }
    fn force_exit(&self, world: &mut World, entity: Entity, state: Box<dyn NodeState>) {
        self.delegate_node().force_exit(world, entity, state)
    }
}