Document mirage_tower.c. (Combine fldeff_groundshake.c and fossil_specials.c)

3 files changed, 38 insertions, 31 deletions

diff --git a/include/constants/flags.h b/include/constants/flags.h
index c21affd61..3509b6a3b 100644
--- a/include/constants/flags.h
+++ b/include/constants/flags.h
@@ -162,7 +162,7 @@
 #define FLAG_0x09A               0x9A
 #define FLAG_0x09B               0x9B
 #define FLAG_0x09C               0x9C
-#define FLAG_0x09D               0x9D
+#define FLAG_FORCE_MIRAGE_TOWER_VISIBLE               0x9D
 #define FLAG_0x09E               0x9E
 #define FLAG_0x09F               0x9F
 #define FLAG_0x0A0               0xA0
@@ -344,7 +344,7 @@
 #define FLAG_0x14B               0x14B
 #define FLAG_0x14C               0x14C
 #define FLAG_0x14D               0x14D
-#define FLAG_0x14E               0x14E
+#define FLAG_MIRAGE_TOWER_VISIBLE               0x14E
 #define FLAG_0x14F               0x14F// PLAYER CHOSE CLAW FOSSIL
 #define FLAG_0x150               0x150// PLAYER CHOSE ROOT FOSSIL
 #define FLAG_0x151               0x151
@@ -804,7 +804,7 @@
 #define FLAG_HIDE_TRICK_HOUSE_ENTRANCE_MAN                          0x368 
 #define FLAG_HIDE_LILYCOVE_CONTEST_HALL_POKEBLOCK_EXPERT            0x369 
 #define FLAG_HIDE_DESERT_UNDERPASS_FOSSIL                           0x36A 
-#define FLAG_HIDE_ROUTE_111_DESERT_RIVAL                            0x36B 
+#define FLAG_HIDE_ROUTE_111_PLAYER_DESCENT                            0x36B 
 #define FLAG_HIDE_ROUTE_111_DESERT_FOSSIL                           0x36C 
 #define FLAG_HIDE_MT_CHIMNEY_TRAINERS                               0x36D 
 #define FLAG_HIDE_RUSTURF_TUNNEL_AQUA_GRUNT                         0x36E 
diff --git a/include/mirage_tower.h b/include/mirage_tower.h
new file mode 100644
index 000000000..f98b016b2
--- /dev/null
+++ b/include/mirage_tower.h
@@ -0,0 +1,8 @@
+#ifndef GUARD_MIRAGE_TOWER_H
+#define GUARD_MIRAGE_TOWER_H
+
+void ClearMirageTowerPulseBlendEffect(void);
+void ClearMirageTowerPulseBlend(void);
+void TryStartMirageTowerPulseBlendEffect(void);
+
+#endif // GUARD_MIRAGE_TOWER_H
diff --git a/include/roulette_util.h b/include/roulette_util.h
index 964f551fe..7f0b9cbf8 100644
--- a/include/roulette_util.h
+++ b/include/roulette_util.h
@@ -1,45 +1,44 @@
 #ifndef GUARD_ROULETTE_UTIL_H
 #define GUARD_ROULETTE_UTIL_H
 
-struct InnerStruct203CF18_3
+struct PulseBlendSettings
 {
-    u16 unk0;
-    u16 unk2;
-    u8 unk4;
-    u8 unk5;
-    u8 unk6;
-    s8 unk7_0:4;
-    s8 unk7_4:2;
-    s8 unk7_6:1;
+    u16 blendColor;
+    u16 paletteOffset;
+    u8 numColors;
+    u8 delay;
+    u8 numFadeCycles;
+    s8 maxBlendCoeff:4;
+    s8 fadeType:2;
+    s8 restorePaletteOnUnload:1;
     s8 unk7_7:1;
 };
 
-struct InnerStruct203CF18_2
+struct PulseBlendPalette
 {
-    u8 unk0;
-    u8 unk1_0:4;
-    u8 unk1_4:1;
+    u8 paletteSelector;
+    u8 blendCoeff:4;
+    u8 fadeDirection:1;
     s8 unk1_5:1;
-    s8 unk1_6:1;
-    u32 unk1_7:1;
-    u8 unk2;
-    u8 unk3;
-    struct InnerStruct203CF18_3 unk4;
+    s8 available:1;
+    u32 inUse:1;
+    u8 delayCounter;
+    u8 fadeCycleCounter;
+    struct PulseBlendSettings pulseBlendSettings;
 };
 
-// structures
-struct InnerStruct203CF18
+struct PulseBlend
 {
-    u16 unk0;
-    struct InnerStruct203CF18_2 unk4[16];
+    u16 usedPulseBlendPalettes;
+    struct PulseBlendPalette pulseBlendPalettes[16];
 };
 
-int sub_8151B68(struct InnerStruct203CF18 *, const struct InnerStruct203CF18_3 *);
-void sub_8151B3C(struct InnerStruct203CF18 *);
-void sub_8151CA8(struct InnerStruct203CF18 *, u16, u8);
-void sub_8151C50(struct InnerStruct203CF18 *, u16, u8);
-void sub_8151D28(struct InnerStruct203CF18 *, u16, u8);
-void sub_8151E50(struct InnerStruct203CF18 *);
+int InitPulseBlendPaletteSettings(struct PulseBlend *, const struct PulseBlendSettings *);
+void InitPulseBlend(struct PulseBlend *);
+void MarkUsedPulseBlendPalettes(struct PulseBlend *, u16, u8);
+void UnloadUsedPulseBlendPalettes(struct PulseBlend *, u16, u8);
+void UnmarkUsedPulseBlendPalettes(struct PulseBlend *, u16, u8);
+void UpdatePulseBlend(struct PulseBlend *);
 void sub_8152008(u16 *dest, u16 src, u8 left, u8 top, u8 width, u8 height);
 void sub_8152058(u16 *dest, u16 *src, u8 left, u8 top, u8 width, u8 height);