Struct InputAction 

pub struct InputAction {
    pub name: String,
    pub keys: Vec<KeyCode>,
    pub mouse_buttons: Vec<MouseButton>,
    pub positive_axis: Vec<(u32, f32)>,
    pub negative_axis: Vec<(u32, f32)>,
    pub gamepad_buttons: Vec<u32>,
}

A named input action that can be bound to multiple keys/buttons.

Example

let mut jump = InputAction::new("jump");
jump.bind_key(KeyCode::Space);
jump.bind_key(KeyCode::Up);
jump.bind_mouse(MouseButton::Left);

// In update:
if jump.is_pressed(&ctx.input) { player.jump(); }

Fields

name: String

Human-readable name.

keys: Vec<KeyCode>

Bound keyboard keys.

mouse_buttons: Vec<MouseButton>

Bound mouse buttons.

positive_axis: Vec<(u32, f32)>

Positive gamepad axis + threshold (axis_index, threshold).

negative_axis: Vec<(u32, f32)>

Negative gamepad axis + threshold.

gamepad_buttons: Vec<u32>

Gamepad buttons.

Implementations

impl InputAction

pub fn new(name: &str) -> Self

Create a new named input action.

Examples found in repository

examples/basics.rs (line 36)

    fn on_enter(&mut self, ctx: &mut Context) {
        // Register input actions
        let mut jump = InputAction::new("shake");
        jump.bind_key(KeyCode::Space);
        ctx.input.register_action(jump);

        // Set up camera with follow
        ctx.graphics.camera.follow(self.ball.position, 0.05);
    }

pub fn bind_key(&mut self, key: KeyCode) -> &mut Self

Bind a keyboard key to this action.

Examples found in repository

examples/basics.rs (line 37)

    fn on_enter(&mut self, ctx: &mut Context) {
        // Register input actions
        let mut jump = InputAction::new("shake");
        jump.bind_key(KeyCode::Space);
        ctx.input.register_action(jump);

        // Set up camera with follow
        ctx.graphics.camera.follow(self.ball.position, 0.05);
    }

pub fn bind_mouse(&mut self, button: MouseButton) -> &mut Self

Bind a mouse button to this action.

pub fn is_down(&self, input: &InputState) -> bool

Check if this action is currently active (held).

pub fn is_pressed(&self, input: &InputState) -> bool

Check if this action was just activated (pressed edge).

Trait Implementations

impl Clone for InputAction

fn clone(&self) -> InputAction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InputAction

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

Formats the value using the given formatter.