Fixes zones in player floor's apartment (#227)

main_game_lib/src/state.rs

@@ -339,3 +339,12 @@ impl WhichTopDownScene {
         GlobalGameState::LeavingTopDownScene(self)
     }
 }
+
+impl WhichTopDownScene {
+    /// Returns snake case version of the scene name.
+    /// We use this name to load scene assets because the name matches names
+    /// of .ron and .tscn files.
+    pub fn snake_case(self) -> String {
+        untools::camel_to_snake(self.as_ref(), false)
+    }
+}

main_game_lib/src/top_down.rs

@@ -17,13 +17,12 @@ pub mod cameras;
 pub mod environmental_objects;
 pub mod inspect_and_interact;
 pub mod layout;
-pub mod scene_configs;
 
 use actor::{emit_movement_events, BeginDialogEvent};
 pub use actor::{npc, player::Player, Actor, ActorMovementEvent, ActorTarget};
 use bevy::prelude::*;
 pub use inspect_and_interact::{InspectLabel, InspectLabelCategory};
-pub use layout::{TileKind, TileMap};
+pub use layout::{TileKind, TileMap, ZoneTileKind};
 use leafwing_input_manager::plugin::InputManagerSystem;
 
 use self::inspect_and_interact::ChangeHighlightedInspectLabelEvent;
@@ -217,18 +216,19 @@ impl bevy::app::Plugin for Plugin {
             use bevy_inspector_egui::quick::ResourceInspectorPlugin;
             use layout::map_maker::TileMapMakerToolbar as Toolbar;
 
-            app.register_type::<Toolbar>()
-                .register_type::<Actor>()
-                .register_type::<ActorTarget>()
-                .register_type::<TileKind>()
+            app.register_type::<Actor>()
                 .register_type::<ActorMovementEvent>()
+                .register_type::<ActorTarget>()
                 .register_type::<InspectLabel>()
                 .register_type::<InspectLabelCategory>()
+                .register_type::<npc::BehaviorLeaf>()
+                .register_type::<npc::BehaviorPaused>()
                 .register_type::<npc::NpcInTheMap>()
                 .register_type::<npc::PlanPathEvent>()
+                .register_type::<TileKind>()
                 .register_type::<TileMap>()
-                .register_type::<npc::BehaviorLeaf>()
-                .register_type::<npc::BehaviorPaused>();
+                .register_type::<Toolbar>()
+                .register_type::<ZoneTileKind>();
 
             app.add_plugins(
                 ResourceInspectorPlugin::<Toolbar>::new()

main_game_lib/src/top_down/layout.rs

@@ -22,8 +22,6 @@ use serde::{Deserialize, Serialize};
 use smallvec::SmallVec;
 use strum::IntoEnumIterator;
 
-use super::scene_configs::ZoneTileKind;
-
 /// Each scene adheres to the same layout definition.
 /// That's because the amount of space the character takes in the tile grid
 /// is constant and tailored to the square size.
@@ -123,6 +121,70 @@ pub enum TileKind {
     Zone(ZoneTileKind),
 }
 
+/// Named zones in the .ron files that are used in particular's scene logic to
+/// achieve some behavior specific to that scene.
+/// The zones can be re-used in multiple scenes.
+#[derive(
+    Clone,
+    Copy,
+    Debug,
+    Default,
+    Deserialize,
+    Eq,
+    Hash,
+    Ord,
+    PartialEq,
+    PartialOrd,
+    Reflect,
+    Serialize,
+    strum::Display,
+    strum::EnumIter,
+    strum::EnumString,
+)]
+#[reflect(Default)]
+#[allow(missing_docs)]
+pub enum ZoneTileKind {
+    /// Arbitrarily the default value.
+    #[default]
+    Exit,
+
+    Aisle1,
+    Aisle2,
+    Aisle3,
+    Aisle4,
+
+    /// In interior scenes there might be multiple apartments.
+    /// This represents a second apartment in such scenes.
+    Apartment2,
+    Apartment2BathroomDoor,
+    Apartment2Door,
+
+    BasementDoor,
+    Bed,
+    Building1Entrance,
+    ClinicEntrance,
+    ClinicWardEntrance,
+    CompoundEntrance,
+    Door,
+    Elevator,
+    Fridges,
+    FruitsAndVeggies,
+    GoodWater,
+    GoToDowntown,
+    Hallway,
+    MallEntrance,
+    Meditation,
+    PlantShopEntrance,
+    PlayerApartment,
+    PlayerDoor,
+    SewersEntrance,
+    Tea,
+    TowerEntrance,
+    TwinpeaksApartmentEntrance,
+    UpperApartmentDoor,
+    UpperApartmentWallHidden,
+}
+
 /// Useful for pathfinding to prefer some tiles over others.
 #[derive(Default, PartialEq, Eq, PartialOrd, Ord, Debug)]
 pub enum TileWalkCost {

scenes/top_down/src/building1_basement2.rs

@@ -3,9 +3,7 @@ use common_visuals::camera::render_layer;
 use main_game_lib::{
     common_ext::QueryExt,
     cutscene::{enter_dark_door::EnterDarkDoor, in_cutscene, IntoCutscene},
-    top_down::scene_configs::ZoneTileKind,
 };
-use rscn::{NodeName, TscnSpawner, TscnTree, TscnTreeHandle};
 use top_down::{
     actor::{CharacterBundleBuilder, CharacterExt},
     inspect_and_interact::ZoneToInspectLabelEntity,

scenes/top_down/src/building1_player_floor.rs

@@ -21,11 +21,9 @@ use main_game_lib::{
             ChangeHighlightedInspectLabelEventConsumer,
             SpawnLabelBgAndTextParams, LIGHT_RED,
         },
-        scene_configs::ZoneTileKind,
         ActorMovementEvent,
     },
 };
-use rscn::{NodeName, TscnSpawner, TscnTree, TscnTreeHandle};
 use top_down::{
     actor::{
         self, movement_event_emitted, CharacterBundleBuilder, CharacterExt,
@@ -256,23 +254,14 @@ impl<'a> TscnSpawner for Spawner<'a> {
                     .build_and_insert_obstacle(self.tilemap);
                 cmd.entity(who).insert(door);
             }
-            "BottomLeftApartmentDoor" => {
+            "Apartment2Door" => {
                 cmd.entity(who).insert(
-                    DoorBuilder::new(ZoneTileKind::BottomLeftApartmentDoor)
-                        .build(),
-                );
-            }
-            "BottomLeftApartmentBathroomDoor" => {
-                cmd.entity(who).insert(
-                    DoorBuilder::new(
-                        ZoneTileKind::BottomLeftApartmentBathroomDoor,
-                    )
-                    .build(),
+                    DoorBuilder::new(ZoneTileKind::Apartment2Door).build(),
                 );
             }
-            "BottomRightApartmentDoor" => {
+            "Apartment2BathroomDoor" => {
                 cmd.entity(who).insert(
-                    DoorBuilder::new(ZoneTileKind::BottomRightApartmentDoor)
+                    DoorBuilder::new(ZoneTileKind::Apartment2BathroomDoor)
                         .build(),
                 );
             }

scenes/top_down/src/building1_player_floor/watch_entry_to_hallway.rs

@@ -1,7 +1,7 @@
 use common_visuals::BeginInterpolationEvent;
 use main_game_lib::{
     common_ext::QueryExt,
-    top_down::{actor::Who, scene_configs::ZoneTileKind, TileKind},
+    top_down::{actor::Who, TileKind},
 };
 use top_down::{Actor, ActorMovementEvent, TileMap};
 
@@ -40,10 +40,7 @@ pub(super) fn system(
                     Who {
                         is_player: true, ..
                     },
-                zone:
-                    TileKind::Zone(
-                        Hallway | BottomLeftApartment | BottomRightApartment,
-                    ),
+                zone: TileKind::Zone(Hallway | Apartment2),
             } => {
                 on_player_entered_hallway(&mut lerp_event, &hallway_entities);
             }
@@ -52,10 +49,7 @@ pub(super) fn system(
                     Who {
                         is_player: true, ..
                     },
-                zone:
-                    TileKind::Zone(
-                        Hallway | BottomLeftApartment | BottomRightApartment,
-                    ),
+                zone: TileKind::Zone(Hallway | Apartment2),
             } => {
                 on_player_left_hallway(&mut lerp_event, &hallway_entities);
             }
@@ -66,10 +60,7 @@ pub(super) fn system(
                         entity,
                         ..
                     },
-                zone:
-                    TileKind::Zone(
-                        Hallway | BottomLeftApartment | BottomRightApartment,
-                    ),
+                zone: TileKind::Zone(Hallway | Apartment2),
             } => {
                 on_npc_entered_hallway(
                     &tilemap,
@@ -86,10 +77,7 @@ pub(super) fn system(
                         entity,
                         ..
                     },
-                zone:
-                    TileKind::Zone(
-                        Hallway | BottomLeftApartment | BottomRightApartment,
-                    ),
+                zone: TileKind::Zone(Hallway | Apartment2),
             } => {
                 on_npc_left_hallway(&mut cmd, &mut lerp_event, *entity);
             }

scenes/top_down/src/clinic.rs

@@ -1,12 +1,9 @@
 use bevy::render::view::RenderLayers;
 use common_visuals::camera::render_layer;
 use main_game_lib::{
-    cutscene::in_cutscene,
-    hud::notification::NotificationFifo,
+    cutscene::in_cutscene, hud::notification::NotificationFifo,
     player_stats::PlayerStats,
-    top_down::{
-        environmental_objects::door::DoorBuilder, scene_configs::ZoneTileKind,
-    },
+    top_down::environmental_objects::door::DoorBuilder,
 };
 use rscn::{NodeName, TscnSpawner, TscnTree, TscnTreeHandle};
 use top_down::{

scenes/top_down/src/clinic_ward.rs

@@ -2,9 +2,8 @@ use bevy::render::view::RenderLayers;
 use common_visuals::camera::render_layer;
 use main_game_lib::{
     cutscene::in_cutscene, hud::notification::NotificationFifo,
-    player_stats::PlayerStats, top_down::scene_configs::ZoneTileKind,
+    player_stats::PlayerStats,
 };
-use rscn::{NodeName, TscnSpawner, TscnTree, TscnTreeHandle};
 use top_down::{
     actor::{CharacterBundleBuilder, CharacterExt},
     inspect_and_interact::ZoneToInspectLabelEntity,

scenes/top_down/src/compound.rs

@@ -6,9 +6,8 @@ use main_game_lib::{
     cutscene::in_cutscene,
     hud::{daybar::UpdateDayBarEvent, notification::NotificationFifo},
     player_stats::PlayerStats,
-    top_down::{layout::LAYOUT, scene_configs::ZoneTileKind},
+    top_down::layout::LAYOUT,
 };
-use rscn::{NodeName, TscnSpawner, TscnTree, TscnTreeHandle};
 use top_down::{
     actor::{CharacterBundleBuilder, CharacterExt},
     inspect_and_interact::ZoneToInspectLabelEntity,

scenes/top_down/src/compound_tower.rs

@@ -2,9 +2,8 @@ use bevy::render::view::RenderLayers;
 use common_visuals::camera::render_layer;
 use main_game_lib::{
     cutscene::in_cutscene, hud::notification::NotificationFifo,
-    player_stats::PlayerStats, top_down::scene_configs::ZoneTileKind,
+    player_stats::PlayerStats,
 };
-use rscn::{NodeName, TscnSpawner, TscnTree, TscnTreeHandle};
 use top_down::{
     actor::{CharacterBundleBuilder, CharacterExt},
     inspect_and_interact::ZoneToInspectLabelEntity,

scenes/top_down/src/downtown.rs

@@ -16,10 +16,8 @@ use main_game_lib::{
             SpawnLabelBgAndTextParams, ZoneToInspectLabelEntity, LIGHT_RED,
         },
         npc::behaviors::PatrolSequence,
-        scene_configs::ZoneTileKind,
     },
 };
-use rscn::{NodeName, TscnSpawner, TscnTree, TscnTreeHandle};
 use top_down::{
     actor::{CharacterBundleBuilder, CharacterExt},
     layout::LAYOUT,

scenes/top_down/src/mall.rs

@@ -7,12 +7,10 @@ use main_game_lib::{
     hud::notification::NotificationFifo,
     player_stats::PlayerStats,
     top_down::{
-        actor::BeginDialogEvent, layout::LAYOUT,
-        npc::behaviors::PatrolSequence, scene_configs::ZoneTileKind,
+        actor::BeginDialogEvent, layout::LAYOUT, npc::behaviors::PatrolSequence,
     },
 };
 use rand::prelude::SliceRandom;
-use rscn::{NodeName, TscnSpawner, TscnTree, TscnTreeHandle};
 use top_down::{
     actor::{CharacterBundleBuilder, CharacterExt},
     inspect_and_interact::ZoneToInspectLabelEntity,

scenes/top_down/src/plant_shop.rs

@@ -2,9 +2,8 @@ use bevy::render::view::RenderLayers;
 use common_visuals::camera::render_layer;
 use main_game_lib::{
     cutscene::in_cutscene, hud::notification::NotificationFifo,
-    player_stats::PlayerStats, top_down::scene_configs::ZoneTileKind,
+    player_stats::PlayerStats,
 };
-use rscn::{NodeName, TscnSpawner, TscnTree, TscnTreeHandle};
 use top_down::{
     actor::{CharacterBundleBuilder, CharacterExt},
     inspect_and_interact::ZoneToInspectLabelEntity,