From e07d3a3819fa9f6b2b5864ddf7c47bd1c93d8316 Mon Sep 17 00:00:00 2001
From: Dragorn421 <Dragorn421@users.noreply.github.com>
Date: Sun, 20 Mar 2022 01:56:05 +0100
Subject: [PATCH] Document more PathwayLists for scenes (#1181)

* Document more PathwayLists for scenes

* `Pathway` -> `PathList`

* Fix `NumPaths` in `ganon_final` scene (6 -> 4)

Co-authored-by: Hayden Kowalchuk <819028+mrneo240@users.noreply.github.com>
---
 assets/xml/scenes/dungeons/HAKAdanCH.xml       | 1 +
 assets/xml/scenes/dungeons/HIDAN.xml           | 1 +
 assets/xml/scenes/dungeons/MIZUsin.xml         | 1 +
 assets/xml/scenes/dungeons/ganon_final.xml     | 1 +
 assets/xml/scenes/dungeons/ganon_sonogo.xml    | 1 +
 assets/xml/scenes/dungeons/ganontika.xml       | 1 +
 assets/xml/scenes/dungeons/ganontikasonogo.xml | 1 +
 assets/xml/scenes/dungeons/gerudoway.xml       | 1 +
 assets/xml/scenes/dungeons/ice_doukutu.xml     | 1 +
 assets/xml/scenes/dungeons/jyasinzou.xml       | 1 +
 assets/xml/scenes/indoors/hairal_niwa.xml      | 1 +
 assets/xml/scenes/misc/market_alley_n.xml      | 1 +
 assets/xml/scenes/misc/market_day.xml          | 1 +
 assets/xml/scenes/misc/market_night.xml        | 1 +
 assets/xml/scenes/misc/shrine_n.xml            | 1 +
 assets/xml/scenes/overworld/spot00.xml         | 1 +
 assets/xml/scenes/overworld/spot01.xml         | 1 +
 assets/xml/scenes/overworld/spot03.xml         | 5 ++---
 assets/xml/scenes/overworld/spot04.xml         | 5 ++---
 assets/xml/scenes/overworld/spot05.xml         | 6 +-----
 assets/xml/scenes/overworld/spot06.xml         | 2 +-
 assets/xml/scenes/overworld/spot07.xml         | 1 +
 assets/xml/scenes/overworld/spot09.xml         | 3 +--
 assets/xml/scenes/overworld/spot10.xml         | 3 +--
 assets/xml/scenes/overworld/spot16.xml         | 2 ++
 assets/xml/scenes/overworld/spot20.xml         | 1 +
 26 files changed, 29 insertions(+), 16 deletions(-)

diff --git a/assets/xml/scenes/dungeons/HAKAdanCH.xml b/assets/xml/scenes/dungeons/HAKAdanCH.xml
index eb55a19f53..61c1416898 100644
--- a/assets/xml/scenes/dungeons/HAKAdanCH.xml
+++ b/assets/xml/scenes/dungeons/HAKAdanCH.xml
@@ -1,5 +1,6 @@
 <Root>
     <File Name="HAKAdanCH_scene" Segment="2">
+        <Path Name="HAKAdanCH_scenePathList_000248" Offset="0x0248" NumPaths="2"/>
         <Scene Name="HAKAdanCH_scene" Offset="0x0"/>
     </File>
     <File Name="HAKAdanCH_room_0" Segment="3">
diff --git a/assets/xml/scenes/dungeons/HIDAN.xml b/assets/xml/scenes/dungeons/HIDAN.xml
index 4451685c25..d9c693c007 100644
--- a/assets/xml/scenes/dungeons/HIDAN.xml
+++ b/assets/xml/scenes/dungeons/HIDAN.xml
@@ -1,5 +1,6 @@
 <Root>
     <File Name="HIDAN_scene" Segment="2">
+        <Path Name="HIDAN_scenePathList_000440" Offset="0x0440" NumPaths="4"/>
         <Scene Name="HIDAN_scene" Offset="0x0"/>
     </File>
     <File Name="HIDAN_room_0" Segment="3">
diff --git a/assets/xml/scenes/dungeons/MIZUsin.xml b/assets/xml/scenes/dungeons/MIZUsin.xml
index bade619fe4..bd0e260ace 100644
--- a/assets/xml/scenes/dungeons/MIZUsin.xml
+++ b/assets/xml/scenes/dungeons/MIZUsin.xml
@@ -1,5 +1,6 @@
 <Root>
     <File Name="MIZUsin_scene" Segment="2">
+        <Path Name="MIZUsin_scenePathList_000384" Offset="0x0384" NumPaths="2"/>
         <Texture Name="gWaterTempleDayEntranceTex" OutName="day_entrance" Format="ia16" Width="8" Height="64" Offset="0x14C30"/>
         <Texture Name="gWaterTempleNightEntranceTex" OutName="night_entrance" Format="ia16" Width="8" Height="64" Offset="0x15830"/>
         <Scene Name="MIZUsin_scene" Offset="0x0"/>
diff --git a/assets/xml/scenes/dungeons/ganon_final.xml b/assets/xml/scenes/dungeons/ganon_final.xml
index 63b5f91727..a923673726 100644
--- a/assets/xml/scenes/dungeons/ganon_final.xml
+++ b/assets/xml/scenes/dungeons/ganon_final.xml
@@ -1,5 +1,6 @@
 <Root>
     <File Name="ganon_final_scene" Segment="2">
+        <Path Name="ganon_final_scenePathList_0001F4" Offset="0x01F4" NumPaths="4"/>
         <Scene Name="ganon_final_scene" Offset="0x0"/>
     </File>
     <File Name="ganon_final_room_0" Segment="3">
diff --git a/assets/xml/scenes/dungeons/ganon_sonogo.xml b/assets/xml/scenes/dungeons/ganon_sonogo.xml
index 4ede85b4ec..5803668786 100644
--- a/assets/xml/scenes/dungeons/ganon_sonogo.xml
+++ b/assets/xml/scenes/dungeons/ganon_sonogo.xml
@@ -1,5 +1,6 @@
 <Root>
     <File Name="ganon_sonogo_scene" Segment="2">
+        <Path Name="ganon_sonogo_scenePathList_000254" Offset="0x0254" NumPaths="5"/>
         <Scene Name="ganon_sonogo_scene" Offset="0x0"/>
     </File>
     <File Name="ganon_sonogo_room_0" Segment="3">
diff --git a/assets/xml/scenes/dungeons/ganontika.xml b/assets/xml/scenes/dungeons/ganontika.xml
index 7456674dda..b2673e10c9 100644
--- a/assets/xml/scenes/dungeons/ganontika.xml
+++ b/assets/xml/scenes/dungeons/ganontika.xml
@@ -16,6 +16,7 @@
         <Cutscene Name="gWaterBarrierCs" Offset="0x1EF70"/>
         <Cutscene Name="gShadowBarrierCs" Offset="0x21380"/>
 
+        <Path Name="ganontika_scenePathList_000668" Offset="0x0668" NumPaths="6"/>
         <Scene Name="ganontika_scene" Offset="0x0"/>
     </File>
     <File Name="ganontika_room_0" Segment="3">
diff --git a/assets/xml/scenes/dungeons/ganontikasonogo.xml b/assets/xml/scenes/dungeons/ganontikasonogo.xml
index 853fbde15e..b70310d6bd 100644
--- a/assets/xml/scenes/dungeons/ganontikasonogo.xml
+++ b/assets/xml/scenes/dungeons/ganontikasonogo.xml
@@ -1,5 +1,6 @@
 <Root>
     <File Name="ganontikasonogo_scene" Segment="2">
+        <Path Name="ganontikasonogo_scenePathList_000184" Offset="0x0184" NumPaths="2"/>
         <Scene Name="ganontikasonogo_scene" Offset="0x0"/>
     </File>
     <File Name="ganontikasonogo_room_0" Segment="3">
diff --git a/assets/xml/scenes/dungeons/gerudoway.xml b/assets/xml/scenes/dungeons/gerudoway.xml
index 5c5fab0462..d6abe7ed05 100644
--- a/assets/xml/scenes/dungeons/gerudoway.xml
+++ b/assets/xml/scenes/dungeons/gerudoway.xml
@@ -2,6 +2,7 @@
     <File Name="gerudoway_scene" Segment="2">
         <Texture Name="gThievesHideoutNightEntranceTex" OutName="night_entrance" Format="ia16" Width="128" Height="4" Offset="0xB920"/>
         <Texture Name="gThievesHideoutDayEntranceTex" OutName="day_entrance" Format="ia16" Width="128" Height="4" Offset="0xBD20"/>
+        <Path Name="gerudoway_scenePathList_0002AC" Offset="0x02AC" NumPaths="4"/>
         <Scene Name="gerudoway_scene" Offset="0x0"/>
     </File>
     <File Name="gerudoway_room_0" Segment="3">
diff --git a/assets/xml/scenes/dungeons/ice_doukutu.xml b/assets/xml/scenes/dungeons/ice_doukutu.xml
index 1512b7d885..a6e6b415df 100644
--- a/assets/xml/scenes/dungeons/ice_doukutu.xml
+++ b/assets/xml/scenes/dungeons/ice_doukutu.xml
@@ -1,5 +1,6 @@
 <Root>
     <File Name="ice_doukutu_scene" Segment="2">
+        <Path Name="ice_doukutu_scenePathList_000304" Offset="0x0304" NumPaths="5"/>
         <Cutscene Name="gIceCavernSerenadeCs" Offset="0x330"/>
         <Texture Name="gIceCavernNightEntranceTex" OutName="night_entrance" Format="ia16" Width="64" Height="4" Offset="0xF8C0"/>
         <Texture Name="gIceCavernDayEntranceTex" OutName="day_entrance" Format="ia16" Width="64" Height="4" Offset="0xFAC0"/>
diff --git a/assets/xml/scenes/dungeons/jyasinzou.xml b/assets/xml/scenes/dungeons/jyasinzou.xml
index 38ba81faba..556f99900a 100644
--- a/assets/xml/scenes/dungeons/jyasinzou.xml
+++ b/assets/xml/scenes/dungeons/jyasinzou.xml
@@ -1,5 +1,6 @@
 <Root>
     <File Name="jyasinzou_scene" Segment="2">
+        <Path Name="jyasinzou_scenePathList_00049C" Offset="0x049C" NumPaths="5"/>
         <Texture Name="gSpiritTempleDayEntranceTex" OutName="day_entrance" Format="ia16" Width="8" Height="128" Offset="0x18920"/>
         <Texture Name="gSpiritTempleNightEntranceTex" OutName="night_entrance" Format="ia16" Width="8" Height="128" Offset="0x18020"/>
         <Scene Name="jyasinzou_scene" Offset="0x0"/>
diff --git a/assets/xml/scenes/indoors/hairal_niwa.xml b/assets/xml/scenes/indoors/hairal_niwa.xml
index e91342da8d..ff8fab363a 100644
--- a/assets/xml/scenes/indoors/hairal_niwa.xml
+++ b/assets/xml/scenes/indoors/hairal_niwa.xml
@@ -1,5 +1,6 @@
 <Root>
     <File Name="hairal_niwa_scene" Segment="2">
+        <Path Name="hairal_niwa_scenePathList_000268" Offset="0x0268" NumPaths="8"/>
         <Scene Name="hairal_niwa_scene" Offset="0x0"/>
     </File>
     <File Name="hairal_niwa_room_0" Segment="3">
diff --git a/assets/xml/scenes/misc/market_alley_n.xml b/assets/xml/scenes/misc/market_alley_n.xml
index 3e350ee480..0fddf01891 100644
--- a/assets/xml/scenes/misc/market_alley_n.xml
+++ b/assets/xml/scenes/misc/market_alley_n.xml
@@ -1,5 +1,6 @@
 <Root>
     <File Name="market_alley_n_scene" Segment="2">
+        <Path Name="market_alley_n_scenePathList_00019C" Offset="0x019C" NumPaths="3"/>
         <Scene Name="market_alley_n_scene" Offset="0x0"/>
     </File>
     <File Name="market_alley_n_room_0" Segment="3">
diff --git a/assets/xml/scenes/misc/market_day.xml b/assets/xml/scenes/misc/market_day.xml
index 3cda55dc01..b9b2b19a35 100644
--- a/assets/xml/scenes/misc/market_day.xml
+++ b/assets/xml/scenes/misc/market_day.xml
@@ -1,5 +1,6 @@
 <Root>
     <File Name="market_day_scene" Segment="2">
+        <Path Name="market_day_scenePathList_000330" Offset="0x0330" NumPaths="4"/>
         <Scene Name="market_day_scene" Offset="0x0"/>
     </File>
     <File Name="market_day_room_0" Segment="3">
diff --git a/assets/xml/scenes/misc/market_night.xml b/assets/xml/scenes/misc/market_night.xml
index ec2f7d32ee..3df655a597 100644
--- a/assets/xml/scenes/misc/market_night.xml
+++ b/assets/xml/scenes/misc/market_night.xml
@@ -1,5 +1,6 @@
 <Root>
     <File Name="market_night_scene" Segment="2">
+        <Path Name="market_night_scenePathList_0002FC" Offset="0x02FC" NumPaths="7"/>
         <Scene Name="market_night_scene" Offset="0x0"/>
     </File>
     <File Name="market_night_room_0" Segment="3">
diff --git a/assets/xml/scenes/misc/shrine_n.xml b/assets/xml/scenes/misc/shrine_n.xml
index 144de7bfde..fb0ba87faa 100644
--- a/assets/xml/scenes/misc/shrine_n.xml
+++ b/assets/xml/scenes/misc/shrine_n.xml
@@ -1,5 +1,6 @@
 <Root>
     <File Name="shrine_n_scene" Segment="2">
+        <Path Name="shrine_n_scenePathList_000100" Offset="0x0100" NumPaths="2"/>
         <Scene Name="shrine_n_scene" Offset="0x0"/>
     </File>
     <File Name="shrine_n_room_0" Segment="3">
diff --git a/assets/xml/scenes/overworld/spot00.xml b/assets/xml/scenes/overworld/spot00.xml
index 7cf39bef1c..7e94ff3a61 100644
--- a/assets/xml/scenes/overworld/spot00.xml
+++ b/assets/xml/scenes/overworld/spot00.xml
@@ -7,6 +7,7 @@
         <Cutscene Name="gHyruleFieldSouthEponaJumpCs" Offset="0xF9E0"/>
         <Cutscene Name="gHyruleFieldWestEponaJumpCs" Offset="0x10550"/>
         <Cutscene Name="gHyruleFieldGateEponaJumpCs" Offset="0x10B30"/>
+        <Path Name="spot00_scenePathList_011AB4" Offset="0x11AB4" NumPaths="2"/>
         <Scene Name="spot00_scene" Offset="0x0"/>
         <Texture Name="spot00_scene_Tex_02A198" Format="ia8" Width="8" Height="16" Offset="0x2A198"/>
     </File>
diff --git a/assets/xml/scenes/overworld/spot01.xml b/assets/xml/scenes/overworld/spot01.xml
index cf1e29577c..4a57964115 100644
--- a/assets/xml/scenes/overworld/spot01.xml
+++ b/assets/xml/scenes/overworld/spot01.xml
@@ -1,5 +1,6 @@
 <Root>
     <File Name="spot01_scene" Segment="2">
+        <Path Name="spot01_scenePathList_0003D0" Offset="0x03D0" NumPaths="3"/>
         <Cutscene Name="gKakarikoVillageIntroCs" Offset="0xA540"/>
         <Texture Name="gKakarikoVillageDayWindowTex" OutName="day_window" Format="rgba16" Width="32" Height="64" Offset="0x15B50"/>
         <Texture Name="gKakarikoVillageNightWindowTex" OutName="night_window" Format="rgba16" Width="32" Height="64" Offset="0x16B50"/>
diff --git a/assets/xml/scenes/overworld/spot03.xml b/assets/xml/scenes/overworld/spot03.xml
index 3a1626645e..5dbb965a20 100644
--- a/assets/xml/scenes/overworld/spot03.xml
+++ b/assets/xml/scenes/overworld/spot03.xml
@@ -1,8 +1,7 @@
 <Root>
     <File Name="spot03_scene" Segment="2">
-        <Path Name="gSpot03Path_0002C4" Offset="0x2C4"/>
-        <Path Name="gSpot03Path_006910" Offset="0x6910"/>
-        <Path Name="gSpot03Path_006918" Offset="0x6918"/>
+        <Path Name="spot03_scenePathList_0002BC" Offset="0x02BC" NumPaths="2"/>
+        <Path Name="spot03_scenePathList_006908" Offset="0x6908" NumPaths="3"/>
 
         <Scene Name="spot03_scene" Offset="0x0"/>
     </File>
diff --git a/assets/xml/scenes/overworld/spot04.xml b/assets/xml/scenes/overworld/spot04.xml
index 450c1973a1..3cfc140950 100644
--- a/assets/xml/scenes/overworld/spot04.xml
+++ b/assets/xml/scenes/overworld/spot04.xml
@@ -1,8 +1,7 @@
 <Root>
     <File Name="spot04_scene" Segment="2">
-        <Path Name="gSpot04Path_000314" Offset="0x314"/>
-        <Path Name="gSpot04Path_00031C" Offset="0x31C"/>
-        <Path Name="gSpot04Path_00D730" Offset="0xD730"/>
+        <Path Name="spot04_scenePathList_00030C" Offset="0x030C" NumPaths="3"/>
+        <Path Name="spot04_scenePathList_00D728" Offset="0xD728" NumPaths="2"/>
         <Cutscene Name="gKokiriForestDekuSproutCs" Offset="0xC9D0"/>
         <Cutscene Name="gSpot04Cs_10E20" Offset="0x10E20"/>
 
diff --git a/assets/xml/scenes/overworld/spot05.xml b/assets/xml/scenes/overworld/spot05.xml
index b34df91e91..b799f21d1e 100644
--- a/assets/xml/scenes/overworld/spot05.xml
+++ b/assets/xml/scenes/overworld/spot05.xml
@@ -4,11 +4,7 @@
 
         <Cutscene Name="spot05_scene_Cs_005730" Offset="0x5730"/>
 
-        <Path Name="gSpot05Path_0069D8" Offset="0x69D8"/>
-        <Path Name="gSpot05Path_0069E0" Offset="0x69E0"/>
-        <Path Name="gSpot05Path_0069E8" Offset="0x69E8"/>
-        <Path Name="gSpot05Path_0069F0" Offset="0x69F0"/>
-        <Path Name="gSpot05Path_0069F8" Offset="0x69F8"/>
+        <Path Name="spot05_scenePathList_0069D8" Offset="0x69D8" NumPaths="5"/>
 
         <Scene Name="spot05_scene" Offset="0x0"/>
     </File>
diff --git a/assets/xml/scenes/overworld/spot06.xml b/assets/xml/scenes/overworld/spot06.xml
index 9af8c1b637..0c5ccea251 100644
--- a/assets/xml/scenes/overworld/spot06.xml
+++ b/assets/xml/scenes/overworld/spot06.xml
@@ -2,7 +2,7 @@
     <File Name="spot06_scene" Segment="2">
         <Cutscene Name="gLakeHyliaFireArrowsCS" Offset="0x7020"/>
         <Cutscene Name="gLakeHyliaOwlCs" Offset="0x1B0C0"/>
-        <Path Name="gSpot06Path_00776C" Offset="0x776C"/>
+        <Path Name="spot06_scenePathList_007764" Offset="0x7764" NumPaths="2"/>
         <Cutscene Name="gLakeHyliaIntroCs" Offset="0x7A30"/>
         <Scene Name="spot06_scene" Offset="0x0"/>
     </File>
diff --git a/assets/xml/scenes/overworld/spot07.xml b/assets/xml/scenes/overworld/spot07.xml
index 4a1ac4aa76..9b9b5ac667 100644
--- a/assets/xml/scenes/overworld/spot07.xml
+++ b/assets/xml/scenes/overworld/spot07.xml
@@ -1,5 +1,6 @@
 <Root>
     <File Name="spot07_scene" Segment="2">
+        <Path Name="spot07_scenePathList_000234" Offset="0x234" NumPaths="2"/>
         <Cutscene Name="gZorasDomainIntroCs" Offset="0x3D70"/>
         <Texture Name="gZorasDomainDayEntranceTex" OutName="day_entrance" Format="ia8" Width="8" Height="8" Offset="0x8F98"/>
         <Texture Name="gZorasDomainNightEntranceTex" OutName="night_entrance" Format="ia8" Width="8" Height="8" Offset="0x8FD8"/>
diff --git a/assets/xml/scenes/overworld/spot09.xml b/assets/xml/scenes/overworld/spot09.xml
index 038ad1961f..a447c9df44 100644
--- a/assets/xml/scenes/overworld/spot09.xml
+++ b/assets/xml/scenes/overworld/spot09.xml
@@ -3,8 +3,7 @@
         <Cutscene Name="gGerudoValleyBridgeJumpFieldFortressCs" Offset="0x2AC0"/>
         <Cutscene Name="gGerudoValleyBridgeJumpFortressToFieldCs" Offset="0x230"/>
         <Cutscene Name="gGerudoValleyIntroCs" Offset="0x31E0"/>
-        <Path Name="gSpot09Path_002F60" Offset="0x2F60"/>
-        <Path Name="gSpot09Path_002F68" Offset="0x2F68"/>
+        <Path Name="spot09_scenePathList_002F58" Offset="0x2F58" NumPaths="3"/>
 
         <Scene Name="spot09_scene" Offset="0x0"/>
     </File>
diff --git a/assets/xml/scenes/overworld/spot10.xml b/assets/xml/scenes/overworld/spot10.xml
index 9ae2c61e20..58080b9c0c 100644
--- a/assets/xml/scenes/overworld/spot10.xml
+++ b/assets/xml/scenes/overworld/spot10.xml
@@ -1,7 +1,6 @@
 <Root>
     <File Name="spot10_scene" Segment="2">
-        <Path Name="gSpot10Path_00C088" Offset="0xC088"/>
-        <Path Name="gSpot10Path_00C090" Offset="0xC090"/>
+        <Path Name="spot10_scenePathList_00C080" Offset="0xC080" NumPaths="3"/>
 
         <Scene Name="spot10_scene" Offset="0x0"/>
     </File>
diff --git a/assets/xml/scenes/overworld/spot16.xml b/assets/xml/scenes/overworld/spot16.xml
index fa80ec4e18..b6a105c655 100644
--- a/assets/xml/scenes/overworld/spot16.xml
+++ b/assets/xml/scenes/overworld/spot16.xml
@@ -2,6 +2,8 @@
     <File Name="spot16_scene" Segment="2">
         <Cutscene Name="gDMTOwlCs" Offset="0x1E6A0"/>
         <Cutscene Name="gDMTIntroCs" Offset="0x7EA0"/>
+        <Path Name="spot16_scenePathList_000254" Offset="0x254" NumPaths="2"/>
+        <Path Name="spot16_scenePathList_007884" Offset="0x7884" NumPaths="3"/>
         <Scene Name="spot16_scene" Offset="0x0"/>
         <Texture Name="spot16_scene_Tex_01AE98" Format="i4" Width="64" Height="64" Offset="0x1AE98"/>
     </File>
diff --git a/assets/xml/scenes/overworld/spot20.xml b/assets/xml/scenes/overworld/spot20.xml
index d6c1be794f..cc94f8443c 100644
--- a/assets/xml/scenes/overworld/spot20.xml
+++ b/assets/xml/scenes/overworld/spot20.xml
@@ -3,6 +3,7 @@
         <Cutscene Name="gLonLonRanchIntroCs" Offset="0x5BD0"/>
         <Texture Name="gLonLonRanchDayWindowTex" OutName="day_window" Format="rgba16" Width="32" Height="64" Offset="0x81E0"/>
         <Texture Name="gLonLonRangeNightWindowsTex" OutName="night_window" Format="rgba16" Width="32" Height="64" Offset="0xFBE0"/>
+        <Path Name="spot20_scenePathList_005844" Offset="0x5844" NumPaths="2"/>
         <Scene Name="spot20_scene" Offset="0x0"/>
     </File>
     <File Name="spot20_room_0" Segment="3">