pret · lhearachel · Jan 22, 2025 · Jan 19, 2025 · Jan 19, 2025 · Jan 19, 2025
diff --git a/.github/workflows/pr-lint.yml b/.github/workflows/pr-lint.yml
@@ -22,7 +22,7 @@ jobs:
         with:
           style: 'file' # Use repository .clang-format file
           tidy-checks: '-*' # Disable clang-tidy checks
-          version: '18'
+          version: '19'
           files-changed-only: false # Github returns error code 406 if more than 300 files are changed in a PR
           ignore: '.github|lib|subprojects|tools'
           file-annotations: false

diff --git a/asm/macros/scrcmd.inc b/asm/macros/scrcmd.inc
@@ -2797,7 +2797,7 @@
     .short 517
     .endm
 
-    .macro ScrCmd_206
+    .macro StartGreatMarshLookout
     .short 518
     .endm
 

diff --git a/include/great_marsh_lookout.h b/include/great_marsh_lookout.h
@@ -0,0 +1,10 @@
+#ifndef POKEPLATINUM_GREAT_MARSH_LOOKOUT_H
+#define POKEPLATINUM_GREAT_MARSH_LOOKOUT_H
+
+#include "field/field_system_decl.h"
+
+#define BINOCULARS_CYCLE_COUNT 5
+
+void GreatMarshLookout_Init(FieldSystem *fieldSystem);
+
+#endif // POKEPLATINUM_GREAT_MARSH_LOOKOUT_H
diff --git a/include/inlines.h b/include/inlines.h
@@ -158,19 +158,18 @@ static inline u16 ScriptContext_GetVar(ScriptContext *ctx)
     return FieldSystem_TryGetVar(ctx->fieldSystem, ScriptContext_ReadHalfWord(ctx));
 }
 
-inline u16 inline_020564D0(const u16 param0)
+// Functionally equivalent to LCRNG_Next() % param
+inline u16 LCRNG_RandMod(const u16 param)
 {
-    GF_ASSERT(param0 != 0);
+    GF_ASSERT(param != 0);
 
-    if (param0 <= 1) {
+    if (param <= 1) {
         return 0;
     } else {
-        u16 v0;
-        u16 v1;
-        v0 = (0xffff / param0) + 1;
-        v1 = LCRNG_Next() / v0;
+        u16 v0 = (0xffff / param) + 1;
+        u16 v1 = LCRNG_Next() / v0;
 
-        GF_ASSERT(v1 < param0);
+        GF_ASSERT(v1 < param);
         return v1;
     }
 }

diff --git a/include/overlay006/ov6_022477B8.h → include/overlay006/dual_slot_encounters.h b/include/overlay006/ov6_022477B8.h → include/overlay006/dual_slot_encounters.h
@@ -1,8 +1,8 @@
-#ifndef POKEPLATINUM_OV6_022477B8_H
-#define POKEPLATINUM_OV6_022477B8_H
+#ifndef POKEPLATINUM_DUAL_SLOT_ENCOUNTERS_H
+#define POKEPLATINUM_DUAL_SLOT_ENCOUNTERS_H
 
 #include "overlay006/wild_encounters.h"
 
 void WildEncounters_ReplaceDualSlotEncounters(const WildEncounters *encounterData, const BOOL param1, int *param2, int *param3);
 
-#endif // POKEPLATINUM_OV6_022477B8_H
+#endif // POKEPLATINUM_DUAL_SLOT_ENCOUNTERS_H
diff --git a/include/overlay006/great_marsh_binoculars.h b/include/overlay006/great_marsh_binoculars.h
@@ -0,0 +1,28 @@
+#ifndef POKEPLATINUM_GREAT_MARSH_BINOCULARS_H
+#define POKEPLATINUM_GREAT_MARSH_BINOCULARS_H
+
+#include "field/field_system_decl.h"
+
+#include "great_marsh_lookout.h"
+#include "location.h"
+
+typedef struct BinocularCoords {
+    u16 x;
+    u16 z;
+} BinocularCoords;
+
+// Data used to control the map view displayed while using the Great Marsh lookout binoculars.
+typedef struct GreatMarshBinoculars {
+    BinocularCoords coordsList[BINOCULARS_CYCLE_COUNT + 1];
+    Location viewLocation;
+    FieldSystem *fieldSystem;
+    int lookoutMapId;
+} GreatMarshBinoculars;
+
+int GreatMarshBinoculars_GetMonSpecies(FieldSystem *fieldSystem);
+GreatMarshBinoculars *GreatMarshBinoculars_InitData(const int heapId, FieldSystem *fieldSystem);
+void GreatMarshBinoculars_FreeData(GreatMarshBinoculars *data);
+void GreatMarshBinoculars_SetNextLocationWithCoords(const u8 cycleNum, GreatMarshBinoculars *binocularsData);
+Location *GreatMarshBinoculars_GetLocation(GreatMarshBinoculars *binocData);
+
+#endif // POKEPLATINUM_GREAT_MARSH_BINOCULARS_H
diff --git a/include/overlay006/great_marsh_daily_encounters.h b/include/overlay006/great_marsh_daily_encounters.h
@@ -0,0 +1,6 @@
+#ifndef POKEPLATINUM_MARSH_DAILY_ENCOUNTERS_H
+#define POKEPLATINUM_MARSH_DAILY_ENCOUNTERS_H
+
+void ReplaceGreatMarshDailyEncounters(const int dailyMon, const BOOL nationalDexObtained, const int mapId, int *encounterSlot1, int *encounterSlot2);
+
+#endif // POKEPLATINUM_MARSH_DAILY_ENCOUNTERS_H
diff --git a/include/overlay006/ov6_022426AC.h b/include/overlay006/ov6_022426AC.h
@@ -1,14 +1,31 @@
 #ifndef POKEPLATINUM_OV6_022426AC_H
 #define POKEPLATINUM_OV6_022426AC_H
 
-#include "overlay006/struct_ov6_022426B8_decl.h"
-
-UnkStruct_ov6_022426B8 *ov6_022426AC(const int param0);
-void ov6_022426B8(UnkStruct_ov6_022426B8 *param0);
-void ov6_022426C0(UnkStruct_ov6_022426B8 *param0, const int param1);
-void ov6_022427F4(UnkStruct_ov6_022426B8 *param0);
-void ov6_02242814(UnkStruct_ov6_022426B8 *param0);
-BOOL ov6_02242820(UnkStruct_ov6_022426B8 *param0);
-void ov6_02242828(UnkStruct_ov6_022426B8 *param0);
+#include "struct_defs/archived_sprite.h"
+#include "struct_defs/struct_0200C738.h"
+
+#include "cell_actor.h"
+#include "sprite_resource.h"
+
+typedef struct GreatMarshLookout_SpriteResources {
+    SpriteResourceCollection *unk_00[4];
+    SpriteResource *unk_10[4];
+    void *unk_20;
+    void *unk_24;
+    ArchivedSprite unk_28;
+    CellActorCollection *unk_38;
+    UnkStruct_0200C738 unk_3C;
+    CellActor *unk_1C8;
+    BOOL unk_1CC;
+    BOOL unk_1D0;
+} GreatMarshLookout_SpriteResources;
+
+GreatMarshLookout_SpriteResources *GreatMarshLookout_AllocSpriteResources(const int heapId);
+void GreatMarshLookout_FreeSpriteResources(GreatMarshLookout_SpriteResources *resources);
+void GreatMarshLookout_CreateLookoutMonSprite(GreatMarshLookout_SpriteResources *resources, const int species);
+void ov6_022427F4(GreatMarshLookout_SpriteResources *param0);
+void ov6_02242814(GreatMarshLookout_SpriteResources *param0);
+BOOL ov6_02242820(GreatMarshLookout_SpriteResources *param0);
+void ov6_02242828(GreatMarshLookout_SpriteResources *param0);
 
 #endif // POKEPLATINUM_OV6_022426AC_H
diff --git a/include/overlay006/ov6_02242984.h b/include/overlay006/ov6_02242984.h
diff --git a/include/overlay006/ov6_02242F74.h b/include/overlay006/ov6_02242F74.h
diff --git a/include/overlay006/struct_ov6_022426B8_decl.h b/include/overlay006/struct_ov6_022426B8_decl.h
diff --git a/include/overlay006/struct_ov6_02242A8C_decl.h b/include/overlay006/struct_ov6_02242A8C_decl.h
diff --git a/include/roaming_pokemon.h b/include/roaming_pokemon.h
@@ -13,12 +13,12 @@
 #define ROAMING_SLOT_ARTICUNO  (5)
 #define ROAMING_SLOT_MAX       (6)
 
-void sub_0206C33C(UnkStruct_0202D7B0 *param0, const u8 param1);
-void sub_0206C354(UnkStruct_0202D7B0 *param0);
-void sub_0206C37C(UnkStruct_0202D7B0 *param0);
+void sub_0206C33C(SpecialEncounter *param0, const u8 param1);
+void sub_0206C354(SpecialEncounter *param0);
+void sub_0206C37C(SpecialEncounter *param0);
 int sub_0206C3C8(const u8 param0);
-BOOL sub_0206C3E0(UnkStruct_0202D7B0 *param0);
-void sub_0206C404(UnkStruct_0202D7B0 *param0, const int param1);
+BOOL sub_0206C3E0(SpecialEncounter *param0);
+void sub_0206C404(SpecialEncounter *param0, const int param1);
 void RoamingPokemon_ActivateSlot(SaveData *saveData, const u8 speciesID);
 
 #endif // POKEPLATINUM_ROAMING_POKEMON_H
diff --git a/include/struct_defs/struct_0202D7B0.h b/include/struct_defs/struct_0202D7B0.h
@@ -7,19 +7,19 @@
 #include "struct_defs/struct_020698E4.h"
 #include "struct_defs/struct_0206C638.h"
 
-typedef struct {
-    int unk_00;
-    int unk_04;
-    UnkStruct_0202D7B0_sub1 unk_08;
+typedef struct SpecialEncounter {
+    int marshDaily;
+    int swarmDaily;
+    SpecialEncounter_sub1 unk_08;
     UnkStruct_0202D844 unk_10;
     UnkStruct_020698E4 unk_BC;
-    UnkStruct_0202D7B0_sub2 unk_C8;
-    UnkStruct_0206C638 unk_D0[6];
+    SpecialEncounter_sub2 unk_C8;
+    Roamer unk_D0[6];
     u8 unk_148[6];
     u8 unk_14E;
     u8 unk_14F;
     u8 unk_150;
     u8 unk_151;
-} UnkStruct_0202D7B0;
+} SpecialEncounter;
 
 #endif // POKEPLATINUM_STRUCT_0202D7B0_H
diff --git a/include/struct_defs/struct_0202D7B0_sub1.h b/include/struct_defs/struct_0202D7B0_sub1.h
@@ -5,6 +5,6 @@ typedef struct {
     BOOL unk_00;
     u16 unk_04;
     u16 unk_06;
-} UnkStruct_0202D7B0_sub1;
+} SpecialEncounter_sub1;
 
 #endif // POKEPLATINUM_STRUCT_0202D7B0_SUB1_H
diff --git a/include/struct_defs/struct_0202D7B0_sub2.h b/include/struct_defs/struct_0202D7B0_sub2.h
@@ -4,6 +4,6 @@
 typedef struct {
     int unk_00;
     int unk_04;
-} UnkStruct_0202D7B0_sub2;
+} SpecialEncounter_sub2;
 
 #endif // POKEPLATINUM_STRUCT_0202D7B0_SUB2_H
diff --git a/include/struct_defs/struct_0206C638.h b/include/struct_defs/struct_0206C638.h
@@ -10,6 +10,6 @@ typedef struct {
     u8 unk_10;
     u8 unk_11;
     u8 unk_12;
-} UnkStruct_0206C638;
+} Roamer;
 
 #endif // POKEPLATINUM_STRUCT_0206C638_H
diff --git a/include/unk_0202D7A8.h b/include/unk_0202D7A8.h
@@ -9,33 +9,37 @@
 
 #include "savedata.h"
 
+// for SpecialEncounter_GetDailyMon
+#define DAILY_MARSH 1
+#define DAILY_SWARM 2
+
 int SpecialEncounter_SaveSize(void);
-void SpecialEncounter_Init(UnkStruct_0202D7B0 *param0);
-void sub_0202D80C(UnkStruct_0202D7B0 *param0, const u32 param1);
-u32 sub_0202D814(UnkStruct_0202D7B0 *param0, const u8 param1);
-UnkStruct_020698E4 *sub_0202D830(UnkStruct_0202D7B0 *param0);
-UnkStruct_0202D7B0 *sub_0202D834(SaveData *param0);
-UnkStruct_0202D844 *sub_0202D840(UnkStruct_0202D7B0 *param0);
+void SpecialEncounter_Init(SpecialEncounter *param0);
+void SpecialEncounter_SetMixedRecordDailies(SpecialEncounter *speEnc, const u32 mixedRecord);
+u32 SpecialEncounter_GetDailyMon(SpecialEncounter *param0, const u8 dailyType);
+UnkStruct_020698E4 *sub_0202D830(SpecialEncounter *param0);
+SpecialEncounter *SaveData_GetSpecialEncounters(SaveData *param0);
+UnkStruct_0202D844 *sub_0202D840(SpecialEncounter *param0);
 const int sub_0202D844(UnkStruct_0202D844 *param0);
 void sub_0202D848(const u8 param0, UnkStruct_0202D844 *param1);
 UnkStruct_0202D84C *sub_0202D84C(const u8 param0, UnkStruct_0202D844 *param1);
 void sub_0202D854(SaveData *param0, const int param1);
 void sub_0202D884(SaveData *param0);
-u8 sub_0202D898(UnkStruct_0202D7B0 *param0);
-void sub_0202D8A4(UnkStruct_0202D7B0 *param0, const int param1);
-int sub_0202D8BC(UnkStruct_0202D7B0 *param0);
-u8 sub_0202D8C4(UnkStruct_0202D7B0 *param0, const u8 param1);
-void sub_0202D8DC(UnkStruct_0202D7B0 *param0, const u8 param1, const u8 param2);
-u8 sub_0202D8F8(UnkStruct_0202D7B0 *param0, const u8 param1);
-void sub_0202D914(UnkStruct_0206C638 **param0);
-UnkStruct_0206C638 *sub_0202D924(UnkStruct_0202D7B0 *param0, const u8 param1);
-u32 sub_0202D93C(const UnkStruct_0206C638 *param0, const u8 param1);
-void sub_0202D980(UnkStruct_0206C638 *param0, const u8 param1, const u32 param2);
-u8 *sub_0202D9C4(UnkStruct_0202D7B0 *param0);
-u8 *sub_0202D9CC(UnkStruct_0202D7B0 *param0);
-BOOL sub_0202D9D8(UnkStruct_0202D7B0 *param0);
-void sub_0202D9EC(UnkStruct_0202D7B0 *param0, const u8 param1);
-u8 sub_0202DA04(UnkStruct_0202D7B0 *param0);
+u8 sub_0202D898(SpecialEncounter *param0);
+void sub_0202D8A4(SpecialEncounter *param0, const int param1);
+int sub_0202D8BC(SpecialEncounter *param0);
+u8 sub_0202D8C4(SpecialEncounter *param0, const u8 param1);
+void sub_0202D8DC(SpecialEncounter *param0, const u8 param1, const u8 param2);
+u8 sub_0202D8F8(SpecialEncounter *param0, const u8 param1);
+void sub_0202D914(Roamer **param0);
+Roamer *sub_0202D924(SpecialEncounter *param0, const u8 param1);
+u32 sub_0202D93C(const Roamer *param0, const u8 param1);
+void sub_0202D980(Roamer *param0, const u8 param1, const u32 param2);
+u8 *sub_0202D9C4(SpecialEncounter *param0);
+u8 *sub_0202D9CC(SpecialEncounter *param0);
+BOOL sub_0202D9D8(SpecialEncounter *param0);
+void sub_0202D9EC(SpecialEncounter *param0, const u8 param1);
+u8 sub_0202DA04(SpecialEncounter *param0);
 void sub_0202DA10(SaveData *param0, u16 *param1, u16 *param2);
 void sub_0202DA24(SaveData *param0, const u16 param1);
 

diff --git a/include/unk_0206C0E8.h b/include/unk_0206C0E8.h
diff --git a/platinum.us/main.lsf b/platinum.us/main.lsf
@@ -266,7 +266,7 @@ Static main
 	Object main.nef.p/src_unk_0206AFE0.c.o
 	Object main.nef.p/src_unk_0206B70C.c.o
 	Object main.nef.p/src_unk_0206B9D8.c.o
-	Object main.nef.p/src_unk_0206C0E8.c.o
+	Object main.nef.p/src_great_marsh_lookout.c.o
 	Object main.nef.p/src_unk_0206C2D0.c.o
 	Object main.nef.p/src_roaming_pokemon.c.o
 	Object main.nef.p/src_unk_0206C660.c.o
@@ -566,9 +566,9 @@ Overlay overlay6
 	Object main.nef.p/src_overlay006_ov6_0223E140.c.o
 	Object main.nef.p/src_overlay006_ov6_02240C9C.c.o
 	Object main.nef.p/src_overlay006_ov6_022426AC.c.o
-	Object main.nef.p/src_overlay006_ov6_02242984.c.o
+	Object main.nef.p/src_overlay006_great_marsh_binoculars.c.o
 	Object main.nef.p/src_overlay006_ov6_02242AF0.c.o
-	Object main.nef.p/src_overlay006_ov6_02242F74.c.o
+	Object main.nef.p/src_overlay006_great_marsh_daily_encounters.c.o
 	Object main.nef.p/src_overlay006_ov6_02243004.c.o
 	Object main.nef.p/src_overlay006_ov6_022430C4.c.o
 	Object main.nef.p/src_overlay006_ov6_02243218.c.o
@@ -586,7 +586,7 @@ Overlay overlay6
 	Object main.nef.p/src_overlay006_ov6_02247100.c.o
 	Object main.nef.p/src_overlay006_ov6_022475B0.c.o
 	Object main.nef.p/src_overlay006_ov6_02247660.c.o
-	Object main.nef.p/src_overlay006_ov6_022477B8.c.o
+	Object main.nef.p/src_overlay006_dual_slot_encounters.c.o
 	Object main.nef.p/src_overlay006_ov6_02247830.c.o
 	Object main.nef.p/src_overlay006_ov6_02247A0C.c.o
 	Object main.nef.p/src_overlay006_ov6_02247D30.c.o

diff --git a/res/field/scripts/scripts_pastoria_city_observatory_gate_2f.s b/res/field/scripts/scripts_pastoria_city_observatory_gate_2f.s
@@ -29,7 +29,7 @@ _003E:
     PlayFanfare SEQ_SE_DP_REGI
     WaitFanfare SEQ_SE_DP_REGI
     ScrCmd_073
-    ScrCmd_206
+    StartGreatMarshLookout
     ReleaseAll
     End
 

diff --git a/src/catching_show.c b/src/catching_show.c
@@ -176,7 +176,7 @@ static int NumMonsCaptured(CatchingShow *catchingShow)
 
 static void ResetStepCount(CatchingShow *catchingShow)
 {
-    catchingShow->steps = inline_020564D0(10) + 5;
+    catchingShow->steps = LCRNG_RandMod(10) + 5;
 }
 
 static BOOL IsStepCountZero(CatchingShow *catchingShow)
@@ -226,7 +226,7 @@ static BOOL TryStartEncounter(FieldSystem *fieldSystem, CatchingShow *catchingSh
         return FALSE;
     }
 
-    encounterChance = inline_020564D0(totalRarity + WEIGHT_NO_ENCOUNTER);
+    encounterChance = LCRNG_RandMod(totalRarity + WEIGHT_NO_ENCOUNTER);
 
     if (encounterChance < WEIGHT_NO_ENCOUNTER) {
         return FALSE;