leafwing-input-manager 0.21.0

A powerful, flexible and ergonomic way to manage action-input keybindings for the Bevy game engine.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

//! Run conditions for actions.
//!
//! Each run condition reads the [`ActionState<A>`] of a single entity via
//! [`Single`]. If no such entity exists (or more than one does), the
//! condition resolves as if the action were unpressed.

use crate::{Actionlike, prelude::ActionState};
use bevy::prelude::Single;

/// Stateful run condition that can be toggled via an action press using [`ActionState::just_pressed`].
pub fn action_toggle_active<A>(
    default: bool,
    action: A,
) -> impl for<'w, 's> FnMut(Option<Single<'w, 's, &'static ActionState<A>>>) -> bool
where
    A: Actionlike + Clone,
{
    move |action_state| action_state.is_some_and(|state| state.pressed(&action)) || default
}

/// Run condition that is active if [`ActionState::pressed`] is true for the given action.
pub fn action_pressed<A>(
    action: A,
) -> impl for<'w, 's> FnMut(Option<Single<'w, 's, &'static ActionState<A>>>) -> bool
where
    A: Actionlike + Clone,
{
    move |action_state| action_state.is_some_and(|state| state.pressed(&action))
}

/// Run condition that is active if [`ActionState::just_pressed`] is true for the given action.
pub fn action_just_pressed<A>(
    action: A,
) -> impl for<'w, 's> FnMut(Option<Single<'w, 's, &'static ActionState<A>>>) -> bool
where
    A: Actionlike + Clone,
{
    move |action_state| action_state.is_some_and(|state| state.just_pressed(&action))
}

/// Run condition that is active if [`ActionState::just_released`] is true for the given action.
pub fn action_just_released<A>(
    action: A,
) -> impl for<'w, 's> FnMut(Option<Single<'w, 's, &'static ActionState<A>>>) -> bool
where
    A: Actionlike + Clone,
{
    move |action_state| action_state.is_some_and(|state| state.just_released(&action))
}