mirror of
https://github.com/bevyengine/bevy
synced 2024-12-24 12:03:14 +00:00
d70595b667
# Objective - Fixes #6370 - Closes #6581 ## Solution - Added the following lints to the workspace: - `std_instead_of_core` - `std_instead_of_alloc` - `alloc_instead_of_core` - Used `cargo +nightly fmt` with [item level use formatting](https://rust-lang.github.io/rustfmt/?version=v1.6.0&search=#Item%5C%3A) to split all `use` statements into single items. - Used `cargo clippy --workspace --all-targets --all-features --fix --allow-dirty` to _attempt_ to resolve the new linting issues, and intervened where the lint was unable to resolve the issue automatically (usually due to needing an `extern crate alloc;` statement in a crate root). - Manually removed certain uses of `std` where negative feature gating prevented `--all-features` from finding the offending uses. - Used `cargo +nightly fmt` with [crate level use formatting](https://rust-lang.github.io/rustfmt/?version=v1.6.0&search=#Crate%5C%3A) to re-merge all `use` statements matching Bevy's previous styling. - Manually fixed cases where the `fmt` tool could not re-merge `use` statements due to conditional compilation attributes. ## Testing - Ran CI locally ## Migration Guide The MSRV is now 1.81. Please update to this version or higher. ## Notes - This is a _massive_ change to try and push through, which is why I've outlined the semi-automatic steps I used to create this PR, in case this fails and someone else tries again in the future. - Making this change has no impact on user code, but does mean Bevy contributors will be warned to use `core` and `alloc` instead of `std` where possible. - This lint is a critical first step towards investigating `no_std` options for Bevy. --------- Co-authored-by: François Mockers <francois.mockers@vleue.com>
122 lines
3.9 KiB
Rust
122 lines
3.9 KiB
Rust
use crate::ButtonInput;
|
|
use bevy_ecs::system::Res;
|
|
use core::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)),
|
|
);
|
|
}
|
|
}
|