Struct ButtonlikeChord

pub struct ButtonlikeChord(/* private fields */);

A combined input that groups multiple Buttonlikes together, allowing you to define complex input combinations like hotkeys, shortcuts, and macros.

A chord is pressed only if all its constituent buttons are pressed simultaneously.

Adding duplicate buttons within a chord will ignore the extras, preventing redundant data fetching from multiple instances of the same input.

use bevy::prelude::*;
use bevy::input::InputPlugin;
use leafwing_input_manager::plugin::{AccumulatorPlugin, CentralInputStorePlugin};
use leafwing_input_manager::prelude::*;
use leafwing_input_manager::user_input::testing_utils::FetchUserInput;

let mut app = App::new();
app.add_plugins((InputPlugin, AccumulatorPlugin, CentralInputStorePlugin));

// Define a chord using A and B keys
let input = ButtonlikeChord::new([KeyCode::KeyA, KeyCode::KeyB]);

// Pressing only one key doesn't activate the input
KeyCode::KeyA.press(app.world_mut());
app.update();
assert!(!app.read_pressed(input.clone()));

// Pressing both keys activates the input
KeyCode::KeyA.press(app.world_mut());
KeyCode::KeyB.press(app.world_mut());
app.update();
assert!(app.read_pressed(input.clone()));

Implementations

impl ButtonlikeChord

pub fn new<U: Buttonlike>(inputs: impl IntoIterator<Item = U>) -> Self

Creates a ButtonlikeChord from multiple Buttonlikes, avoiding duplicates. Note that all elements within the iterator must be of the same type (homogeneous). You can still use other methods to add different types of inputs into the chord.

pub fn from_single(input: impl Buttonlike) -> Self

Creates a ButtonlikeChord that only contains the given Buttonlike. You can still use other methods to add different types of inputs into the chord.

pub fn modified(modifier: ModifierKey, input: impl Buttonlike) -> Self

Creates a ButtonlikeChord that combines the provided modifier and the given Buttonlike.

pub fn with(self, input: impl Buttonlike) -> Self

Adds the given Buttonlike into this chord, avoiding duplicates.

pub fn with_multiple<U: Buttonlike>( self, inputs: impl IntoIterator<Item = U>, ) -> Self

Adds multiple Buttonlikes into this chord, avoiding duplicates. Note that all elements within the iterator must be of the same type (homogeneous).

Trait Implementations

impl Buttonlike for ButtonlikeChord

fn pressed(&self, input_store: &CentralInputStore, gamepad: Gamepad) -> bool

Checks if all the inner inputs within the chord are active simultaneously.

fn press(&self, world: &mut World)

Simulates a press of the buttonlike input by sending the appropriate event.

fn release(&self, world: &mut World)

Simulates a release of the buttonlike input by sending the appropriate event.

fn press_as_gamepad(&self, world: &mut World, gamepad: Option<Gamepad>)

Simulate a press of the buttonlike input, pretending to be the provided Gamepad.

fn release_as_gamepad(&self, world: &mut World, gamepad: Option<Gamepad>)

Simulate a release of the buttonlike input, pretending to be the provided Gamepad.

fn released(&self, input_store: &CentralInputStore, gamepad: Gamepad) -> bool

Checks if the input is currently inactive.

impl Clone for ButtonlikeChord

fn clone(&self) -> ButtonlikeChord

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ButtonlikeChord

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

Formats the value using the given formatter.

impl Default for ButtonlikeChord

fn default() -> ButtonlikeChord

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ButtonlikeChord

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<U: Buttonlike> FromIterator<U> for ButtonlikeChord

fn from_iter<T: IntoIterator<Item = U>>(iter: T) -> Self

Creates a ButtonlikeChord from an iterator over multiple Buttonlikes, avoiding duplicates. Note that all elements within the iterator must be of the same type (homogeneous). You can still use other methods to add different types of inputs into the chord.

impl FromReflect for ButtonlikeChord

where Self: Any + Send + Sync, Vec<Box<dyn Buttonlike>>: FromReflect + TypePath + RegisterForReflection,

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>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for ButtonlikeChord

where Self: Any + Send + Sync, Vec<Box<dyn Buttonlike>>: FromReflect + TypePath + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl Hash for ButtonlikeChord

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ButtonlikeChord

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Reflect for ButtonlikeChord

where Self: Any + Send + Sync, Vec<Box<dyn Buttonlike>>: FromReflect + TypePath + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

fn try_apply(&mut self, value: &dyn Reflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>

Returns a “partial equality” comparison result.

fn apply(&mut self, value: &(dyn Reflect + 'static))

Applies a reflected value to this value.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

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

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl<'de> RegisterTypeTag<'de, dyn Buttonlike> for ButtonlikeChord

fn register_typetag(registry: &mut InfallibleMapRegistry<dyn Buttonlike>)

Registers the specified type tag into the InfallibleMapRegistry.

impl Serialize for ButtonlikeChord

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TupleStruct for ButtonlikeChord

where Self: Any + Send + Sync, Vec<Box<dyn Buttonlike>>: FromReflect + TypePath + RegisterForReflection,

fn field(&self, index: usize) -> Option<&dyn Reflect>

Returns a reference to the value of the field with index index as a &dyn Reflect.

fn field_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.

fn field_len(&self) -> usize

Returns the number of fields in the tuple struct.

fn iter_fields(&self) -> TupleStructFieldIter<'_>

Returns an iterator over the values of the tuple struct’s fields.

fn clone_dynamic(&self) -> DynamicTupleStruct

Clones the struct into a DynamicTupleStruct.

impl TypePath for ButtonlikeChord

where Self: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for ButtonlikeChord

where Self: Any + Send + Sync, Vec<Box<dyn Buttonlike>>: FromReflect + TypePath + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl UserInput for ButtonlikeChord

fn kind(&self) -> InputControlKind

ButtonlikeChord acts as a virtual button.

fn decompose(&self) -> BasicInputs

Retrieves a list of simple, atomic Buttonlikes that compose the chord.

The length of the basic inputs is the sum of the lengths of the inner inputs.

impl Eq for ButtonlikeChord

impl StructuralPartialEq for ButtonlikeChord