Enum leafwing_input_manager::buttonlike::ButtonState

source · [−]

pub enum ButtonState {
    JustPressed,
    Pressed,
    JustReleased,
    Released,
}

Expand description

The current state of a particular button, usually corresponding to a single [Actionlike] action.

By default, buttons are ButtonState::Released.

Variants

`JustPressed`

The button was pressed since the most recent tick

`Pressed`

This button is currently pressed (and was pressed before the most recent tick)

`JustReleased`

The button was released since the most recent tick

`Released`

This button is currently released (and was released before the most recent tick)

Implementations

source

impl ButtonState

source

pub fn tick(&mut self)

Causes just_pressed and just_released to become false

JustPressed becomes Pressed and JustReleased becomes Released

source

pub fn press(&mut self)

Presses the button

It will be JustPressed, unless it was already Pressed

source

pub fn release(&mut self)

Releases the button

It will be JustReleased, unless it was already Released

source

pub fn pressed(&self) -> bool

Is the button currently pressed?

source

pub fn released(&self) -> bool

Is the button currently released?

source

pub fn just_pressed(&self) -> bool

Was the button pressed since the last time [ActionState::update] was called?

source

pub fn just_released(&self) -> bool

Was the button released since the last time [ActionState::update] was called?

Trait Implementations

source

impl Clone for ButtonState

source

fn clone(&self) -> ButtonState

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for ButtonState

source

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

Formats the value using the given formatter. Read more

source

impl Default for ButtonState

source

fn default() -> Self

Returns the “default value” for a type. Read more

source

impl<'de> Deserialize<'de> for ButtonState

source

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 Hash for ButtonState

source

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more

1.3.0 · source

fn hash_slice<H>(data: &[Self], state: &mut H)where
H: Hasher,

Feeds a slice of this type into the given Hasher. Read more

source

impl PartialEq<ButtonState> for ButtonState

source

fn eq(&self, other: &ButtonState) -> bool

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

const fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

source

impl Serialize for ButtonState

source

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
S: Serializer,

Serialize this value into the given Serde serializer. Read more

source

impl StructuralPartialEq for ButtonState

Auto Trait Implementations

impl RefUnwindSafe for ButtonState

impl Send for ButtonState

impl Sync for ButtonState

impl Unpin for ButtonState

impl UnwindSafe for ButtonState

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T, U> AsBindGroupShaderType for Twhere
U: ShaderType,
&'a T: for<'a> Into,

fn as_bind_group_shader_type(
&self,
_images: &HashMap<Handle<Image>, <Image as RenderAsset>::PreparedAsset, RandomState, Global>
) -> U

Return the T [ShaderType] for self. When used in [AsBindGroup] derives, it is safe to assume that all images in self exist. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CallHasher for Twhere
T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64where
H: Hash + ?Sized,
B: BuildHasher,

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

impl<T> Downcast for Twhere
T: Any,

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>

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)

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)

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

impl<T> DowncastSync for Twhere
T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

impl<T> DynEq for Twhere
T: Any + Eq,

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

fn dyn_eq(&self, other: &(dyn DynEq + 'static)) -> bool

impl<T> DynHash for Twhere
T: DynEq + Hash,

fn as_dyn_eq(&self) -> &(dyn DynEq + 'static)

fn dyn_hash(&self, state: &mut dyn Hasher)

source

impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

source

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FromWorld for Twhere
T: Default,

fn from_world(_world: &mut World) -> T

Creates Self using data from the given [World]

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Serialize for Twhere
T: Serialize + ?Sized,

source

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<Ok, Error>

source

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<T> TypeData for Twhere
T: 'static + Send + Sync + Clone,

fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>

impl<T> Upcast<T> for T

fn upcast(&self) -> Option<&T>

source

impl<T> WithSubscriber for T

source

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

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

source

Enum leafwing_input_manager::buttonlike::ButtonState

Variants

JustPressed

Pressed

JustReleased

Released

Implementations

impl ButtonState

pub fn tick(&mut self)

pub fn press(&mut self)

pub fn release(&mut self)

pub fn pressed(&self) -> bool

pub fn released(&self) -> bool

pub fn just_pressed(&self) -> bool

pub fn just_released(&self) -> bool

Trait Implementations

impl Clone for ButtonState

fn clone(&self) -> ButtonState

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

impl Debug for ButtonState

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

impl Default for ButtonState

fn default() -> Self

impl<'de> Deserialize<'de> for ButtonState

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

impl Hash for ButtonState

fn hash<__H: Hasher>(&self, state: &mut __H)

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher,

impl PartialEq<ButtonState> for ButtonState

fn eq(&self, other: &ButtonState) -> bool

const fn ne(&self, other: &Rhs) -> bool

impl Serialize for ButtonState

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

impl Copy for ButtonState

impl Eq for ButtonState

impl StructuralEq for ButtonState

impl StructuralPartialEq for ButtonState

Auto Trait Implementations

impl RefUnwindSafe for ButtonState

impl Send for ButtonState

impl Sync for ButtonState

impl Unpin for ButtonState

impl UnwindSafe for ButtonState

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T, U> AsBindGroupShaderType<U> for Twhere U: ShaderType, &'a T: for<'a> Into<U>,

fn as_bind_group_shader_type( &self, _images: &HashMap<Handle<Image>, <Image as RenderAsset>::PreparedAsset, RandomState, Global>) -> U

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CallHasher for Twhere T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64where H: Hash + ?Sized, B: BuildHasher,

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

impl<T> Downcast for Twhere T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

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

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

impl<T> DowncastSync for Twhere T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync + 'static>

impl<T> DynEq for Twhere T: Any + Eq,

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

fn dyn_eq(&self, other: &(dyn DynEq + 'static)) -> bool

impl<T> DynHash for Twhere T: DynEq + Hash,

fn as_dyn_eq(&self) -> &(dyn DynEq + 'static)

fn dyn_hash(&self, state: &mut dyn Hasher)

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> FromWorld for Twhere T: Default,

fn from_world(_world: &mut World) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

`JustPressed`

`Pressed`

`JustReleased`

`Released`

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
__D: Deserializer<'de>,

fn hash<H: Hasher>(&self, state: &mut H)

fn hash_slice<H>(data: &[Self], state: &mut H)where
H: Hasher,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>where
S: Serializer,

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T, U> AsBindGroupShaderType<U> for Twhere
U: ShaderType,
&'a T: for<'a> Into<U>,

fn as_bind_group_shader_type(
&self,
_images: &HashMap<Handle<Image>, <Image as RenderAsset>::PreparedAsset, RandomState, Global>
) -> U

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T> CallHasher for Twhere
T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64where
H: Hash + ?Sized,
B: BuildHasher,

impl<T> Downcast for Twhere
T: Any,

impl<T> DowncastSync for Twhere
T: Any + Send + Sync,

impl<T> DynEq for Twhere
T: Any + Eq,

impl<T> DynHash for Twhere
T: DynEq + Hash,

impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

impl<T> FromWorld for Twhere
T: Default,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T> Serialize for Twhere
T: Serialize + ?Sized,

impl<T> ToOwned for Twhere
T: Clone,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

impl<T> TypeData for Twhere
T: 'static + Send + Sync + Clone,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,

impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,

impl<T> Event for Twhere
T: 'static + Send + Sync,

impl<T> Resource for Twhere
T: 'static + Send + Sync,

impl<T> StateData for Twhere
T: 'static + Send + Sync + Clone + Eq + Debug + Hash,