Struct bevy::input::Input [−]
pub struct Input<T> { /* fields omitted */ }
Expand description
A “press-able” input of type T
.
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.
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.
Notes when adding this resource for a new input type
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
pub fn press(&mut self, input: T)
pub fn press(&mut self, input: T)
Register a press for input input
.
pub fn any_pressed(&self, inputs: impl IntoIterator<Item = T>) -> bool
pub fn any_pressed(&self, inputs: impl IntoIterator<Item = T>) -> bool
Check if any item in inputs
has been pressed.
pub fn release(&mut self, input: T)
pub fn release(&mut self, input: T)
Register a release for input input
.
pub fn just_pressed(&self, input: T) -> bool
pub fn just_pressed(&self, input: T) -> bool
Check if input
has been just pressed.
pub fn any_just_pressed(&self, inputs: impl IntoIterator<Item = T>) -> bool
pub fn any_just_pressed(&self, inputs: impl IntoIterator<Item = T>) -> bool
Check if any item in inputs
has just been pressed.
pub fn clear_just_pressed(&mut self, input: T) -> bool
pub fn clear_just_pressed(&mut self, input: T) -> bool
Clear the “just pressed” state of input
. Future calls to Input::just_pressed
for the
given input will return false until a new press event occurs.
Returns true if input
is currently “just pressed”
pub fn just_released(&self, input: T) -> bool
pub fn just_released(&self, input: T) -> bool
Check if input
has been just released.
pub fn any_just_released(&self, inputs: impl IntoIterator<Item = T>) -> bool
pub fn any_just_released(&self, inputs: impl IntoIterator<Item = T>) -> bool
Check if any item in inputs
has just been released.
pub fn clear_just_released(&mut self, input: T) -> bool
pub fn clear_just_released(&mut self, input: T) -> bool
Clear the “just released” state of input
. Future calls to Input::just_released
for the
given input will return false until a new release event occurs.
Returns true if input
is currently “just released”
pub fn reset(&mut self, input: T)
pub fn reset(&mut self, input: T)
Reset all status for input input
.
pub fn clear(&mut self)
pub fn clear(&mut self)
Clear just pressed and just released information.
pub fn get_pressed(&self) -> impl ExactSizeIterator
pub fn get_pressed(&self) -> impl ExactSizeIterator
List all inputs that are pressed.
pub fn get_just_pressed(&self) -> impl ExactSizeIterator
pub fn get_just_pressed(&self) -> impl ExactSizeIterator
List all inputs that are just pressed.
pub fn get_just_released(&self) -> impl ExactSizeIterator
pub fn get_just_released(&self) -> impl ExactSizeIterator
List all inputs that are just released.
Trait Implementations
Auto Trait Implementations
impl<T> RefUnwindSafe for Input<T> where
T: RefUnwindSafe,
impl<T> UnwindSafe for Input<T> where
T: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: 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
. Read more
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
pub 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
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
pub 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
pub fn from_world(_world: &mut World) -> T
pub fn from_world(_world: &mut World) -> T
Creates Self
using data from the given World
fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
pub fn vzip(self) -> V
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more