Struct leafwing_input_manager::user_input::InputStreams

pub struct InputStreams<'a> {
    pub gamepad: Option<&'a Input<GamepadButton>>,
    pub keyboard: Option<&'a Input<KeyCode>>,
    pub mouse: Option<&'a Input<MouseButton>>,
    pub associated_gamepad: Option<Gamepad>,
}

A collection of Input structs, which can be used to update an InputMap.

Each of these streams is optional; if a stream does not exist, it is treated as if it were entirely unpressed.

These are typically collected via a system from the World as resources.

Fields

gamepad: Option<&'a Input<GamepadButton>>

An optional GamepadButton Input stream

keyboard: Option<&'a Input<KeyCode>>

An optional KeyCode Input stream

mouse: Option<&'a Input<MouseButton>>

An optional MouseButton Input stream

associated_gamepad: Option<Gamepad>

The Gamepad that this struct will detect inputs from

Implementations

impl<'a> InputStreams<'a>

pub fn from_gamepad(
    gamepad_input_stream: &'a Input<GamepadButton>,
    associated_gamepad: Gamepad
) -> Self

Construct InputStreams with only a GamepadButton input stream

pub fn from_keyboard(keyboard_input_stream: &'a Input<KeyCode>) -> Self

Construct InputStreams with only a KeyCode input stream

pub fn from_mouse(mouse_input_stream: &'a Input<MouseButton>) -> Self

Construct InputStreams with only a GamepadButton input stream

impl<'a> InputStreams<'a>

pub fn input_pressed(&self, input: &UserInput) -> bool

Is the input matched by the InputStreams?

pub fn any_pressed(&self, inputs: &PetitSet<UserInput, 16>) -> bool

Is at least one of the inputs pressed?

pub fn button_pressed(&self, button: InputButton) -> bool

Is the button pressed?

pub fn all_buttons_pressed(&self, buttons: &PetitSet<InputButton, 8>) -> bool

Are all of the buttons pressed?

Trait Implementations

impl<'a> Clone for InputStreams<'a>

fn clone(&self) -> InputStreams<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for InputStreams<'a>

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

Formats the value using the given formatter.

impl<'a> From<MutableInputStreams<'a>> for InputStreams<'a>

fn from(mutable_streams: MutableInputStreams<'a>) -> Self

Converts to this type from the input type.