Enum StateAction 

pub enum StateAction<T>
where
    T: EntityId,
{
    None,
    RewindAnimation(Handle<Animation<T>>),
    EnableAnimation(Handle<Animation<T>>),
    DisableAnimation(Handle<Animation<T>>),
    EnableRandomAnimation(Vec<Handle<Animation<T>>>),
}

An action, that will be executed by a state. It usually used to rewind, enable/disable animations when entering or leaving states. This is useful in situations when you have a one-shot animation and you need to rewind it before when entering some state. For example, you may have looped idle state and one-shot attack state. In this case, you need to use StateAction::RewindAnimation to tell the engine to automatically rewind the animation before using it. Otherwise, when the transition will happen, the animation could be ended already and you’ll get “frozen” animation.

Variants

None

No action.

RewindAnimation(Handle<Animation<T>>)

Rewinds the animation.

EnableAnimation(Handle<Animation<T>>)

Enables the animation.

DisableAnimation(Handle<Animation<T>>)

Disables the animation.

EnableRandomAnimation(Vec<Handle<Animation<T>>>)

Enables random animation from the list. It could be useful if you want to add randomization to your state machine. For example, you may have few melee attack animations and all of them are suitable for every situation, in this case you can add randomization to make attacks less predictable.

Implementations

impl<T> StateAction<T>

where T: EntityId,

pub const REWIND_ANIMATION_F_0: &'static str = "RewindAnimation@0"

pub const ENABLE_ANIMATION_F_0: &'static str = "EnableAnimation@0"

pub const DISABLE_ANIMATION_F_0: &'static str = "DisableAnimation@0"

pub const ENABLE_RANDOM_ANIMATION_F_0: &'static str = "EnableRandomAnimation@0"

impl<T> StateAction<T>

where T: EntityId,

pub fn apply(&self, animations: &mut AnimationContainer<T>)

Applies the action to the given animation container.

Trait Implementations

impl<T> AsRef<str> for StateAction<T>

where T: EntityId,

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> Clone for StateAction<T>

where T: Clone + EntityId,

fn clone(&self) -> StateAction<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for StateAction<T>

where T: Debug + EntityId,

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

Formats the value using the given formatter.

impl<T> Default for StateAction<T>

where T: EntityId,

fn default() -> StateAction<T>

Returns the “default value” for a type.

impl<T> FromStr for StateAction<T>

where T: EntityId,

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<StateAction<T>, <StateAction<T> as FromStr>::Err>

Parses a string s to return a value of this type.

impl<T> PartialEq for StateAction<T>

where T: PartialEq + EntityId,

fn eq(&self, other: &StateAction<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Reflect for StateAction<T>

where T: EntityId, StateAction<T>: 'static, Handle<Animation<T>>: Reflect, Vec<Handle<Animation<T>>>: Reflect,

fn source_path() -> &'static str

fn type_name(&self) -> &'static str

fn doc(&self) -> &'static str

fn assembly_name(&self) -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn type_assembly_name() -> &'static str

Returns a parent assembly name of the type that implements this trait. WARNING: You should use proc-macro (#[derive(Reflect)]) to ensure that this method will return correct assembly name. In other words - there’s no guarantee, that any implementation other than proc-macro will return a correct name of the assembly. Alternatively, you can use env!("CARGO_PKG_NAME") as an implementation.

fn fields_info(&self, func: &mut dyn FnMut(&[FieldInfo<'_, '_>]))

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

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

fn as_any(&self, func: &mut dyn FnMut(&(dyn Any + 'static)))

fn as_any_mut(&mut self, func: &mut dyn FnMut(&mut (dyn Any + 'static)))

fn as_reflect(&self, func: &mut dyn FnMut(&(dyn Reflect + 'static)))

fn as_reflect_mut(&mut self, func: &mut dyn FnMut(&mut (dyn Reflect + 'static)))

fn fields(&self, func: &mut dyn FnMut(&[&(dyn Reflect + 'static)]))

fn fields_mut( &mut self, func: &mut dyn FnMut(&mut [&mut (dyn Reflect + 'static)]), )

fn field( &self, name: &str, func: &mut dyn FnMut(Option<&(dyn Reflect + 'static)>), )

fn field_mut( &mut self, name: &str, func: &mut dyn FnMut(Option<&mut (dyn Reflect + 'static)>), )

fn set_field( &mut self, field: &str, value: Box<dyn Reflect>, func: &mut dyn FnMut(Result<Box<dyn Reflect>, Box<dyn Reflect>>), )

Calls user method specified with #[reflect(setter = ..)] or falls back to Reflect::field_mut

fn as_array(&self, func: &mut dyn FnMut(Option<&(dyn ReflectArray + 'static)>))

fn as_array_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectArray + 'static)>), )

fn as_list(&self, func: &mut dyn FnMut(Option<&(dyn ReflectList + 'static)>))

fn as_list_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectList + 'static)>), )

fn as_inheritable_variable( &self, func: &mut dyn FnMut(Option<&(dyn ReflectInheritableVariable + 'static)>), )

fn as_inheritable_variable_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectInheritableVariable + 'static)>), )

fn as_hash_map( &self, func: &mut dyn FnMut(Option<&(dyn ReflectHashMap + 'static)>), )

fn as_hash_map_mut( &mut self, func: &mut dyn FnMut(Option<&mut (dyn ReflectHashMap + 'static)>), )

impl<T> TryFrom<&str> for StateAction<T>

where T: EntityId,

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from( s: &str, ) -> Result<StateAction<T>, <StateAction<T> as TryFrom<&str>>::Error>

Performs the conversion.

impl<T> TypeUuidProvider for StateAction<T>

where T: EntityId,

fn type_uuid() -> Uuid

Return type UUID.

impl<T> VariantNames for StateAction<T>

where T: EntityId,

const VARIANTS: &'static [&'static str]

Names of the variants of this enum

impl<T> Visit for StateAction<T>

where T: EntityId, Handle<Animation<T>>: Visit, Vec<Handle<Animation<T>>>: Visit,

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> Result<(), VisitError>

Read or write this value, depending on whether Visitor::is_reading() is true or false.

impl<T> StructuralPartialEq for StateAction<T>

where T: EntityId,