cd8dccb8b2
# Objective Rust analyzer kept complaining about a cyclic dependency due to `bevy_input` having a dev-dependency on `bevy`. `bevy_input` was also missing `bevy_reflect`'s "smol_str" feature which it needs to compile on its own. Fixes #10256 ## Solution Remove the dev-dependency on `bevy` from `bevy_input` since it was only used to reduce imports for 1 test and 3 doc examples by 1 line each, as `bevy_input` already has dependencies on everything needed for those tests and doctests to work. Add `bevy_reflect`'s "smol_str" feature to `bevy_input`'s dependency list as it needs it to actually compile.
124 lines
3.9 KiB
Rust
124 lines
3.9 KiB
Rust
use crate::ButtonInput;
|
|
use bevy_ecs::system::Res;
|
|
use std::hash::Hash;
|
|
|
|
/// Stateful run condition that can be toggled via a input press using [`ButtonInput::just_pressed`].
|
|
///
|
|
/// ```no_run
|
|
/// # use bevy_app::{App, NoopPluginGroup as DefaultPlugins, Update};
|
|
/// # use bevy_ecs::prelude::IntoSystemConfigs;
|
|
/// # use bevy_input::{common_conditions::input_toggle_active, prelude::KeyCode};
|
|
///
|
|
/// fn main() {
|
|
/// App::new()
|
|
/// .add_plugins(DefaultPlugins)
|
|
/// .add_systems(Update, pause_menu.run_if(input_toggle_active(false, KeyCode::Escape)))
|
|
/// .run();
|
|
/// }
|
|
///
|
|
/// fn pause_menu() {
|
|
/// println!("in pause menu");
|
|
/// }
|
|
/// ```
|
|
///
|
|
/// If you want other systems to be able to access whether the toggled state is active,
|
|
/// you should use a custom resource or a state for that:
|
|
/// ```no_run
|
|
/// # use bevy_app::{App, NoopPluginGroup as DefaultPlugins, Update};
|
|
/// # use bevy_ecs::prelude::{IntoSystemConfigs, Res, ResMut, Resource};
|
|
/// # use bevy_input::{common_conditions::input_just_pressed, prelude::KeyCode};
|
|
///
|
|
/// #[derive(Resource, Default)]
|
|
/// struct Paused(bool);
|
|
///
|
|
/// fn main() {
|
|
/// App::new()
|
|
/// .add_plugins(DefaultPlugins)
|
|
/// .init_resource::<Paused>()
|
|
/// .add_systems(Update, toggle_pause_state.run_if(input_just_pressed(KeyCode::Escape)))
|
|
/// .add_systems(Update, pause_menu.run_if(|paused: Res<Paused>| paused.0))
|
|
/// .run();
|
|
/// }
|
|
///
|
|
/// fn toggle_pause_state(mut paused: ResMut<Paused>) {
|
|
/// paused.0 = !paused.0;
|
|
/// }
|
|
///
|
|
/// fn pause_menu() {
|
|
/// println!("in pause menu");
|
|
/// }
|
|
///
|
|
/// ```
|
|
pub fn input_toggle_active<T>(
|
|
default: bool,
|
|
input: T,
|
|
) -> impl FnMut(Res<ButtonInput<T>>) -> bool + Clone
|
|
where
|
|
T: Copy + Eq + Hash + Send + Sync + 'static,
|
|
{
|
|
let mut active = default;
|
|
move |inputs: Res<ButtonInput<T>>| {
|
|
active ^= inputs.just_pressed(input);
|
|
active
|
|
}
|
|
}
|
|
|
|
/// Run condition that is active if [`ButtonInput::pressed`] is true for the given input.
|
|
pub fn input_pressed<T>(input: T) -> impl FnMut(Res<ButtonInput<T>>) -> bool + Clone
|
|
where
|
|
T: Copy + Eq + Hash + Send + Sync + 'static,
|
|
{
|
|
move |inputs: Res<ButtonInput<T>>| inputs.pressed(input)
|
|
}
|
|
|
|
/// Run condition that is active if [`ButtonInput::just_pressed`] is true for the given input.
|
|
///
|
|
/// ```no_run
|
|
/// # use bevy_app::{App, NoopPluginGroup as DefaultPlugins, Update};
|
|
/// # use bevy_ecs::prelude::IntoSystemConfigs;
|
|
/// # use bevy_input::{common_conditions::input_just_pressed, prelude::KeyCode};
|
|
/// fn main() {
|
|
/// App::new()
|
|
/// .add_plugins(DefaultPlugins)
|
|
/// .add_systems(Update, jump.run_if(input_just_pressed(KeyCode::Space)))
|
|
/// .run();
|
|
/// }
|
|
///
|
|
/// # fn jump() {}
|
|
/// ```
|
|
pub fn input_just_pressed<T>(input: T) -> impl FnMut(Res<ButtonInput<T>>) -> bool + Clone
|
|
where
|
|
T: Copy + Eq + Hash + Send + Sync + 'static,
|
|
{
|
|
move |inputs: Res<ButtonInput<T>>| inputs.just_pressed(input)
|
|
}
|
|
|
|
/// Run condition that is active if [`ButtonInput::just_released`] is true for the given input.
|
|
pub fn input_just_released<T>(input: T) -> impl FnMut(Res<ButtonInput<T>>) -> bool + Clone
|
|
where
|
|
T: Copy + Eq + Hash + Send + Sync + 'static,
|
|
{
|
|
move |inputs: Res<ButtonInput<T>>| inputs.just_released(input)
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
use crate::prelude::KeyCode;
|
|
use bevy_ecs::schedule::{IntoSystemConfigs, Schedule};
|
|
|
|
fn test_system() {}
|
|
|
|
// Ensure distributive_run_if compiles with the common conditions.
|
|
#[test]
|
|
fn distributive_run_if_compiles() {
|
|
Schedule::default().add_systems(
|
|
(test_system, test_system)
|
|
.distributive_run_if(input_toggle_active(false, KeyCode::Escape))
|
|
.distributive_run_if(input_pressed(KeyCode::Escape))
|
|
.distributive_run_if(input_just_pressed(KeyCode::Escape))
|
|
.distributive_run_if(input_just_released(KeyCode::Escape)),
|
|
);
|
|
}
|
|
}
|