Struct ark_api::applet::input::InputManager

pub struct InputManager { /* private fields */ }

Use this in your module to help with input filtering and tracking.

Implementations

impl InputManager

pub fn state(&self) -> State

Current state of modifier keys etc.

pub fn events(&self) -> impl Iterator<Item = &(State, Event)>

Events that came in during the last call to update. Each event comes with a State which can be used to check e.g. modifier keys and mouse position at the time of the event.

pub fn down_keys(&self) -> impl Iterator<Item = &Key> + '_

Keys that are currently down.

pub fn down_gamepad_buttons(&self) -> impl Iterator<Item = &GamepadButton> + '_

Gamepad buttons that are currently down.

pub fn is_key_down(&self, key: Key) -> bool

Is the key currently down?

pub fn is_gamepad_button_down(&self, button: GamepadButton) -> bool

Is the gamepad button currently down?

pub fn was_key_pressed(&self, modifiers: Modifiers, key_needle: Key) -> bool

Did the key go from not down to down in this frame? Also filters on modifies so you can check for e.g. Cmd + Key::U.

pub fn was_command_made(&self, command_needle: Command) -> bool

Was e.g. Command::Paste issued this frame?

pub fn update(&mut self, applet: &Applet)

Call this or Self::update_for_player once at the start of each frame.

pub fn update_for_player(&mut self, applet: &Applet, player_id: u64)

Call this or Self::update once at the start of each frame.

Trait Implementations

impl Clone for InputManager

fn clone(&self) -> InputManager

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InputManager

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

Formats the value using the given formatter.

impl Default for InputManager

fn default() -> InputManager

Returns the “default value” for a type.

impl PartialEq<InputManager> for InputManager

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

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

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 StructuralPartialEq for InputManager