Enum leafwing_input_manager::clashing_inputs::BasicInputs

pub enum BasicInputs {
    None,
    Simple(Box<dyn Buttonlike>),
    Composite(Vec<Box<dyn Buttonlike>>),
    Chord(Vec<Box<dyn Buttonlike>>),
}

A flat list of the Buttonlike inputs that make up a UserInput.

This is used to check for potential clashes between actions, where one action is a strict subset of another.

Variants

None

No buttonlike inputs are involved.

This might be used for things like a joystick axis.

Simple(Box<dyn Buttonlike>)

The input consists of a single, fundamental Buttonlike UserInput.

For example, a single key press.

Composite(Vec<Box<dyn Buttonlike>>)

The input can be triggered by multiple independent Buttonlike UserInputs, but is still fundamentally considered a single input.

For example, a virtual D-Pad is only one input, but can be triggered by multiple keys.

Chord(Vec<Box<dyn Buttonlike>>)

The input represents one or more independent Buttonlike UserInput types.

For example, a chorded input is a group of multiple keys that must be pressed together.

Implementations

impl BasicInputs

pub fn inputs(&self) -> Vec<Box<dyn Buttonlike>>

Returns a list of the underlying Buttonlike UserInputs.

Warning

When checking for clashes, do not use this method to compute the length of the input. Instead, use BasicInputs::len, as these do not always agree.

pub fn compose(self, other: BasicInputs) -> Self

Create a BasicInputs::Composite from two existing BasicInputs.

pub fn len(&self) -> usize

Returns the number of the logical Buttonlike UserInputs that make up the input.

A single key press is one input, while a chorded input is multiple inputs. A composite input is still considered one input, even if it can be triggered by multiple keys, as only one input need actually be pressed.

pub fn clashes_with(&self, other: &BasicInputs) -> bool

Checks if the given two BasicInputs clash with each other.

Trait Implementations

impl Clone for BasicInputs

fn clone(&self) -> BasicInputs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BasicInputs

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

Formats the value using the given formatter.