Struct bevy_input::Input
source · pub struct Input<T: Copy + Eq + Hash + Send + Sync + 'static> { /* private fields */ }
Expand description
A “press-able” input of type T
.
Usage
This type can be used as a resource to keep the current state of an input, by reacting to events from the input. For a given input value:
Input::pressed
will returntrue
between a press and a release event.Input::just_pressed
will returntrue
for one frame after a press event.Input::just_released
will returntrue
for one frame after a release event.
Multiple systems
In case multiple systems are checking for Input::just_pressed
or Input::just_released
but only one should react, for example in the case of triggering
State
change, you should consider clearing the input state, either by:
- Using
Input::clear_just_pressed
orInput::clear_just_released
instead. - Calling
Input::clear
orInput::reset
immediately after the state change.
Note
When adding this resource for a new input type, you should:
- Call the
Input::press
method for each press event. - Call the
Input::release
method for each release event. - Call the
Input::clear
method at each frame start, before processing events.
Note: Calling clear
from a ResMut
will trigger change detection.
It may be preferable to use DetectChangesMut::bypass_change_detection
to avoid causing the resource to always be marked as changed.
Implementations§
source§impl<T> Input<T>where
T: Copy + Eq + Hash + Send + Sync + 'static,
impl<T> Input<T>where T: Copy + Eq + Hash + Send + Sync + 'static,
sourcepub fn any_pressed(&self, inputs: impl IntoIterator<Item = T>) -> bool
pub fn any_pressed(&self, inputs: impl IntoIterator<Item = T>) -> bool
Returns true
if any item in inputs
has been pressed.
sourcepub fn release_all(&mut self)
pub fn release_all(&mut self)
Registers a release for all currently pressed inputs.
sourcepub fn just_pressed(&self, input: T) -> bool
pub fn just_pressed(&self, input: T) -> bool
Returns true
if the input
has just been pressed.
sourcepub fn any_just_pressed(&self, inputs: impl IntoIterator<Item = T>) -> bool
pub fn any_just_pressed(&self, inputs: impl IntoIterator<Item = T>) -> bool
Returns true
if any item in inputs
has just been pressed.
sourcepub fn clear_just_pressed(&mut self, input: T) -> bool
pub fn clear_just_pressed(&mut self, input: T) -> bool
Clears the just_pressed
state of the input
and returns true
if the input
has just been pressed.
Future calls to Input::just_pressed
for the given input will return false until a new press event occurs.
sourcepub fn just_released(&self, input: T) -> bool
pub fn just_released(&self, input: T) -> bool
Returns true
if the input
has just been released.
sourcepub fn any_just_released(&self, inputs: impl IntoIterator<Item = T>) -> bool
pub fn any_just_released(&self, inputs: impl IntoIterator<Item = T>) -> bool
Returns true
if any item in inputs
has just been released.
sourcepub fn clear_just_released(&mut self, input: T) -> bool
pub fn clear_just_released(&mut self, input: T) -> bool
Clears the just_released
state of the input
and returns true
if the input
has just been released.
Future calls to Input::just_released
for the given input will return false until a new release event occurs.
sourcepub fn reset(&mut self, input: T)
pub fn reset(&mut self, input: T)
Clears the pressed
, just_pressed
and just_released
data of the input
.
sourcepub fn reset_all(&mut self)
pub fn reset_all(&mut self)
Clears the pressed
, just_pressed
, and just_released
data for every input.
See also Input::clear
for simulating elapsed time steps.
sourcepub fn clear(&mut self)
pub fn clear(&mut self)
Clears the just pressed
and just released
data for every input.
See also Input::reset_all
for a full reset.
sourcepub fn get_pressed(&self) -> impl ExactSizeIterator<Item = &T>
pub fn get_pressed(&self) -> impl ExactSizeIterator<Item = &T>
An iterator visiting every pressed input in arbitrary order.
sourcepub fn get_just_pressed(&self) -> impl ExactSizeIterator<Item = &T>
pub fn get_just_pressed(&self) -> impl ExactSizeIterator<Item = &T>
An iterator visiting every just pressed input in arbitrary order.
sourcepub fn get_just_released(&self) -> impl ExactSizeIterator<Item = &T>
pub fn get_just_released(&self) -> impl ExactSizeIterator<Item = &T>
An iterator visiting every just released input in arbitrary order.
Trait Implementations§
source§impl<T: Copy + Eq + Hash + Send + Sync + 'static> GetTypeRegistration for Input<T>where
HashSet<T>: Reflect,
impl<T: Copy + Eq + Hash + Send + Sync + 'static> GetTypeRegistration for Input<T>where HashSet<T>: Reflect,
source§impl<T: Copy + Eq + Hash + Send + Sync + 'static> Reflect for Input<T>where
HashSet<T>: Reflect,
impl<T: Copy + Eq + Hash + Send + Sync + 'static> Reflect for Input<T>where HashSet<T>: Reflect,
source§fn get_type_info(&self) -> &'static TypeInfo
fn get_type_info(&self) -> &'static TypeInfo
source§fn as_any_mut(&mut self) -> &mut dyn Any
fn as_any_mut(&mut self) -> &mut dyn Any
&mut dyn Any
.source§fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>
fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>
source§fn as_reflect(&self) -> &dyn Reflect
fn as_reflect(&self) -> &dyn Reflect
source§fn as_reflect_mut(&mut self) -> &mut dyn Reflect
fn as_reflect_mut(&mut self) -> &mut dyn Reflect
source§fn clone_value(&self) -> Box<dyn Reflect>
fn clone_value(&self) -> Box<dyn Reflect>
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>>
source§fn reflect_ref(&self) -> ReflectRef<'_>
fn reflect_ref(&self) -> ReflectRef<'_>
source§fn reflect_mut(&mut self) -> ReflectMut<'_>
fn reflect_mut(&mut self) -> ReflectMut<'_>
source§fn reflect_owned(self: Box<Self>) -> ReflectOwned
fn reflect_owned(self: Box<Self>) -> ReflectOwned
source§fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>
fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>
source§fn reflect_hash(&self) -> Option<u64>
fn reflect_hash(&self) -> Option<u64>
source§fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>
fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>
source§fn serializable(&self) -> Option<Serializable<'_>>
fn serializable(&self) -> Option<Serializable<'_>>
source§impl<T: Copy + Eq + Hash + Send + Sync + 'static> Struct for Input<T>where
HashSet<T>: Reflect,
impl<T: Copy + Eq + Hash + Send + Sync + 'static> Struct for Input<T>where HashSet<T>: Reflect,
source§fn field(&self, name: &str) -> Option<&dyn Reflect>
fn field(&self, name: &str) -> Option<&dyn Reflect>
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>
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>
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>
index
as a &mut dyn Reflect
.source§fn name_at(&self, index: usize) -> Option<&str>
fn name_at(&self, index: usize) -> Option<&str>
index
.source§fn iter_fields(&self) -> FieldIter<'_>
fn iter_fields(&self) -> FieldIter<'_>
source§fn clone_dynamic(&self) -> DynamicStruct
fn clone_dynamic(&self) -> DynamicStruct
DynamicStruct
.source§impl<T: Copy + Eq + Hash + Send + Sync + 'static> Typed for Input<T>where
HashSet<T>: Reflect,
impl<T: Copy + Eq + Hash + Send + Sync + 'static> Typed for Input<T>where HashSet<T>: Reflect,
impl<T: Copy + Eq + Hash + Send + Sync + 'static> Resource for Input<T>where Self: Send + Sync + 'static,
Auto Trait Implementations§
impl<T> RefUnwindSafe for Input<T>where T: RefUnwindSafe,
impl<T> Send for Input<T>
impl<T> Sync for Input<T>
impl<T> Unpin for Input<T>where T: Unpin,
impl<T> UnwindSafe for Input<T>where T: UnwindSafe,
Blanket Implementations§
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere T: Any,
§fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
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 + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
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)
&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)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere T: Default,
source§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Self
using data from the given Worldsource§impl<S> GetField for Swhere
S: Struct,
impl<S> GetField for Swhere S: Struct,
source§impl<T> GetPath for Twhere
T: Reflect,
impl<T> GetPath for Twhere T: Reflect,
source§fn reflect_path<'r, 'p>(
&'r self,
path: &'p str
) -> Result<&'r (dyn Reflect + 'static), ReflectPathError<'p>>
fn reflect_path<'r, 'p>( &'r self, path: &'p str ) -> Result<&'r (dyn Reflect + 'static), ReflectPathError<'p>>
path
. Read moresource§fn reflect_path_mut<'r, 'p>(
&'r mut self,
path: &'p str
) -> Result<&'r mut (dyn Reflect + 'static), ReflectPathError<'p>>
fn reflect_path_mut<'r, 'p>( &'r mut self, path: &'p str ) -> Result<&'r mut (dyn Reflect + 'static), ReflectPathError<'p>>
path
. Read more