Rework action keybinding (#243)

* Rework keybindings

* Reorder keybinding constructor parameters

Author: tim-blackbird

crates/bevy_editor/src/load_gltf.rs

@@ -14,7 +14,7 @@ impl Plugin for LoadGltfPlugin {
         app.init_resource::<GltfFilepickerTask>()
             .add_systems(Update, (poll_pick_gltf, file_dropped))
             .register_action("load-gltf", "Load GLTF", pick_gltf_action)
-            .register_action_binding("load-gltf", [KeyCode::ControlLeft, KeyCode::KeyL]);
+            .register_keybinding(Keybinding::new("load-gltf", KeyCode::KeyL).ctrl());
     }
 }
 

crates/bevy_editor_core/src/actions.rs

@@ -2,40 +2,16 @@
 
 use bevy::{ecs::system::SystemId, prelude::*};
 
-/// Editor selection plugin.
+/// Editor actions plugin.
 #[derive(Default)]
 pub struct ActionsPlugin;
 
 impl Plugin for ActionsPlugin {
     fn build(&self, app: &mut App) {
-        app.init_resource::<ActionRegistry>()
-            .init_resource::<ActionBindings>()
-            .add_systems(Update, run_actions_on_binding);
+        app.init_resource::<ActionRegistry>();
     }
 }
 
-fn run_actions_on_binding(world: &mut World) {
-    world.resource_scope(|world, mut bindings: Mut<ActionBindings>| {
-        world.resource_scope(|world, input: Mut<ButtonInput<KeyCode>>| {
-            // Sort by the invserse amount of keys in the binding so that simpler keybinds don't prevent more complex ones from triggering.
-            bindings.list.sort_by_key(|(v, _)| usize::MAX - v.len());
-            'outer: for (binding, action_id) in &bindings.list {
-                if let Some(last_key) = binding.last() {
-                    for key in &binding[..(binding.len() - 1)] {
-                        if !input.pressed(*key) {
-                            continue 'outer;
-                        }
-                    }
-                    if input.just_pressed(*last_key) {
-                        world.run_action(action_id);
-                        break 'outer;
-                    }
-                }
-            }
-        });
-    });
-}
-
 /// The registry for [`Action`]s
 #[derive(Resource, Default)]
 pub struct ActionRegistry {
@@ -68,24 +44,6 @@ impl ActionRegistry {
     }
 }
 
-/// List of keybindings to [`Action`]s
-#[derive(Resource, Default)]
-pub struct ActionBindings {
-    list: Vec<(Vec<KeyCode>, String)>,
-}
-
-impl ActionBindings {
-    /// Add a binding for an action.
-    pub fn add_binding(
-        &mut self,
-        action_id: impl Into<String>,
-        binding: impl IntoIterator<Item = KeyCode>,
-    ) {
-        self.list
-            .push((binding.into_iter().collect(), action_id.into()));
-    }
-}
-
 /// Defines some action with an id and a label for display.
 pub struct Action {
     id: String,
@@ -103,13 +61,6 @@ pub trait ActionAppExt {
         label: impl Into<String>,
         system: impl IntoSystem<(), (), M> + 'static,
     ) -> &mut Self;
-
-    /// Register an action binding.
-    fn register_action_binding(
-        &mut self,
-        action_id: impl Into<String>,
-        binding: impl IntoIterator<Item = KeyCode>,
-    ) -> &mut Self;
 }
 
 impl ActionAppExt for App {
@@ -125,17 +76,6 @@ impl ActionAppExt for App {
             .register(id, label, system_id);
         self
     }
-
-    fn register_action_binding(
-        &mut self,
-        action_id: impl Into<String>,
-        binding: impl IntoIterator<Item = KeyCode>,
-    ) -> &mut Self {
-        self.world_mut()
-            .get_resource_or_init::<ActionBindings>()
-            .add_binding(action_id, binding);
-        self
-    }
 }
 
 /// [`ActionRegistry`] extension trait for [`World`].

crates/bevy_editor_core/src/keybinding.rs

@@ -0,0 +1,137 @@
+//! Editor keybinding module.
+
+use bevy::prelude::*;
+
+use crate::actions::ActionWorldExt;
+
+/// Editor keybinding plugin.
+#[derive(Default)]
+pub struct KeybindingPlugin;
+
+impl Plugin for KeybindingPlugin {
+    fn build(&self, app: &mut App) {
+        app.init_resource::<Keybindings>()
+            .add_systems(Update, process_keybindings);
+    }
+}
+
+/// The store of keybindings.
+#[derive(Resource)]
+pub struct Keybindings {
+    list: Vec<Keybinding>,
+    /// Control whether keybindings are active.
+    pub enabled: bool,
+}
+
+impl Keybindings {
+    /// Add a keybinding to the list.
+    pub fn add_keybinding(&mut self, keybinding: Keybinding) {
+        self.list.push(keybinding);
+    }
+}
+
+impl Default for Keybindings {
+    fn default() -> Self {
+        Self {
+            list: Default::default(),
+            enabled: true,
+        }
+    }
+}
+
+/// A keybinding for an editor [`Action`](crate::actions::Action).
+///
+/// # Example
+/// This example binds the "load-gltf" action to <kbd>Ctrl</kbd> + <kbd>L</kbd>.
+/// ```no_run
+/// # use bevy_editor_core::prelude::*;
+/// # use bevy::prelude::*;
+/// # let mut app = App::new();
+/// app.register_keybinding(Keybinding::new("load-gltf", KeyCode::KeyL).ctrl());
+/// ```
+#[derive(Clone, Debug, Reflect)]
+pub struct Keybinding {
+    action_id: String,
+    key: KeyCode,
+    ctrl: bool,
+    shift: bool,
+    alt: bool,
+    os: bool,
+}
+
+impl Keybinding {
+    /// Create a new keybind from the id of the action it will be bound to and a keycode.
+    pub fn new(action_id: impl Into<String>, key: KeyCode) -> Self {
+        Self {
+            action_id: action_id.into(),
+            key,
+            ctrl: false,
+            shift: false,
+            alt: false,
+            os: false,
+        }
+    }
+
+    /// Require the <kbd>Ctrl</kbd> or <kbd>Control</kbd> modifier key to be held for this keybind.
+    pub fn ctrl(mut self) -> Self {
+        self.ctrl = true;
+        self
+    }
+
+    /// Require the <kbd>Shift</kbd> or <kbd>⇧</kbd> modifier key to be held for this keybind.
+    pub fn shift(mut self) -> Self {
+        self.shift = true;
+        self
+    }
+
+    /// Require the <kbd>Alt</kbd> or <kbd>Option</kbd> modifier key to be held for this keybind.
+    pub fn alt(mut self) -> Self {
+        self.alt = true;
+        self
+    }
+
+    /// Require the "Windows Logo" key or the <kbd>Command</kbd> or <kbd>⌘</kbd> modifier key to be held for this keybind.
+    pub fn os(mut self) -> Self {
+        self.os = true;
+        self
+    }
+}
+
+fn process_keybindings(world: &mut World) {
+    world.resource_scope(|world, bindings: Mut<Keybindings>| {
+        if !bindings.enabled {
+            return;
+        }
+        world.resource_scope(|world, input: Mut<ButtonInput<KeyCode>>| {
+            let ctrl = input.any_pressed([KeyCode::ControlLeft, KeyCode::ControlRight]);
+            let shift = input.any_pressed([KeyCode::ShiftLeft, KeyCode::ShiftRight]);
+            let alt = input.any_pressed([KeyCode::AltLeft, KeyCode::AltRight]);
+            let os = input.any_pressed([KeyCode::SuperLeft, KeyCode::SuperRight]);
+            for binding in &bindings.list {
+                if (!binding.ctrl || ctrl)
+                    && (!binding.alt || alt)
+                    && (!binding.shift || shift)
+                    && (!binding.os || os)
+                    && input.just_pressed(binding.key)
+                {
+                    world.run_action(&binding.action_id);
+                }
+            }
+        });
+    });
+}
+
+/// [`Keybindings`] extension trait for [`App`].
+pub trait KeybindingAppExt {
+    /// Register a keybinding for an action.
+    fn register_keybinding(&mut self, binding: Keybinding) -> &mut Self;
+}
+
+impl KeybindingAppExt for App {
+    fn register_keybinding(&mut self, binding: Keybinding) -> &mut Self {
+        self.world_mut()
+            .get_resource_or_init::<Keybindings>()
+            .add_keybinding(binding);
+        self
+    }
+}

crates/bevy_editor_core/src/lib.rs

@@ -1,17 +1,22 @@
 //! This crate provides core functionality for the Bevy Engine Editor.
 
 pub mod actions;
+pub mod keybinding;
 pub mod selection;
 pub mod utils;
 
 use bevy::prelude::*;
 
-use crate::{actions::ActionsPlugin, selection::SelectionPlugin, utils::CoreUtilsPlugin};
+use crate::{
+    actions::ActionsPlugin, keybinding::KeybindingPlugin, selection::SelectionPlugin,
+    utils::CoreUtilsPlugin,
+};
 
 /// Crate prelude.
 pub mod prelude {
     pub use crate::{
         actions::{ActionAppExt, ActionWorldExt},
+        keybinding::{Keybinding, KeybindingAppExt},
         selection::EditorSelection,
         utils::IntoBoxedScene,
     };
@@ -23,6 +28,11 @@ pub struct EditorCorePlugin;
 
 impl Plugin for EditorCorePlugin {
     fn build(&self, app: &mut App) {
-        app.add_plugins((ActionsPlugin, SelectionPlugin, CoreUtilsPlugin));
+        app.add_plugins((
+            ActionsPlugin,
+            KeybindingPlugin,
+            SelectionPlugin,
+            CoreUtilsPlugin,
+        ));
     }
 }