Random doc/clean

2026-09-30 04:47:58 -05:00 · 2026-02-03 18:24:17 -05:00
parent 6d8ff1950b
commit f631e58e81
59 changed files with 1142 additions and 1120 deletions
--- a/include/code_8004AA0.h
+++ b/include/code_8004AA0.h
@@ -1,9 +1,8 @@
 #ifndef GUARD_CODE_8004AA0_H
 #define GUARD_CODE_8004AA0_H

-#include "file_system.h"
-#include "structs/rgb.h"
 #include "structs/str_202EE8C.h"
+#include "structs/str_file_system.h"

 extern unkStruct_202EE8C gUnknown_202EE8C[32];

@@ -18,6 +17,7 @@ typedef struct unkDataFor8004AA4
 void nullsub_6(void);
 void sub_8004AA4(unkStruct_202EE8C *, OpenedFile *, s32);
 bool8 sub_8004AF0(bool8, unkStruct_202EE8C *, s32, s32, s32, const RGB_Struct *);
+bool8 sub_8004C00(unkStruct_202EE8C *a0, s32 a1, s32 a2, s32 brightness, const RGB_Struct *ramp, RGB_Struct16 *a5);
 bool8 sub_8004D14(unkStruct_202EE8C *, s32);
 bool8 sub_8004D40(unkStruct_202EE8C *, s32);

--- a/include/code_800D090.h
+++ b/include/code_800D090.h
@@ -3,4 +3,8 @@

 void sprintfStatic(char *buffer, const char *text, ...);

+bool8 sub_800D588(void);
+void sub_800D6AC(void);
+void sub_800D7D0(void);
+
 #endif // GUARD_CODE_800D090_H
--- a/include/code_802DB28.h
+++ b/include/code_802DB28.h
@@ -1,24 +0,0 @@
-#ifndef GUARD_CODE_802DB28_H
-#define GUARD_CODE_802DB28_H
-
-#include "structs/str_mon_portrait.h"
-#include "structs/str_text.h"
-#include "structs/str_wonder_mail.h"
-
-// size: 0xA8
-struct unkStruct_203B2FC
-{
-    /* 0x0 */ u32 state;
-    /* 0x4 */ u32 fallbackState;
-    unkStruct_802F204 unk8;
-    /* 0x30 */ u8 jobSlotIndex;
-    /* 0x34 */ WonderMail *jobInfo;
-    /* 0x38 */ MonPortraitMsg monPortrait;
-    WindowTemplates unk48;
-};
-
-bool8 sub_802DB28(u8 jobSlotIndex, u8 dungeon);
-u32 sub_802DBD4(void);
-void sub_802DC00(void);
-
-#endif // GUARD_CODE_802DB28_H
--- a/include/code_802F204.h
+++ b/include/code_802F204.h
@@ -1,10 +0,0 @@
-#ifndef GUARD_CODE_802F204_H
-#define GUARD_CODE_802F204_H
-
-#include "structs/str_wonder_mail.h"
-
-u32 sub_802F204(unkStruct_802F204 *, bool8 displayClientSprite);
-u32 sub_802F298(void);
-void sub_802F2C0(void);
-
-#endif // GUARD_CODE_802F204_H
--- a/include/code_803C1D0.h
+++ b/include/code_803C1D0.h
@@ -1,10 +1,11 @@
 #ifndef GUARD_CODE_803C1D0_H
 #define GUARD_CODE_803C1D0_H

+#include "structs/str_mission_rewards.h"
 #include "structs/str_wonder_mail.h"

 u8 sub_803C1D0(DungeonLocation *, u8);
 const u8 *GetMissionRankText(u8 index);
-void sub_803C21C(WonderMail *, unkStruct_802F204 *);
+void sub_803C21C(WonderMail *, MissionRewards *);

 #endif // GUARD_CODE_803C1D0_H
--- a/include/constants/wonder_mail.h
+++ b/include/constants/wonder_mail.h
@@ -1,20 +1,5 @@
 #ifndef GUARD_CONSTANTS_WONDER_MAIL_H
-#define GUARD_CONSTANTS_WONDER_MAIL_H 
-
-enum RewardType
-{
-    MONEY,
-    MONEY_EXTRA,
-    ITEM,
-    ITEM_EXTRA,
-    BLANK_4,
-    MONEY1,
-    MONEY1_EXTRA,
-    ITEM1,
-    ITEM1_EXTRA,
-    FRIEND_AREA,
-    END_REWARDS
-};
+#define GUARD_CONSTANTS_WONDER_MAIL_H

 enum WonderMailMode
 {
@@ -77,10 +62,8 @@ enum WonderMailMissionTypes

 #define MAIL_STATUS_SUSPENDED 0

-
 #define NUM_POKEMON_NEWS 56 // 50 normal + 6 special issues
 #define PASSWORD_BUFFER_SIZE 54
-#define MAX_ITEM_REWARDS 3


-#endif //GUARD_CONSTANTS_WONDER_MAIL_H
+#endif // GUARD_CONSTANTS_WONDER_MAIL_H
--- a/include/dungeon_cutscenes.h
+++ b/include/dungeon_cutscenes.h
@@ -78,9 +78,11 @@ void sub_8088618(void);
 void sub_808862C(void);
 void sub_80886C4(void);
 void sub_808875C(void);
+void sub_8088848(void);
 void HandleGroudonBossFaint(u8, u8);
 void sub_8088DC0(void);
 void sub_8088E5C(void);
+void sub_8088EE8(void);
 void sub_8089168(void);
 void sub_80892C8(void);
 void sub_8089328(void);
@@ -107,6 +109,7 @@ void sub_808A308(void);
 void HandleSuicuneBossFaint(u8, u8);
 void sub_808A608(void);
 void sub_808A668(void);
+void sub_808A718(void);
 void HandleHoOhBossFaint(u8, u8);
 void sub_808A9E4(void);
 void sub_808AA3C(void);
--- a/include/file_system.h
+++ b/include/file_system.h
@@ -30,4 +30,6 @@ u32 SetFileSystemUnk(u32 value);

 #define TRY_CLOSE_FILE_AND_SET_NULL(filePtr) if (filePtr != NULL) CLOSE_FILE_AND_SET_NULL(filePtr)

+#define TRY_CLOSE_FILE(filePtr) if (filePtr != NULL) CloseFile(filePtr)
+
 #endif // GUARD_FILE_SYSTEM_H
--- a/include/friend_rescue.h
+++ b/include/friend_rescue.h
@@ -5,6 +5,7 @@
 #include "items.h"
 #include "pokemon.h"
 #include "structs/menu.h"
+#include "structs/str_mission_rewards.h"
 #include "structs/str_wonder_mail.h"

 // size: 0x568
@@ -36,7 +37,7 @@ typedef struct WonderMailStruct_203B33C
    u32 unk530;
    u32 unk534;
    /* 0x538 */ s16 speciesNum; // A7 << 3
-    unkStruct_802F204 unk53C;
+    /* 0x53C */ MissionRewards rewards;
    s32 unk564;
 } WonderMailStruct_203B33C;

--- a/include/graphics_memory.h
+++ b/include/graphics_memory.h
@@ -14,6 +14,7 @@ struct unkStruct_8009A1C_ptr
 void ResetVramPalOAM(void);
 void sub_8009A1C(const EfoFileData *r0, u32 palId, u32 vramDstOffset, u32 r3);
 void InitFontPalette(void);
+void InitGraphics(void);
 void ResetScheduledMemCopies(void);
 void ScheduleMemCopy(u32 *, const u32 *, u32);
 void ScheduleBgTilemapCopy(u32);
--- a/include/mission_reward.h
+++ b/include/mission_reward.h
@@ -0,0 +1,10 @@
+#ifndef GUARD_MISSION_REWARD_H
+#define GUARD_MISSION_REWARD_H
+
+#include "structs/str_mission_rewards.h"
+
+bool8 MR_Create(MissionRewards *rewards, bool8 displayClientSprite);
+u32 MR_Update(void);
+void MR_Destroy(void);
+
+#endif // GUARD_MISSION_REWARD_H
--- a/include/rescue_team_info.h
+++ b/include/rescue_team_info.h
@@ -13,28 +13,27 @@ enum TeamRanks
    MAX_TEAM_RANKS
 };

-struct RescueTeamData
+typedef struct RescueTeamData
 {
    u8 teamName[TEAM_NAME_LENGTH];
    s32 teamRankPts;
    bool8 isTeamRenamed;
-};
+} RescueTeamData;

-extern struct RescueTeamData *gRescueTeamInfoRef;
+extern RescueTeamData *gRescueTeamInfoRef;

 void LoadRescueTeamInfo(void);
-struct RescueTeamData *GetRescueTeamInfo(void);
+RescueTeamData *GetRescueTeamInfo(void);
 void InitializeRescueTeamInfo(void);
-void sub_80920B8(u8 *buffer);
-void sub_80920D8(u8 *buffer);
+void CopyTeamNameToBuffer(u8 *buffer);
+void StrncpyTeamName(u8 *buffer);
 void SetRescueTeamName(u8 *buffer);
 s32 GetTeamRankPts(void);
 s32 GetPtsToNextRank(void);
 void AddToTeamRankPts(s32 newPts);
 u8 GetRescueTeamRank(void);
 const u8 *GetTeamRankString(u32 index);
-u8 GetIsTeamRenamed(void);
-u32 SaveRescueTeamInfo(u8 *param_1,u32 param_2);
-u32 ReadRescueTeamInfo(u8 *param_1, u32 param_2);
+u32 SaveRescueTeamInfo(u8 *buffer, u32 bufLen);
+u32 ReadRescueTeamInfo(u8 *buffer, u32 bufLen);

 #endif // GUARD_RESCUE_TEAM_INFO_H
--- a/include/save.h
+++ b/include/save.h
@@ -59,7 +59,7 @@ typedef struct UnkStruct_203B184
    /* 0x10 */ u32 *unk10;
    /* 0x14 */ unkStruct_203B48C *unk14;
    /* 0x18 */ unkStruct_203B490 *mailInfo;
-    /* 0x1C */ struct RescueTeamData *RescueTeamInfo;
+    /* 0x1C */ RescueTeamData *RescueTeamInfo;
    /* 0x20 */ struct unkStruct_203B494 *unk20;
    /* 0x24 */ ExclusivePokemonData *exclusivePokemon;
    /* 0x28 */ bool8 *BoughtFriendAreas;
--- a/include/structs/rgb.h
+++ b/include/structs/rgb.h
@@ -10,6 +10,14 @@ typedef struct RGB_Struct
    u8 unk4; // Never read, always 0x80. Unused transparency/alpha flag?
 } RGB_Struct;

+// Size: R=0x8 | B=0x6
+typedef struct RGB_Struct16
+{
+    s16 r;
+    s16 g;
+    s16 b;
+} RGB_Struct16;
+
 #define RGB_R 0
 #define RGB_G 1
 #define RGB_B 2
--- a/include/structs/str_802C39C.h
+++ b/include/structs/str_802C39C.h
@@ -1,6 +1,7 @@
 #ifndef GUARD_STR_802C39C_H
 #define GUARD_STR_802C39C_H

+#include "structs/str_mission_rewards.h"
 #include "structs/str_wonder_mail.h"

 // size: 0x58
@@ -12,7 +13,7 @@ typedef struct unkStruct_802C39C
    /* 0x10 */ s16 clientSpecies;
    /* 0x12 */ s16 targetSpecies;
    /* 0x14 */ u8 targetItem;
-    /* 0x18 */ unkStruct_802F204 unk18;
+    /* 0x18 */ MissionRewards rewards;
    /* 0x40 */ u8 mailTitleType;
    /* 0x41 */ u8 mailDescriptionType;
    /* 0x42 */ u8 mailMissionType;
--- a/include/structs/str_mission_rewards.h
+++ b/include/structs/str_mission_rewards.h
@@ -0,0 +1,35 @@
+#ifndef GUARD_STR_MISSION_REWARDS_H
+#define GUARD_STR_MISSION_REWARDS_H
+
+#define MAX_ITEM_REWARDS 3
+
+enum RewardType
+{
+    MONEY,
+    MONEY_EXTRA,
+    ITEM,
+    ITEM_EXTRA,
+    BLANK_4,
+    MONEY1,
+    MONEY1_EXTRA,
+    ITEM1,
+    ITEM1_EXTRA,
+    FRIEND_AREA,
+    END_REWARDS
+};
+
+// Size: 0x28
+typedef struct MissionRewards
+{
+    /* 0x0 */ u8 clientName[POKEMON_NAME_LENGTH];
+    /* 0xA */ u8 name2[POKEMON_NAME_LENGTH]; // target name?
+    /* 0x14 */ s16 clientSpecies;
+    /* 0x16 */ u8 rewardType; // See enum "RewardType"
+    /* 0x18 */ s32 moneyReward;
+    /* 0x1C */ u8 itemRewards[MAX_ITEM_REWARDS];
+    /* 0x1F */ u8 quantity;
+    /* 0x20 */ u8 friendAreaReward;
+    /* 0x24 */ u32 teamRankPtsReward;
+} MissionRewards;
+
+#endif // GUARD_STR_MISSION_REWARDS_H
--- a/include/structs/str_wonder_mail.h
+++ b/include/structs/str_wonder_mail.h
@@ -2,9 +2,8 @@
 #define GUARD_STR_WONDER_MAIL_H

 #include "constants/wonder_mail.h"
-#include "structs/str_dungeon.h"
-#include "structs/str_pokemon.h"
 #include "structs/str_dungeon_mail_seed.h"
+#include "structs/str_pokemon.h"

 // size: 0x14
 typedef struct WonderMail
@@ -21,20 +20,6 @@ typedef struct WonderMail
    /* 0x13 */ u8 friendAreaReward;
 } WonderMail;

-// size: 0x28
-typedef struct unkStruct_802F204
-{
-    /* 0x0 */ u8 clientName[POKEMON_NAME_LENGTH];
-    /* 0xA */ u8 name2[POKEMON_NAME_LENGTH]; // target name?
-    /* 0x14 */ s16 clientSpecies;
-    u8 rewardType;
-    /* 0x18 */ s32 moneyReward;
-    /* 0x1C */ u8 itemRewards[MAX_ITEM_REWARDS];
-    /* 0x1F */ u8 quantity;
-    /* 0x20 */ u8 friendAreaReward;
-    /* 0x24 */ u32 teamRankPtsReward;
-} unkStruct_802F204;
-
 // size: 0xB4
 typedef struct unkStruct_803B344
 {
--- a/include/thank_you_messages.h
+++ b/include/thank_you_messages.h
@@ -0,0 +1,8 @@
+#ifndef GUARD_THANK_YOU_MESSAGES_H
+#define GUARD_THANK_YOU_MESSAGES_H
+
+bool8 TYM_Create(u8 jobSlotIndex, u8 dungeon);
+u32 TYM_Update(void);
+void TYM_Destroy(void);
+
+#endif // GUARD_THANK_YOU_MESSAGES_H
--- a/include/thank_you_wonder_mail.h
+++ b/include/thank_you_wonder_mail.h
@@ -4,9 +4,9 @@
 #include "constants/wonder_mail.h"
 #include "structs/menu.h"
 #include "structs/str_items.h"
+#include "structs/str_mission_rewards.h"
 #include "structs/str_mon_portrait.h"
 #include "structs/str_text.h"
-#include "structs/str_wonder_mail.h"

 // size: 0x564
 typedef struct WonderMailStruct_203B2C4
@@ -30,7 +30,7 @@ typedef struct WonderMailStruct_203B2C4
    /* 0x434 */ u8 formattedString[0x100];
    /* 0x534 */ s32 wonderMailMethod;
    /* 0x538 */ u32 wonderMailMode;
-    unkStruct_802F204 unk53C;
+    /* 0x53C */ MissionRewards rewards;
 } WonderMailStruct_203B2C4;

 void CleanThankYouMailPelipper(void);
--- a/include/wonder_mail_2.h
+++ b/include/wonder_mail_2.h
@@ -1,8 +1,8 @@
 #ifndef GUARD_WONDER_MAIL_2_H
 #define GUARD_WONDER_MAIL_2_H

-u8 sub_802B2D4(void);
-u32 sub_802B358(void);
-void sub_802B3B8(void);
+bool8 WM2_Create(void);
+void WM2_Destroy(void);
+u32 WM2_Update(void);

 #endif // GUARD_WONDER_MAIL_2_H
--- a/include/wonder_mail_3_mid.h
+++ b/include/wonder_mail_3_mid.h
@@ -0,0 +1,6 @@
+#ifndef GUARD_WONDER_MAIL_3_MID_H
+#define GUARD_WONDER_MAIL_3_MID_H
+
+u32 sub_802EF48(void);
+
+#endif // GUARD_WONDER_MAIL_3_MID_H