add warning to FpsOverlayPlugin

bevyengine · Mar 9, 2024 · 140433f · 140433f
1 parent 4dba1aa
commit 140433f
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/crates/bevy_dev_tools/src/fps_overlay.rs b/crates/bevy_dev_tools/src/fps_overlay.rs
@@ -13,6 +13,7 @@ use bevy_ui::node_bundles::TextBundle;
 
 #[derive(Default)]
 /// A plugin that adds an FPS overlay to the Bevy application.
+/// Warning: This plugin will add [`FrameTimeDiagnosticsPlugin`] if it wasn't added before.
 pub struct FpsOverlayPlugin {
     /// Starting configuration of overlay, this can be later be changed through `[FpsOverlayConfig]` resource.
     pub config: FpsOverlayConfig,