Skip to main content

TreeBuilder

Struct TreeBuilder 

Source
pub struct TreeBuilder { /* private fields */ }
Expand description

Fluent builder for assembling BehaviorNode trees.

§Example

let root = TreeBuilder::sequence("root")
    .leaf("idle", |_bb, _dt| NodeStatus::Success)
    .selector("patrol_or_attack")
        .leaf("patrol", patrol_fn)
        .leaf("attack", attack_fn)
    .end()
    .build();

Implementations§

Source§

impl TreeBuilder

Source

pub fn sequence(name: &str) -> Self

Begin a new top-level Sequence.

Source

pub fn selector(name: &str) -> Self

Begin a new top-level Selector.

Source

pub fn parallel(name: &str, policy: ParallelPolicy) -> Self

Begin a new top-level Parallel.

Source

pub fn sequence_child(self, name: &str) -> Self

Push a Sequence child onto the current composite.

Source

pub fn selector_child(self, name: &str) -> Self

Push a Selector child onto the current composite.

Source

pub fn parallel_child(self, name: &str, policy: ParallelPolicy) -> Self

Push a Parallel child onto the current composite.

Source

pub fn decorator(self, name: &str, kind: DecoratorKind) -> Self

Push a Decorator child onto the current composite.

Source

pub fn leaf<F>(self, name: &str, tick_fn: F) -> Self
where F: FnMut(&mut Blackboard, f32) -> NodeStatus + 'static,

Add a leaf node to the current composite or decorator.

Source

pub fn leaf_full<Enter, Tick, Exit>( self, name: &str, enter_fn: Enter, tick_fn: Tick, exit_fn: Exit, ) -> Self
where Enter: FnMut(&mut Blackboard) + 'static, Tick: FnMut(&mut Blackboard, f32) -> NodeStatus + 'static, Exit: FnMut(&mut Blackboard, NodeStatus) + 'static,

Add a full leaf with enter/exit callbacks.

Source

pub fn subtree_ref(self, name: &str) -> Self

Add a subtree reference node.

Source

pub fn node(self, node: BehaviorNode) -> Self

Add an already-built node as a child.

Source

pub fn end(self) -> Self

Close the current composite/decorator and return to the parent.

Source

pub fn build(self) -> BehaviorNode

Finish building and return the root BehaviorNode. Panics if not at the outermost frame.

Source

pub fn into_tree(self, tree_name: &str) -> BehaviorTree

Convenience: build and wrap in a BehaviorTree.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,