From 91f2b5108359c308271f10ce710f575feba3043d Mon Sep 17 00:00:00 2001 From: David Taralla Date: Mon, 25 Apr 2022 17:40:44 +0000 Subject: [PATCH] Document that AppExit can be read by Bevy apps (#4587) Explain it's safe to subscribe to this event to detect an exit before it happens. For instance, to clean-up and release system resources. --- crates/bevy_app/src/app.rs | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/crates/bevy_app/src/app.rs b/crates/bevy_app/src/app.rs index 67dad6fc2b..fe48094497 100644 --- a/crates/bevy_app/src/app.rs +++ b/crates/bevy_app/src/app.rs @@ -920,6 +920,11 @@ fn run_once(mut app: App) { app.update(); } -/// An event that indicates the [`App`] should exit. This will fully exit the app process. +/// An event that indicates the [`App`] should exit. This will fully exit the app process at the +/// start of the next tick of the schedule. +/// +/// You can also use this event to detect that an exit was requested. In order to receive it, systems +/// subscribing to this event should run after it was emitted and before the schedule of the same +/// frame is over. #[derive(Debug, Clone, Default)] pub struct AppExit;