Struct TransitionQueue 

pub struct TransitionQueue<T: Behavior> { /* private fields */ }

A queue of transitions to be invoked automatically.

Implementations

impl<T: Behavior> TransitionQueue<T>

pub fn chain(items: impl IntoIterator<Item = T>) -> Self

Creates a new TransitionQueue which starts each given behavior in order.

Unlike TransitionQueue::sequence, a chain does not wait for the behaviors to stop and starts the behaviors on top of each other. This is useful when you wish to load a set of states onto the behavior stack (i.e. “Bird must Fly and Chirp”).

You must ensure that each transition in the chain is allowed (see Behavior::filter_next). The sequence will stop if any transition fails.

pub fn sequence(items: impl IntoIterator<Item = T>) -> Self

Creates a new TransitionQueue which starts each given behavior in order, waiting for each one to stop before starting the next.

Unlike TransitionQueue::chain, a sequence waits for each behavior to stop before starting the next. This is useful when you want to queue some actions after each other (e.g. “Bird must Chirp, then Fly”).

You must ensure each transition from the current behavior to all elements in the sequence is allowed (see Behavior::filter_next). The sequence will stop if any transition fails.

pub fn empty() -> Self

Creates an empty TransitionQueue.

pub fn start(next: T) -> Self

Creates a new TransitionQueue which starts with the given Behavior.

pub fn stop() -> Self

Creates a new TransitionQueue which starts by stopping the current Behavior.

pub fn wait_for(next: T) -> Self

Creates a new TransitionQueue which starts with the given Behavior and waits for it to stop.

pub fn is_empty(&self) -> bool

Returns true if the TransitionQueue is empty.

pub fn len(&self) -> usize

Returns the number of transitions in the TransitionQueue.

pub fn then(self, next: T) -> Self

Extends the TransitionQueue by starting the next Behavior.

pub fn then_if(self, condition: bool, next: T) -> Self

Extends the TransitionQueue by starting the next Behavior if and only if condition is true.

This is just a convenient shortcut useful when creating complex queues, for example:

use bevy::prelude::*;
use moonshine_behavior::prelude::*;

#[derive(Component, Debug)]
pub enum Foo {
    Bar,
    Baz,
}

impl Behavior for Foo {}

fn make_queue(baz: bool) -> TransitionQueue<Foo> {
    TransitionQueue::start(Foo::Bar).then_if(baz, Foo::Baz)
}

pub fn then_wait_for(self, next: T) -> Self

Extends the TransitionQueue by starting the next Behavior and waiting for it to stop.

pub fn then_stop(self) -> Self

Extends the TransitionQueue by stopping the current Behavior.

Trait Implementations

impl<T: Behavior> Component for TransitionQueue<T>

where Self: Send + Sync + 'static,

Required Components: [Expect < Transition < T > >].

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 relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

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<T> FromReflect for TransitionQueue<T>

where TransitionQueue<T>: Any + Send + Sync, T: TypePath + Behavior, VecDeque<TransitionQueueItem<T>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl<T> GetTypeRegistration for TransitionQueue<T>

where TransitionQueue<T>: Any + Send + Sync, T: TypePath + Behavior, VecDeque<TransitionQueueItem<T>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl<T> PartialReflect for TransitionQueue<T>

where TransitionQueue<T>: Any + Send + Sync, T: TypePath + Behavior, VecDeque<TransitionQueueItem<T>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn try_apply(&mut self, value: &dyn PartialReflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<Self>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&dyn Reflect>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut dyn Reflect>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Self>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

fn reflect_partial_eq(&self, value: &dyn PartialReflect) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

fn reflect_clone_and_take<T>(&self) -> Result<T, ReflectCloneError>

where T: 'static, Self: Sized + TypePath,

For a type implementing PartialReflect, combines reflect_clone and take in a useful fashion, automatically constructing an appropriate ReflectCloneError if the downcast fails.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl<T> Reflect for TransitionQueue<T>

where TransitionQueue<T>: Any + Send + Sync, T: TypePath + Behavior, VecDeque<TransitionQueueItem<T>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

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

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable, fully-reflected value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

impl<T> Struct for TransitionQueue<T>

where TransitionQueue<T>: Any + Send + Sync, T: TypePath + Behavior, VecDeque<TransitionQueueItem<T>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn field(&self, name: &str) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field named name as a &dyn PartialReflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field named name as a &mut dyn PartialReflect.

fn field_at(&self, index: usize) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field with index index as a &dyn PartialReflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn PartialReflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn to_dynamic_struct(&self) -> DynamicStruct

Creates a new DynamicStruct from this struct.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl<T> TypePath for TransitionQueue<T>

where TransitionQueue<T>: Any + Send + Sync, T: TypePath + Behavior,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl<T> Typed for TransitionQueue<T>

where TransitionQueue<T>: Any + Send + Sync, T: TypePath + Behavior, VecDeque<TransitionQueueItem<T>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.