Struct leafwing_input_manager::action_state::ActionData
source · pub struct ActionData {
pub state: ButtonState,
pub value: f32,
pub axis_pair: Option<DualAxisData>,
pub timing: Timing,
pub consumed: bool,
}
Expand description
Metadata about an Actionlike
action
If a button is released, its reasons_pressed
should be empty.
Fields§
§state: ButtonState
Is the action pressed or released?
value: f32
The “value” of the binding that triggered the action.
See ActionState::value
for more details.
Warning: this value may not be bounded as you might expect. Consider clamping this to account for multiple triggering inputs.
axis_pair: Option<DualAxisData>
The DualAxisData
of the binding that triggered the action.
timing: Timing
When was the button pressed / released, and how long has it been held for?
consumed: bool
Was this action consumed by ActionState::consume
?
Actions that are consumed cannot be pressed again until they are explicitly released. This ensures that consumed actions are not immediately re-pressed by continued inputs.
Trait Implementations§
source§impl Clone for ActionData
impl Clone for ActionData
source§fn clone(&self) -> ActionData
fn clone(&self) -> ActionData
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl Debug for ActionData
impl Debug for ActionData
source§impl Default for ActionData
impl Default for ActionData
source§fn default() -> ActionData
fn default() -> ActionData
Returns the “default value” for a type. Read more
source§impl<'de> Deserialize<'de> for ActionData
impl<'de> Deserialize<'de> for ActionData
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
source§impl FromReflect for ActionDatawhere
Self: Any + Send + Sync,
ButtonState: FromReflect + TypePath,
f32: FromReflect + TypePath,
Option<DualAxisData>: FromReflect + TypePath,
Timing: FromReflect + TypePath,
bool: FromReflect + TypePath,
impl FromReflect for ActionDatawhere
Self: Any + Send + Sync,
ButtonState: FromReflect + TypePath,
f32: FromReflect + TypePath,
Option<DualAxisData>: FromReflect + TypePath,
Timing: FromReflect + TypePath,
bool: FromReflect + TypePath,
source§fn from_reflect(reflect: &dyn Reflect) -> Option<Self>
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>>
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. Read moresource§impl GetTypeRegistration for ActionDatawhere
Self: Any + Send + Sync,
ButtonState: FromReflect + TypePath,
f32: FromReflect + TypePath,
Option<DualAxisData>: FromReflect + TypePath,
Timing: FromReflect + TypePath,
bool: FromReflect + TypePath,
impl GetTypeRegistration for ActionDatawhere
Self: Any + Send + Sync,
ButtonState: FromReflect + TypePath,
f32: FromReflect + TypePath,
Option<DualAxisData>: FromReflect + TypePath,
Timing: FromReflect + TypePath,
bool: FromReflect + TypePath,
fn get_type_registration() -> TypeRegistration
source§impl PartialEq for ActionData
impl PartialEq for ActionData
source§fn eq(&self, other: &ActionData) -> bool
fn eq(&self, other: &ActionData) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.source§impl Reflect for ActionDatawhere
Self: Any + Send + Sync,
ButtonState: FromReflect + TypePath,
f32: FromReflect + TypePath,
Option<DualAxisData>: FromReflect + TypePath,
Timing: FromReflect + TypePath,
bool: FromReflect + TypePath,
impl Reflect for ActionDatawhere
Self: Any + Send + Sync,
ButtonState: FromReflect + TypePath,
f32: FromReflect + TypePath,
Option<DualAxisData>: FromReflect + TypePath,
Timing: FromReflect + TypePath,
bool: FromReflect + TypePath,
source§fn get_represented_type_info(&self) -> Option<&'static TypeInfo>
fn get_represented_type_info(&self) -> Option<&'static TypeInfo>
Returns the [
TypeInfo
] of the type represented by this value. Read moresource§fn as_any_mut(&mut self) -> &mut dyn Any
fn as_any_mut(&mut self) -> &mut dyn Any
Returns the value as a
&mut dyn Any
.source§fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>
fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>
Casts this type to a boxed reflected value.
source§fn as_reflect(&self) -> &dyn Reflect
fn as_reflect(&self) -> &dyn Reflect
Casts this type to a reflected value.
source§fn as_reflect_mut(&mut self) -> &mut dyn Reflect
fn as_reflect_mut(&mut self) -> &mut dyn Reflect
Casts this type to a mutable reflected value.
source§fn clone_value(&self) -> Box<dyn Reflect>
fn clone_value(&self) -> Box<dyn Reflect>
Clones the value as a
Reflect
trait object. Read moresource§fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>
fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>
Performs a type-checked assignment of a reflected value to this value. Read more
source§fn reflect_kind(&self) -> ReflectKind
fn reflect_kind(&self) -> ReflectKind
Returns a zero-sized enumeration of “kinds” of type. Read more
source§fn reflect_ref(&self) -> ReflectRef<'_>
fn reflect_ref(&self) -> ReflectRef<'_>
Returns an immutable enumeration of “kinds” of type. Read more
source§fn reflect_mut(&mut self) -> ReflectMut<'_>
fn reflect_mut(&mut self) -> ReflectMut<'_>
Returns a mutable enumeration of “kinds” of type. Read more
source§fn reflect_owned(self: Box<Self>) -> ReflectOwned
fn reflect_owned(self: Box<Self>) -> ReflectOwned
Returns an owned enumeration of “kinds” of type. Read more
source§fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>
fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>
Returns a “partial equality” comparison result. Read more
§fn reflect_hash(&self) -> Option<u64>
fn reflect_hash(&self) -> Option<u64>
Returns a hash of the value (which includes the type). Read more
§fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>
fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>
Debug formatter for the value. Read more
§fn serializable(&self) -> Option<Serializable<'_>>
fn serializable(&self) -> Option<Serializable<'_>>
Returns a serializable version of the value. Read more
§fn is_dynamic(&self) -> bool
fn is_dynamic(&self) -> bool
Indicates whether or not this type is a dynamic type. Read more
source§impl Serialize for ActionData
impl Serialize for ActionData
source§impl Struct for ActionDatawhere
Self: Any + Send + Sync,
ButtonState: FromReflect + TypePath,
f32: FromReflect + TypePath,
Option<DualAxisData>: FromReflect + TypePath,
Timing: FromReflect + TypePath,
bool: FromReflect + TypePath,
impl Struct for ActionDatawhere
Self: Any + Send + Sync,
ButtonState: FromReflect + TypePath,
f32: FromReflect + TypePath,
Option<DualAxisData>: FromReflect + TypePath,
Timing: FromReflect + TypePath,
bool: FromReflect + TypePath,
source§fn field(&self, name: &str) -> Option<&dyn Reflect>
fn field(&self, name: &str) -> Option<&dyn Reflect>
Returns a reference to the value of the field named
name
as a &dyn Reflect
.source§fn field_mut(&mut self, name: &str) -> Option<&mut 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
.source§fn field_at(&self, index: usize) -> Option<&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
.source§fn field_at_mut(&mut self, index: usize) -> Option<&mut 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
.source§fn name_at(&self, index: usize) -> Option<&str>
fn name_at(&self, index: usize) -> Option<&str>
Returns the name of the field with index
index
.source§fn iter_fields(&self) -> FieldIter<'_>
fn iter_fields(&self) -> FieldIter<'_>
Returns an iterator over the values of the reflectable fields for this struct.
source§fn clone_dynamic(&self) -> DynamicStruct
fn clone_dynamic(&self) -> DynamicStruct
Clones the struct into a [
DynamicStruct
].source§impl TypePath for ActionData
impl TypePath for ActionData
source§fn type_path() -> &'static str
fn type_path() -> &'static str
Returns the fully qualified path of the underlying type. Read more
source§fn short_type_path() -> &'static str
fn short_type_path() -> &'static str
Returns a short, pretty-print enabled path to the type. Read more
source§fn type_ident() -> Option<&'static str>
fn type_ident() -> Option<&'static str>
source§fn crate_name() -> Option<&'static str>
fn crate_name() -> Option<&'static str>
source§impl Typed for ActionDatawhere
Self: Any + Send + Sync,
ButtonState: FromReflect + TypePath,
f32: FromReflect + TypePath,
Option<DualAxisData>: FromReflect + TypePath,
Timing: FromReflect + TypePath,
bool: FromReflect + TypePath,
impl Typed for ActionDatawhere
Self: Any + Send + Sync,
ButtonState: FromReflect + TypePath,
f32: FromReflect + TypePath,
Option<DualAxisData>: FromReflect + TypePath,
Timing: FromReflect + TypePath,
bool: FromReflect + TypePath,
impl StructuralPartialEq for ActionData
Auto Trait Implementations§
impl RefUnwindSafe for ActionData
impl Send for ActionData
impl Sync for ActionData
impl Unpin for ActionData
impl UnwindSafe for ActionData
Blanket Implementations§
§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
§fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
Return the
T
[ShaderType
] for self
. When used in [AsBindGroup
]
derives, it is safe to assume that all images in self
exist.source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Convert
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<T> DynamicTypePath for Twhere
T: TypePath,
impl<T> DynamicTypePath for Twhere
T: TypePath,
§fn reflect_type_path(&self) -> &str
fn reflect_type_path(&self) -> &str
See [
TypePath::type_path
].§fn reflect_short_type_path(&self) -> &str
fn reflect_short_type_path(&self) -> &str
See [
TypePath::short_type_path
].§fn reflect_type_ident(&self) -> Option<&str>
fn reflect_type_ident(&self) -> Option<&str>
See [
TypePath::type_ident
].§fn reflect_crate_name(&self) -> Option<&str>
fn reflect_crate_name(&self) -> Option<&str>
See [
TypePath::crate_name
].§fn reflect_module_path(&self) -> Option<&str>
fn reflect_module_path(&self) -> Option<&str>
See [
TypePath::module_path
].§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Creates
Self
using data from the given [World
].§impl<S> GetField for Swhere
S: Struct,
impl<S> GetField for Swhere
S: Struct,
§impl<T> GetPath for Twhere
T: Reflect + ?Sized,
impl<T> GetPath for Twhere
T: Reflect + ?Sized,
§fn reflect_path<'p>(
&self,
path: impl ReflectPath<'p>
) -> Result<&(dyn Reflect + 'static), ReflectPathError<'p>>
fn reflect_path<'p>( &self, path: impl ReflectPath<'p> ) -> Result<&(dyn Reflect + 'static), ReflectPathError<'p>>
Returns a reference to the value specified by
path
. Read more§fn reflect_path_mut<'p>(
&mut self,
path: impl ReflectPath<'p>
) -> Result<&mut (dyn Reflect + 'static), ReflectPathError<'p>>
fn reflect_path_mut<'p>( &mut self, path: impl ReflectPath<'p> ) -> Result<&mut (dyn Reflect + 'static), ReflectPathError<'p>>
Returns a mutable reference to the value specified by
path
. Read more