From 06360b4fe853628568b3a0b76983add9e0a8c5c7 Mon Sep 17 00:00:00 2001 From: kdecay Date: Mon, 18 Apr 2022 19:21:26 +0200 Subject: [PATCH] Update system.rs docs --- crates/bevy_input/src/system.rs | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/crates/bevy_input/src/system.rs b/crates/bevy_input/src/system.rs index 018c47794b4e1..753115bdebcdb 100644 --- a/crates/bevy_input/src/system.rs +++ b/crates/bevy_input/src/system.rs @@ -1,11 +1,13 @@ -use crate::{ - keyboard::{KeyCode, KeyboardInput}, - ElementState, -}; +use crate::{ElementState, KeyCode, KeyboardInput}; use bevy_app::AppExit; use bevy_ecs::prelude::{EventReader, EventWriter}; -/// Sends the `AppExit` event whenever the "esc" key is pressed. +/// Sends an [`AppExit`] event whenever the `ESC` key is pressed. +/// +/// ## Note +/// +/// This system is not added as part of the `DefaultPlugins`. You can add the [`exit_on_esc_system`] +/// yourself if desired. pub fn exit_on_esc_system( mut keyboard_input_events: EventReader, mut app_exit_events: EventWriter,