Struct ActionState 

pub struct ActionState<A>(pub A);

Available on crate feature input_native and (crate features input_bei or input_native or leafwing) only.

The component that will store the current status of the action for the entity

Note that your action HAS to implement MapEntities and Default. The Default value should be when no actions/inputs are active. It is important to distinguish between “no input” (e.g. no keys pressed) and “input not received” (e.g. network packet loss).

Tuple Fields

0: A

Trait Implementations

impl<A> ActionStateQueryData for ActionState<A>

where A: Default + Send + Sync + 'static,

type Mut = &'static mut ActionState<A>

type MutItemInner<'w> = &'w mut ActionState<A>

type Main = ActionState<A>

type Bundle = ActionState<A>

fn as_read_only<'a, 'w, 's>( state: &'a <<ActionState<A> as ActionStateQueryData>::Mut as QueryData>::Item<'w, 's>, ) -> <<<ActionState<A> as ActionStateQueryData>::Mut as QueryData>::ReadOnly as QueryData>::Item<'a, 's>

where 'w: 'a,

fn into_inner<'w, 's>( mut_item: <<ActionState<A> as ActionStateQueryData>::Mut as QueryData>::Item<'w, 's>, ) -> <ActionState<A> as ActionStateQueryData>::MutItemInner<'w>

fn as_mut( bundle: &mut <ActionState<A> as ActionStateQueryData>::Bundle, ) -> <ActionState<A> as ActionStateQueryData>::MutItemInner<'_>

fn base_value() -> <ActionState<A> as ActionStateQueryData>::Bundle

impl<A> Clone for ActionState<A>

where A: Clone,

fn clone(&self) -> ActionState<A>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<A> Component for ActionState<A>

where ActionState<A>: 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, 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<ActionState<A>>>

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<A> Debug for ActionState<A>

where A: Debug,

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

Formats the value using the given formatter.

impl<A> Default for ActionState<A>

where A: Default,

fn default() -> ActionState<A>

Returns the “default value” for a type.

impl<A> Deref for ActionState<A>

type Target = A

The resulting type after dereferencing.

fn deref(&self) -> &<ActionState<A> as Deref>::Target

Dereferences the value.

impl<A> DerefMut for ActionState<A>

fn deref_mut(&mut self) -> &mut <ActionState<A> as Deref>::Target

Mutably dereferences the value.

impl<'de, A> Deserialize<'de> for ActionState<A>

where A: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<ActionState<A>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<A> From<&ActionState<A>> for Compressed<A>

where A: Clone,

fn from(value: &ActionState<A>) -> Compressed<A>

Converts to this type from the input type.

impl<A> FromReflect for ActionState<A>

where ActionState<A>: Any + Send + Sync, A: TypePath + FromReflect + MaybeTyped + RegisterForReflection,

fn from_reflect( reflect: &(dyn PartialReflect + 'static), ) -> Option<ActionState<A>>

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<A> GetTypeRegistration for ActionState<A>

where ActionState<A>: Any + Send + Sync, A: TypePath + FromReflect + 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<A> InputSnapshot for ActionState<A>

where A: Debug + Default + PartialEq + Clone + Send + Sync + 'static,

fn decay_tick(&mut self, tick_duration: Duration)

Predict the next snapshot after 1 tick.

impl<A> MapEntities for ActionState<A>

where A: MapEntities,

fn map_entities<E>(&mut self, entity_mapper: &mut E)

where E: EntityMapper,

Updates all Entity references stored inside using entity_mapper.

impl<A> PartialEq for ActionState<A>

where A: PartialEq,

fn eq(&self, other: &ActionState<A>) -> 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<A> PartialReflect for ActionState<A>

where ActionState<A>: Any + Send + Sync, A: TypePath + FromReflect + 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 + 'static), ) -> 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<ActionState<A>>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<ActionState<A>>, ) -> 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 + 'static)>

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

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

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

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

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &(dyn PartialReflect + 'static)

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut (dyn PartialReflect + 'static)

Casts this type to a mutable, reflected value.

fn reflect_partial_eq( &self, value: &(dyn PartialReflect + 'static), ) -> 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<A> Reflect for ActionState<A>

where ActionState<A>: Any + Send + Sync, A: TypePath + FromReflect + MaybeTyped + RegisterForReflection,

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

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &(dyn Any + 'static)

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Returns the value as a &mut dyn Any.

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

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

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

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<A> Serialize for ActionState<A>

where A: Serialize,

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<A> StructuralPartialEq for ActionState<A>

where A: PartialEq,

impl<A> TupleStruct for ActionState<A>

where ActionState<A>: Any + Send + Sync, A: TypePath + FromReflect + MaybeTyped + RegisterForReflection,

fn field(&self, index: usize) -> Option<&(dyn PartialReflect + 'static)>

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

fn field_mut( &mut self, index: usize, ) -> Option<&mut (dyn PartialReflect + 'static)>

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

fn field_len(&self) -> usize

Returns the number of fields in the tuple struct.

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

Returns an iterator over the values of the tuple struct’s fields.

fn to_dynamic_tuple_struct(&self) -> DynamicTupleStruct

Creates a new DynamicTupleStruct from this tuple struct.

fn get_represented_tuple_struct_info(&self) -> Option<&'static TupleStructInfo>

Will return None if TypeInfo is not available.

impl<A> TypePath for ActionState<A>

where ActionState<A>: Any + Send + Sync, A: TypePath,

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<A> Typed for ActionState<A>

where ActionState<A>: Any + Send + Sync, A: TypePath + FromReflect + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.