Struct BehaveTree 

pub struct BehaveTree { /* private fields */ }

The main behaviour tree component. A bevy_behave system will query all entities with a BehaveTree to tick them. (unless they have a BehaveAwaitingTrigger component)

Implementations

impl BehaveTree

pub fn new(tree: Tree<Behave>) -> Self

Creates a BehaveTree from an ego_tree::Tree<BehaveNode>. Typically this is created using the behave! macro, but can be constructed using the ego_tree api too.

Panics

An invalid tree will cause a panic here. Use BehaveTree::verify(&tree) to verify your tree definition first.

pub fn verify(tree: &Tree<Behave>) -> bool

Checks the tree definition is valid by verifying that each node has the correct number of children.

pub fn with_logging(self, enabled: bool) -> Self

Should verbose logging be enabled? (typically just for debugging).

Trait Implementations

impl Clone for BehaveTree

fn clone(&self) -> BehaveTree

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Component for BehaveTree

where Self: Send + Sync + 'static,

Required Components: BehaveTargetEntity, Name.

A component’s Required Components are inserted whenever it is inserted. Note that this will also insert the required components of the required components, recursively, in depth-first order.

const STORAGE_TYPE: StorageType = ::bevy::ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl Display for BehaveTree

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.