Incorrectly despawned inspect labels (#137)

* Adding names to entities for debugging purposes

* Despawning recursively to avoid lingering references in Children

bevy_magic_light_2d/src/gi/compositing.rs

@@ -161,6 +161,7 @@ pub fn setup_post_processing_quad<T: LightScene>(
     let layer = RenderLayers::layer(T::render_layer_index());
 
     cmd.spawn((
+        Name::new("PostProcessingQuad"),
         T::default(),
         PostProcessingQuad,
         MaterialMesh2dBundle {

common/story/src/dialog/fe/portrait.rs

@@ -598,7 +598,7 @@ impl PortraitDialog {
         camera: Entity,
         root: Entity,
     ) {
-        cmd.entity(camera).despawn();
+        cmd.entity(camera).despawn_recursive();
         cmd.entity(root).despawn_recursive();
         cmd.remove_resource::<PortraitDialog>();
 

common/story/src/emoji.rs

@@ -152,7 +152,7 @@ fn play_next(
                     first,
                     last: event.emoji.animation_last_frame(),
                     play: AtlasAnimationStep::Forward,
-                    on_last_frame: AtlasAnimationEnd::DespawnItself,
+                    on_last_frame: AtlasAnimationEnd::DespawnRecursiveItself,
                     extra_steps: event.emoji.extra_steps(),
                 })
                 .insert(AtlasAnimationTimer::new_fps(event.emoji.fps()));

common/visuals/src/camera.rs

@@ -10,6 +10,7 @@ use bevy::{
         query::With,
         system::{Commands, Query},
     },
+    hierarchy::DespawnRecursiveExt,
     render::{camera::Camera, view::RenderLayers},
     utils::default,
 };
@@ -92,5 +93,5 @@ pub fn spawn(mut cmd: Commands) {
 
 /// System to despawn 2D camera with component [`MainCamera`].
 pub fn despawn(mut cmd: Commands, camera: Query<Entity, With<MainCamera>>) {
-    cmd.entity(camera.single()).despawn();
+    cmd.entity(camera.single()).despawn_recursive();
 }

common/visuals/src/fps.rs

@@ -47,6 +47,7 @@ pub(crate) fn spawn(mut cmd: Commands) {
     // create our text
     let text_fps = cmd
         .spawn((
+            Name::new("FPS text"),
             FpsText,
             TextBundle {
                 // use two sections, so it is easy to update just the number

common/visuals/src/systems.rs

@@ -47,8 +47,8 @@ pub fn advance_atlas_animation(
                             AtlasAnimationStep::Backward => animation.last,
                         };
                     }
-                    AtlasAnimationEnd::DespawnItself => {
-                        cmd.entity(entity).despawn();
+                    AtlasAnimationEnd::DespawnRecursiveItself => {
+                        cmd.entity(entity).despawn_recursive();
                     }
                     AtlasAnimationEnd::RemoveTimer => {
                         cmd.entity(entity).remove::<AtlasAnimationTimer>();
@@ -218,8 +218,8 @@ pub fn interpolate(
                     Some(OnInterpolationFinished::Custom(fun)) => {
                         fun(&mut cmd);
                     }
-                    Some(OnInterpolationFinished::DespawnItself) => {
-                        cmd.entity(entity).despawn();
+                    Some(OnInterpolationFinished::DespawnRecursiveItself) => {
+                        cmd.entity(entity).despawn_recursive();
                     }
                     None => {}
                 }
@@ -267,8 +267,8 @@ pub fn interpolate(
                 Some(OnInterpolationFinished::Custom(fun)) => {
                     fun(&mut cmd);
                 }
-                Some(OnInterpolationFinished::DespawnItself) => {
-                    cmd.entity(entity).despawn();
+                Some(OnInterpolationFinished::DespawnRecursiveItself) => {
+                    cmd.entity(entity).despawn_recursive();
                 }
                 None => {}
             }
@@ -304,8 +304,8 @@ pub fn interpolate(
                 Some(OnInterpolationFinished::Custom(fun)) => {
                     fun(&mut cmd);
                 }
-                Some(OnInterpolationFinished::DespawnItself) => {
-                    cmd.entity(entity).despawn();
+                Some(OnInterpolationFinished::DespawnRecursiveItself) => {
+                    cmd.entity(entity).despawn_recursive();
                 }
                 None => {}
             }

common/visuals/src/types.rs

@@ -60,7 +60,7 @@ pub enum AtlasAnimationEnd {
     /// Keeps the entity visible and on the last frame.
     RemoveTimer,
     /// Despawns the animated entity.
-    DespawnItself,
+    DespawnRecursiveItself,
     /// Can optionally mutate state.
     Custom {
         /// The function to call when the last frame is reached.
@@ -162,7 +162,7 @@ pub struct BeginInterpolationEvent {
 #[derive(Clone)]
 pub(crate) enum OnInterpolationFinished {
     /// Despawn the entity.
-    DespawnItself,
+    DespawnRecursiveItself,
     /// Can schedule commands.
     Custom(Arc<dyn Fn(&mut Commands) + Send + Sync>),
 }
@@ -370,8 +370,8 @@ impl BeginInterpolationEvent {
     }
 
     /// Despawn the entity when interpolation is done.
-    pub fn when_finished_despawn_itself(self) -> Self {
-        self.when_finished(OnInterpolationFinished::DespawnItself)
+    pub fn when_finished_despawn_recursive_itself(self) -> Self {
+        self.when_finished(OnInterpolationFinished::DespawnRecursiveItself)
     }
 
     /// Any extra logic when interpolation is done?

main_game_lib/src/cutscene.rs

@@ -387,9 +387,9 @@ impl Cutscene {
                 trace!("Despawning cutscene");
                 cmd.remove_resource::<Cutscene>();
 
-                cmd.entity(entities[0]).despawn();
-                cmd.entity(entities[1]).despawn();
-                cmd.entity(entities[2]).despawn();
+                cmd.entity(entities[0]).despawn_recursive();
+                cmd.entity(entities[1]).despawn_recursive();
+                cmd.entity(entities[2]).despawn_recursive();
             })
             .insert(cmd);
         } else {

main_game_lib/src/hud.rs

@@ -20,10 +20,8 @@ impl bevy::app::Plugin for Plugin {
 
         #[cfg(feature = "devtools")]
         {
-            use bevy_inspector_egui::quick::ResourceInspectorPlugin;
-
             app.register_type::<daybar::DayBar>()
-                .add_plugins(ResourceInspectorPlugin::<daybar::DayBar>::new());
+                .add_systems(Update, daybar::change_progress);
         }
     }
 }

main_game_lib/src/hud/daybar.rs

@@ -3,6 +3,7 @@
 //!
 //! See wiki for more information about day progress.
 
+use bevy::ui::RelativeCursorPosition;
 use common_ext::QueryExt;
 use common_visuals::camera::MainCamera;
 
@@ -23,6 +24,11 @@ pub enum IncreaseDayBarEvent {
     ChangedScene,
     /// Finished meditating.
     Meditated,
+    /// Sets the daybar progress to 0.
+    Reset,
+    /// Custom amount of increase in the day bar.
+    /// The final progress is clamped between 0 and 1.
+    Custom(f32),
 }
 
 /// What sort of things are dependent on status of the daybar.
@@ -47,6 +53,8 @@ pub(crate) fn spawn(
         Name::new("DayBar"),
         DayBarRoot,
         TargetCamera(camera.single()),
+        Interaction::default(),
+        RelativeCursorPosition::default(),
         NodeBundle {
             style: Style {
                 position_type: PositionType::Absolute,
@@ -97,12 +105,35 @@ pub(crate) fn increase(
         let amount = match event {
             IncreaseDayBarEvent::ChangedScene => 0.01,
             IncreaseDayBarEvent::Meditated => 0.05,
+            IncreaseDayBarEvent::Custom(amount) => *amount,
+            IncreaseDayBarEvent::Reset => -daybar.progress,
         };
 
         daybar.progress = (daybar.progress + amount).clamp(0.0, 1.0);
+    }
+
+    if let Some(mut progress) = progress.get_single_mut_or_none() {
+        progress.width = Val::Percent(daybar.progress * 100.0);
+    }
+}
+
+#[cfg(feature = "devtools")]
+pub(crate) fn change_progress(
+    mut events: EventWriter<IncreaseDayBarEvent>,
+
+    root: Query<
+        (&Interaction, &RelativeCursorPosition),
+        (Changed<Interaction>, With<DayBarRoot>),
+    >,
+) {
+    for (interaction, cursor_position) in root.iter() {
+        if !matches!(interaction, Interaction::Pressed) {
+            continue;
+        }
 
-        if let Some(mut progress) = progress.get_single_mut_or_none() {
-            progress.width = Val::Percent(daybar.progress * 100.0);
+        if let Some(position) = cursor_position.normalized {
+            events.send(IncreaseDayBarEvent::Reset);
+            events.send(IncreaseDayBarEvent::Custom(position.x));
         }
     }
 }
@@ -122,7 +153,7 @@ impl DayBar {
     /// Whether it's time for something to happen.
     pub fn is_it_time_for(&self, what: DayBarDependent) -> bool {
         let range = match what {
-            DayBarDependent::MallOpenHours => 0.05..0.75,
+            DayBarDependent::MallOpenHours => ..0.75,
         };
 
         range.contains(&self.progress)

main_game_lib/src/rscn.rs

@@ -26,11 +26,13 @@ use std::borrow::Cow;
 
 use bevy::{
     asset::{Asset, AssetServer, Assets, Handle},
+    core::Name,
     ecs::{
         component::Component,
         entity::Entity,
         system::{Commands, Query, Res},
     },
+    hierarchy::DespawnRecursiveExt,
     math::{Rect, Vec2},
     reflect::TypePath,
     render::color::Color,
@@ -205,7 +207,7 @@ pub fn start_loading_tscn<T: TscnInBevy>(
     mut cmd: Commands,
     asset_server: Res<AssetServer>,
 ) {
-    let mut e = cmd.spawn_empty();
+    let mut e = cmd.spawn(Name::new(".tscn tree handle"));
     e.insert(TscnTreeHandle::<T> {
         entity: e.id(),
         handle: Some(asset_server.load(T::tscn_asset_path())),
@@ -239,7 +241,7 @@ impl<T> TscnTreeHandle<T> {
     ) -> TscnTree {
         let handle = self.handle.take().expect("Handle already consumed");
         let tscn = assets.remove(handle).expect("Handle not loaded");
-        cmd.entity(self.entity).despawn();
+        cmd.entity(self.entity).despawn_recursive();
         tscn
     }
 }

main_game_lib/src/rscn/spawner.rs

@@ -275,5 +275,6 @@ fn node_to_entity<T: TscnSpawner>(
         ..default()
     });
 
+    bevy::log::trace!("Spawning {entity:?} {name:?} from scene file",);
     spawner.on_spawned(cmd, entity, name, translation);
 }

main_game_lib/src/top_down/inspect_and_interact.rs

@@ -226,8 +226,8 @@ pub(crate) fn change_highlighted_label(
         return;
     };
 
-    cmd.entity(displayed.bg).despawn();
-    cmd.entity(displayed.text).despawn();
+    cmd.entity(displayed.bg).despawn_recursive();
+    cmd.entity(displayed.text).despawn_recursive();
 
     let displayed =
         spawn_label_bg_and_text(&mut cmd, &asset_server, label, spawn_params);
@@ -273,8 +273,8 @@ pub(crate) fn highlight_what_would_be_interacted_with(
             cmd.entity(highlighted)
                 .remove::<HighlightedForInteraction>();
 
-            cmd.entity(old_displayed.bg).despawn();
-            cmd.entity(old_displayed.text).despawn();
+            cmd.entity(old_displayed.bg).despawn_recursive();
+            cmd.entity(old_displayed.text).despawn_recursive();
 
             let mut new_displayed = spawn_label_bg_and_text(
                 &mut cmd,
@@ -335,8 +335,8 @@ pub(crate) fn highlight_what_would_be_interacted_with(
     remove_old_highlight_if_present();
 
     if let Some(InspectLabelDisplayed { bg, text, .. }) = displayed {
-        cmd.entity(*bg).despawn();
-        cmd.entity(*text).despawn();
+        cmd.entity(*bg).despawn_recursive();
+        cmd.entity(*text).despawn_recursive();
     }
 
     let displayed = spawn_label_bg_and_text(
@@ -575,15 +575,15 @@ impl InspectLabelDisplayed {
                 .with_animation_curve(TEXT_ANIMATION_CURVE.clone())
                 .when_finished_do(move |cmd| {
                     cmd.entity(label_entity).remove::<Self>();
-                    cmd.entity(text).despawn();
+                    cmd.entity(text).despawn_recursive();
                 }),
         );
 
         begin_interpolation.send(
             BeginInterpolationEvent::of_color(bg, None, Color::NONE)
                 .over(FADE_OUT_IN)
                 .with_animation_curve(BG_ANIMATION_CURVE.clone())
-                .when_finished_despawn_itself(),
+                .when_finished_despawn_recursive_itself(),
         );
     }
 

main_game_lib/src/top_down/layout/systems.rs

@@ -15,7 +15,7 @@ pub(crate) fn start_loading_map<T: TopDownScene>(
     let asset_path = format!("maps/{}.ron", T::name());
     debug!("Loading map {} from {}", T::type_path(), asset_path);
     let handle: Handle<TileMap<T>> = assets.load(asset_path);
-    cmd.spawn(handle);
+    cmd.spawn((Name::new(format!("TileMap<{}>", T::type_path())), handle));
 }
 
 /// Run this to wait for the map to be loaded and insert it as a resource.
@@ -52,7 +52,7 @@ pub(crate) fn try_insert_map_as_resource<T: TopDownScene>(
 
         cmd.insert_resource(loaded_map);
         cmd.init_resource::<crate::top_down::actor::ActorZoneMap<T::LocalTileKind>>();
-        cmd.entity(entity).despawn();
+        cmd.entity(entity).despawn_recursive();
     }
 }
 

scenes/building1_basement1/src/layout.rs

@@ -161,8 +161,6 @@ impl<'a> TscnSpawner for Spawner<'a> {
             }
             _ => {}
         }
-
-        trace!("Spawned {name:?} as {who:?} from scene file");
     }
 
     fn add_texture_atlas(

scenes/building1_player_floor/src/layout.rs

@@ -231,8 +231,6 @@ impl<'a> TscnSpawner for Spawner<'a> {
             }
             _ => {}
         }
-
-        trace!("Spawned {name:?} as {who:?} from scene file");
     }
 
     fn handle_plain_node(

scenes/downtown/src/layout.rs

@@ -107,6 +107,10 @@ fn despawn(mut cmd: Commands, root: Query<Entity, With<LayoutEntity>>) {
 
     let root = root.single();
     cmd.entity(root).despawn_recursive();
+
+    cmd.remove_resource::<ZoneToInspectLabelEntity<
+        <Downtown as TopDownScene>::LocalTileKind,
+    >>();
 }
 
 impl<'a> TscnSpawner for Spawner<'a> {
@@ -156,8 +160,6 @@ impl<'a> TscnSpawner for Spawner<'a> {
             }
             _ => {}
         }
-
-        trace!("Spawned {name:?} as {who:?} from scene file");
     }
 
     fn add_texture_atlas(

scenes/mall/src/layout.rs

@@ -119,8 +119,6 @@ impl<'a> TscnSpawner for Spawner<'a> {
             }
             _ => {}
         }
-
-        trace!("Spawned {name:?} as {who:?} from scene file");
     }
 
     fn add_texture_atlas(

scenes/meditation/src/polpos/effects.rs

@@ -35,7 +35,7 @@ pub(crate) mod bolt {
             let lives_for = bolt.spawned_at.elapsed();
 
             if lives_for > BOLT_LIFETIME {
-                cmd.entity(entity).despawn();
+                cmd.entity(entity).despawn_recursive();
             } else {
                 let lerp_factor =
                     lives_for.as_secs_f32() / BOLT_LIFETIME.as_secs_f32();