Struct AnimationStateMachine

pub struct AnimationStateMachine { /* private fields */ }

Main state machine component

Insert this on the entity you want to control with the state machine.

Note:

To function, the component requires an AnimationPlayer on the same entity.

---

Example

fn setup(mut commands: Commands) {
    let starting_state = "idle";
    let my_states_map = HashMap::from([
        ("idle", AnimationState{
            name: "idle".to_string(),
            clip: idle_clip_handle,
            interruptible: true,
        }),
        ("run", AnimationState{
            name: "run".to_string(),
            clip: run_clip_handle,
            interruptible: true,
        }),
    ]);
    let my_states_transitions_vec = vec![
        StateMachineTransition::immediate(
            AnimationStateRef::from_string("idle"),
            AnimationStateRef::from_string("run"),
            StateMachineTrigger::from(|vars| vars["run"].is_bool(true)),
        ),
    ];
    let state_machine_vars = HashMap::from([
        ("run", StateMachineVariableType::Bool(false)),
    ]);
      
    commands.spawn(SpatialBundle::default())
        .insert(AnimationPlayer::default())
        .insert(AnimationStateMachine::new(
            starting_state,
            my_states_map,
            my_states_transitions_vec,
            state_machine_vars,
        ));
}

Implementations

impl AnimationStateMachine

pub fn new<T: ToString>( current_state: T, states: HashMap<T, AnimationState>, transitions: Vec<StateMachineTransition>, variables: HashMap<T, StateMachineVariableType>, ) -> Self

Creates a new AnimationStateMachine

pub fn update_variable<T: ToString>( &mut self, name: T, value: StateMachineVariableType, )

Updates the value of the given variable

Trait Implementations

impl Component for AnimationStateMachine

where Self: Send + Sync + 'static,

type Storage = TableStorage

A marker type indicating the storage type used for this component. This must be either TableStorage or SparseStorage.

impl Default for AnimationStateMachine

fn default() -> AnimationStateMachine

Returns the “default value” for a type.

impl FromReflect for AnimationStateMachine

where Self: Any + Send + Sync, String: FromReflect + TypePath, HashMap<String, AnimationState>: FromReflect + TypePath, Vec<StateMachineTransition>: FromReflect + TypePath, StateMachineVariables: FromReflect + TypePath,

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

Constructs a concrete instance of Self from a reflected value.

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

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

impl GetTypeRegistration for AnimationStateMachine

where Self: Any + Send + Sync, String: FromReflect + TypePath, HashMap<String, AnimationState>: FromReflect + TypePath, Vec<StateMachineTransition>: FromReflect + TypePath, StateMachineVariables: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl Reflect for AnimationStateMachine

where Self: Any + Send + Sync, String: FromReflect + TypePath, HashMap<String, AnimationState>: FromReflect + TypePath, Vec<StateMachineTransition>: FromReflect + TypePath, StateMachineVariables: FromReflect + TypePath,

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

Returns the TypeInfo of the type represented by this value.

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 reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

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

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

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

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

fn apply(&mut self, value: &dyn Reflect)

Applies 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 reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

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 serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Struct for AnimationStateMachine

where Self: Any + Send + Sync, String: FromReflect + TypePath, HashMap<String, AnimationState>: FromReflect + TypePath, Vec<StateMachineTransition>: FromReflect + TypePath, StateMachineVariables: FromReflect + TypePath,

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

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

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

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

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

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

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

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

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 clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl TypePath for AnimationStateMachine

where Self: Any + Send + Sync,

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 Typed for AnimationStateMachine

where Self: Any + Send + Sync, String: FromReflect + TypePath, HashMap<String, AnimationState>: FromReflect + TypePath, Vec<StateMachineTransition>: FromReflect + TypePath, StateMachineVariables: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.