Struct TreeEngine 

pub struct TreeEngine<S> { /* private fields */ }

Engine for loading and ticking a tree.

Implementations

impl TreeEngine<Configured>

pub fn new(config: TreeEngineConfig) -> Self

Creates a new engine in the Configured state.

pub fn register_action<B>( &self, behavior: B, ) -> Action<TaskRegistry, TaskHandle, B>

where B: ActionBehavior + 'static,

Registers an action defined by a custom ActionBehavior.

Each action must be registered with the TreeEngine before it can be inserted into a Tree. In other words, all action nodes used by a Tree instance must be registered first.

pub fn tree<N>(self, tree: Tree<N>) -> TreeEngine<TreeLoaded<N>>

where N: Node,

Attaches an already constructed tree and returns an engine in the TreeLoaded state.

impl<N> TreeEngine<TreeLoaded<N>>

where N: Node,

pub fn start_executor(self) -> Result<TreeEngine<Runnable<N>>>

Starts the executor and transitions the engine into the Runnable state.

impl<N> TreeEngine<Runnable<N>>

where N: Node,

pub async fn tick_till_terminal<S>( &mut self, ticker: Ticker<S>, ) -> Result<TickStatus, Error>

where S: Stream<Item = ()>,

Ticks the tree until it reaches a terminal status, then resets the tree before returning that status.