Struct leafwing_input_manager::user_input::MutableInputStreams

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

A mutable collection of Input structs, which can be used for mocking user inputs.

Each of these streams is optional; if a stream does not exist, inputs sent to them will be ignored.

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

Fields

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

An optional GamepadButton Input stream

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

An optional KeyCode Input stream

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

An optional MouseButton Input stream

associated_gamepad: Option<Gamepad>

The Gamepad that this struct will detect inputs from

Implementations

impl<'a> MutableInputStreams<'a>

pub fn send_user_input(&mut self, input: impl Into<UserInput>)

Send the specified user_input directly, using the specified gamepad

Called by the methods of MockInput.

pub fn release_user_input(&mut self, input: impl Into<UserInput>)

Releases the specified user_input directly, using the specified gamepad

Called by the methods of MockInput.

Trait Implementations

impl<'a> Debug for MutableInputStreams<'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.