Struct YoetzAdvisor

pub struct YoetzAdvisor<S: YoetzSuggestion> {
    pub consistency_bonus: f32,
    /* private fields */
}

Controls an entity’s AI by listening to YoetzSuggestions and updating the entity’s behavior components.

Fields

consistency_bonus: f32

Added to score of any suggestion that matches the currently active behavior. This can be used to reduce the “flickering” when multiple suggestions are flocking around the same score.

Implementations

impl<S: YoetzSuggestion> YoetzAdvisor<S>

pub fn new(consistency_bonus: f32) -> Self

Create a new advisor with the specified consistency_bonus.

pub fn active_key(&self) -> &Option<S::Key>

The Key of the currently active behavior.

This can be used to implement a state machine behavior, where the code that suggests a behavior can look at the current state.

pub fn suggest(&mut self, score: f32, suggestion: S)

Suggest a behavior for the AI to consider.

A suggestion should be sent every frame as long as it is valid - once it stops being sent it will immediately be replaced by another suggestion.

Trait Implementations

impl<S: YoetzSuggestion> Component for YoetzAdvisor<S>

where Self: Send + Sync + 'static,

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, components: &mut ComponentsRegistrator<'_>, required_components: &mut RequiredComponents, inheritance_depth: u16, recursion_check_stack: &mut Vec<ComponentId>, )

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 register_component_hooks(hooks: &mut ComponentHooks)

👎Deprecated since 0.16.0: Use the individual hook methods instead (e.g., Component::on_add, etc.)

Called when registering this component, allowing mutable access to its ComponentHooks.

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]