Struct bevy_input::Input
source · [−]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.
Implementations
sourceimpl<T> Input<T> where
T: Copy + Eq + Hash,
impl<T> Input<T> where
T: Copy + Eq + Hash,
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
Auto Trait Implementations
impl<T> RefUnwindSafe for Input<T> where
T: RefUnwindSafe,
impl<T> Send for Input<T> where
T: Send,
impl<T> Sync for Input<T> where
T: Sync,
impl<T> Unpin for Input<T> where
T: Unpin,
impl<T> UnwindSafe for Input<T> where
T: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn 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 T where
T: Any,
impl<T> Downcast for T where
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>
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
. Read more
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
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. Read more
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. Read more
sourceimpl<T> FromWorld for T where
T: Default,
impl<T> FromWorld for T where
T: Default,
sourcefn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Creates Self
using data from the given World
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,
impl<T> TypeData for T where
T: 'static + Send + Sync + Clone,
fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more