Enum leafwing_input_manager::clashing_inputs::ClashStrategy

#[non_exhaustive]
pub enum ClashStrategy {
    PressAll,
    PrioritizeLongest,
    UseActionOrder,
}

How should clashing inputs by handled by an InputMap?

Inputs “clash” if and only if one UserInput is a strict subset of the other. By example:

• S and W: does not clash
• LControl + S and S: clashes
• S and S: does not clash
• LControl + S and LAlt + S: clashes
• LControl + S, LAlt + S and LControl + LAlt + S: clashes

This strategy is only used when assessing the actions and input holistically, in InputMap::which_pressed, using InputMap::handle_clashes.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

PressAll

All matching inputs will always be pressed

PrioritizeLongest

Only press the action that corresponds to the longest chord

This is the default strategy.

UseActionOrder

Use the order in which actions are defined in the enum to resolve clashing inputs

Uses the iteration order returned by Actionlike::variants(), which is generated in order of the enum items by the #[derive(Actionlike)] macro.

Trait Implementations

impl Clone for ClashStrategy

fn clone(&self) -> ClashStrategy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClashStrategy

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

Formats the value using the given formatter.

impl Default for ClashStrategy

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ClashStrategy

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<ClashStrategy> for ClashStrategy

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

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

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.

impl Serialize for ClashStrategy

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

Serialize this value into the given Serde serializer.

impl Copy for ClashStrategy

impl Eq for ClashStrategy

impl StructuralEq for ClashStrategy

impl StructuralPartialEq for ClashStrategy