Name scenes (scene enum, entrance enum, various identifiers) (#1343)

* Comment names on titled scenes

* Comment some more scene names

* Comment some map assets symbol prefixes

* Name collapse sequence scenes (from the non-collapse equivalent scene's name + `_COLLAPSE`)

* Name ganon/ganondorf boss scenes (symbol prefix suffixed with `Scene` to prevent confusion with boss actors)

* Fix symbol prefix for back alley night scene

* Name the two grave scenes (normal and fairy's fountain variant)

* Name most houses, name/update misc scenes

Co-authored-by: fig02 <fig02srl@gmail.com>

* (hakaana) `GRAVE` -> `REDEAD_GRAVE` to be more specific

Co-authored-by: fig02 <fig02srl@gmail.com>

* `miharigoya_scene`: `market_guard_house`

* `kakariko_scene` -> `kakariko_center_house`

* `richards_house` -> `dog_lady_house` (for localization differences)

* Revert "Comment some map assets symbol prefixes"

This reverts commit 210a38a6288d5d2fa318059f31988ca7ceb5c708.

* remove other xml prefixes

* ganon_boss, ganondorf_boss

* comments to namefixer

* `KAKARIKO_CENTER_HOUSE` -> `KAKARIKO_CENTER_GUEST_HOUSE`

* two collapse sequence scenes -> `GANONS_TOWER_COLLAPSE_`interior/exterior

* Run namefixer

`find src include -type f -exec ./tools/namefixer.py {} \;`

* run formatter

Co-authored-by: fig02 <fig02srl@gmail.com>

1 files changed, 61 insertions, 60 deletions

diff --git a/src/code/z_sram.c b/src/code/z_sram.c
index 57ea86058..79747e091 100644
--- a/src/code/z_sram.c
+++ b/src/code/z_sram.c
@@ -126,7 +126,7 @@ static SavePlayerData sNewSavePlayerData = {
     },                                                  // adultEquips
     0,                                                  // unk_38
     { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 },       // unk_3C
-    SCENE_LINK_HOME,                                    // savedSceneId
+    SCENE_LINKS_HOUSE,                                  // savedSceneId
 };
 
 static ItemEquips sNewSaveEquips = {
@@ -214,7 +214,7 @@ void Sram_InitNewSave(void) {
     gSaveContext.inventory = sNewSaveInventory;
 
     temp->checksum = sNewSaveChecksum;
-    gSaveContext.horseData.sceneId = SCENE_SPOT00;
+    gSaveContext.horseData.sceneId = SCENE_HYRULE_FIELD;
     gSaveContext.horseData.pos.x = -1840;
     gSaveContext.horseData.pos.y = 72;
     gSaveContext.horseData.pos.z = 5497;
@@ -254,7 +254,7 @@ static SavePlayerData sDebugSavePlayerData = {
     },                                                  // adultEquips
     0,                                                  // unk_38
     { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 },       // unk_3C
-    SCENE_SPOT00,                                       // savedSceneId
+    SCENE_HYRULE_FIELD,                                 // savedSceneId
 };
 
 static ItemEquips sDebugSaveEquips = {
@@ -356,7 +356,7 @@ void Sram_InitDebugSave(void) {
     gSaveContext.inventory = sDebugSaveInventory;
 
     temp->checksum = sDebugSaveChecksum;
-    gSaveContext.horseData.sceneId = SCENE_SPOT00;
+    gSaveContext.horseData.sceneId = SCENE_HYRULE_FIELD;
     gSaveContext.horseData.pos.x = -1840;
     gSaveContext.horseData.pos.y = 72;
     gSaveContext.horseData.pos.z = 5497;
@@ -376,28 +376,28 @@ void Sram_InitDebugSave(void) {
         }
     }
 
-    gSaveContext.entranceIndex = ENTR_SPOT00_0;
+    gSaveContext.entranceIndex = ENTR_HYRULE_FIELD_0;
     gSaveContext.magicLevel = 0;
     gSaveContext.sceneFlags[5].swch = 0x40000000;
 }
 
 static s16 sDungeonEntrances[] = {
-    ENTR_YDAN_0,             // SCENE_YDAN
-    ENTR_DDAN_0,             // SCENE_DDAN
-    ENTR_BDAN_0,             // SCENE_BDAN
-    ENTR_BMORI1_0,           // SCENE_BMORI1
-    ENTR_HIDAN_0,            // SCENE_HIDAN
-    ENTR_MIZUSIN_0,          // SCENE_MIZUSIN
-    ENTR_JYASINZOU_0,        // SCENE_JYASINZOU
-    ENTR_HAKADAN_0,          // SCENE_HAKADAN
-    ENTR_HAKADANCH_0,        // SCENE_HAKADANCH
-    ENTR_ICE_DOUKUTO_0,      // SCENE_ICE_DOUKUTO
-    ENTR_GANON_0,            // SCENE_GANON
-    ENTR_MEN_0,              // SCENE_MEN
-    ENTR_GERUDOWAY_0,        // SCENE_GERUDOWAY
-    ENTR_GANONTIKA_0,        // SCENE_GANONTIKA
-    ENTR_GANON_SONOGO_0,     // SCENE_GANON_SONOGO
-    ENTR_GANONTIKA_SONOGO_0, // SCENE_GANONTIKA_SONOGO
+    ENTR_DEKU_TREE_0,                      // SCENE_DEKU_TREE
+    ENTR_DODONGOS_CAVERN_0,                // SCENE_DODONGOS_CAVERN
+    ENTR_JABU_JABU_0,                      // SCENE_JABU_JABU
+    ENTR_FOREST_TEMPLE_0,                  // SCENE_FOREST_TEMPLE
+    ENTR_FIRE_TEMPLE_0,                    // SCENE_FIRE_TEMPLE
+    ENTR_WATER_TEMPLE_0,                   // SCENE_WATER_TEMPLE
+    ENTR_SPIRIT_TEMPLE_0,                  // SCENE_SPIRIT_TEMPLE
+    ENTR_SHADOW_TEMPLE_0,                  // SCENE_SHADOW_TEMPLE
+    ENTR_BOTTOM_OF_THE_WELL_0,             // SCENE_BOTTOM_OF_THE_WELL
+    ENTR_ICE_CAVERN_0,                     // SCENE_ICE_CAVERN
+    ENTR_GANONS_TOWER_0,                   // SCENE_GANONS_TOWER
+    ENTR_GERUDO_TRAINING_GROUND_0,         // SCENE_GERUDO_TRAINING_GROUND
+    ENTR_THIEVES_HIDEOUT_0,                // SCENE_THIEVES_HIDEOUT
+    ENTR_INSIDE_GANONS_CASTLE_0,           // SCENE_INSIDE_GANONS_CASTLE
+    ENTR_GANONS_TOWER_COLLAPSE_INTERIOR_0, // SCENE_GANONS_TOWER_COLLAPSE_INTERIOR
+    ENTR_INSIDE_GANONS_CASTLE_COLLAPSE_0,  // SCENE_INSIDE_GANONS_CASTLE_COLLAPSE
 };
 
 /**
@@ -426,68 +426,69 @@ void Sram_OpenSave(SramContext* sramCtx) {
                  ((void)0, gSaveContext.entranceIndex));
 
     switch (gSaveContext.savedSceneId) {
-        case SCENE_YDAN:
-        case SCENE_DDAN:
-        case SCENE_BDAN:
-        case SCENE_BMORI1:
-        case SCENE_HIDAN:
-        case SCENE_MIZUSIN:
-        case SCENE_JYASINZOU:
-        case SCENE_HAKADAN:
-        case SCENE_HAKADANCH:
-        case SCENE_ICE_DOUKUTO:
-        case SCENE_GANON:
-        case SCENE_MEN:
-        case SCENE_GERUDOWAY:
-        case SCENE_GANONTIKA:
+        case SCENE_DEKU_TREE:
+        case SCENE_DODONGOS_CAVERN:
+        case SCENE_JABU_JABU:
+        case SCENE_FOREST_TEMPLE:
+        case SCENE_FIRE_TEMPLE:
+        case SCENE_WATER_TEMPLE:
+        case SCENE_SPIRIT_TEMPLE:
+        case SCENE_SHADOW_TEMPLE:
+        case SCENE_BOTTOM_OF_THE_WELL:
+        case SCENE_ICE_CAVERN:
+        case SCENE_GANONS_TOWER:
+        case SCENE_GERUDO_TRAINING_GROUND:
+        case SCENE_THIEVES_HIDEOUT:
+        case SCENE_INSIDE_GANONS_CASTLE:
             gSaveContext.entranceIndex = sDungeonEntrances[gSaveContext.savedSceneId];
             break;
 
-        case SCENE_YDAN_BOSS:
-            gSaveContext.entranceIndex = ENTR_YDAN_0;
+        case SCENE_DEKU_TREE_BOSS:
+            gSaveContext.entranceIndex = ENTR_DEKU_TREE_0;
             break;
 
-        case SCENE_DDAN_BOSS:
-            gSaveContext.entranceIndex = ENTR_DDAN_0;
+        case SCENE_DODONGOS_CAVERN_BOSS:
+            gSaveContext.entranceIndex = ENTR_DODONGOS_CAVERN_0;
             break;
 
-        case SCENE_BDAN_BOSS:
-            gSaveContext.entranceIndex = ENTR_BDAN_0;
+        case SCENE_JABU_JABU_BOSS:
+            gSaveContext.entranceIndex = ENTR_JABU_JABU_0;
             break;
 
-        case SCENE_MORIBOSSROOM:
-            gSaveContext.entranceIndex = ENTR_BMORI1_0;
+        case SCENE_FOREST_TEMPLE_BOSS:
+            gSaveContext.entranceIndex = ENTR_FOREST_TEMPLE_0;
             break;
 
-        case SCENE_FIRE_BS:
-            gSaveContext.entranceIndex = ENTR_HIDAN_0;
+        case SCENE_FIRE_TEMPLE_BOSS:
+            gSaveContext.entranceIndex = ENTR_FIRE_TEMPLE_0;
             break;
 
-        case SCENE_MIZUSIN_BS:
-            gSaveContext.entranceIndex = ENTR_MIZUSIN_0;
+        case SCENE_WATER_TEMPLE_BOSS:
+            gSaveContext.entranceIndex = ENTR_WATER_TEMPLE_0;
             break;
 
-        case SCENE_JYASINBOSS:
-            gSaveContext.entranceIndex = ENTR_JYASINZOU_0;
+        case SCENE_SPIRIT_TEMPLE_BOSS:
+            gSaveContext.entranceIndex = ENTR_SPIRIT_TEMPLE_0;
             break;
 
-        case SCENE_HAKADAN_BS:
-            gSaveContext.entranceIndex = ENTR_HAKADAN_0;
+        case SCENE_SHADOW_TEMPLE_BOSS:
+            gSaveContext.entranceIndex = ENTR_SHADOW_TEMPLE_0;
             break;
 
-        case SCENE_GANON_SONOGO:
-        case SCENE_GANONTIKA_SONOGO:
+        case SCENE_GANONS_TOWER_COLLAPSE_INTERIOR:
+        case SCENE_INSIDE_GANONS_CASTLE_COLLAPSE:
+        case SCENE_GANONDORF_BOSS:
+        case SCENE_GANONS_TOWER_COLLAPSE_EXTERIOR:
         case SCENE_GANON_BOSS:
-        case SCENE_GANON_FINAL:
-        case SCENE_GANON_DEMO:
-            gSaveContext.entranceIndex = ENTR_GANON_0;
+            gSaveContext.entranceIndex = ENTR_GANONS_TOWER_0;
             break;
 
         default:
-            if (gSaveContext.savedSceneId != SCENE_LINK_HOME) {
-                gSaveContext.entranceIndex = (LINK_AGE_IN_YEARS == YEARS_CHILD) ? ENTR_LINK_HOME_0 : ENTR_TOKINOMA_7;
+            if (gSaveContext.savedSceneId != SCENE_LINKS_HOUSE) {
+                gSaveContext.entranceIndex =
+                    (LINK_AGE_IN_YEARS == YEARS_CHILD) ? ENTR_LINKS_HOUSE_0 : ENTR_TEMPLE_OF_TIME_7;
             } else {
-                gSaveContext.entranceIndex = ENTR_LINK_HOME_0;
+                gSaveContext.entranceIndex = ENTR_LINKS_HOUSE_0;
             }
             break;
     }
@@ -789,7 +790,7 @@ void Sram_InitSave(FileSelectState* fileSelect, SramContext* sramCtx) {
         Sram_InitDebugSave();
     }
 
-    gSaveContext.entranceIndex = ENTR_LINK_HOME_0;
+    gSaveContext.entranceIndex = ENTR_LINKS_HOUSE_0;
     gSaveContext.linkAge = LINK_AGE_CHILD;
     gSaveContext.dayTime = CLOCK_TIME(10, 0);
     gSaveContext.cutsceneIndex = 0xFFF1;