Merge pull request #1525 from GriffinRichards/doc-recmix

Document remainder of Record Mixing

1 files changed, 12 insertions, 10 deletions

diff --git a/src/mail_data.c b/src/mail_data.c
index 2ae9bedab..683bd854e 100644
--- a/src/mail_data.c
+++ b/src/mail_data.c
@@ -7,15 +7,17 @@
 #include "international_string_util.h"
 #include "constants/easy_chat.h"
 
-void ClearMailData(void)
+#define UNOWN_OFFSET 30000
+
+void ClearAllMail(void)
 {
     u8 i;
 
     for (i = 0; i < MAIL_COUNT; i++)
-        ClearMailStruct(&gSaveBlock1Ptr->mail[i]);
+        ClearMail(&gSaveBlock1Ptr->mail[i]);
 }
 
-void ClearMailStruct(struct MailStruct *mail)
+void ClearMail(struct Mail *mail)
 {
     s32 i;
 
@@ -41,7 +43,7 @@ bool8 MonHasMail(struct Pokemon *mon)
         return FALSE;
 }
 
-u8 GiveMailToMon(struct Pokemon *mon, u16 itemId)
+u8 GiveMailToMonByItemId(struct Pokemon *mon, u16 itemId)
 {
     u8 heldItem[2];
     u8 id, i;
@@ -83,7 +85,7 @@ u16 SpeciesToMailSpecies(u16 species, u32 personality)
 {
     if (species == SPECIES_UNOWN)
     {
-        u32 species = GetUnownLetterByPersonality(personality) + 30000;
+        u32 species = GetUnownLetterByPersonality(personality) + UNOWN_OFFSET;
         return species;
     }
 
@@ -94,10 +96,10 @@ u16 MailSpeciesToSpecies(u16 mailSpecies, u16 *buffer)
 {
     u16 result;
 
-    if (mailSpecies >= 30000 && mailSpecies < (30000 + NUM_UNOWN_FORMS))
+    if (mailSpecies >= UNOWN_OFFSET && mailSpecies < UNOWN_OFFSET + NUM_UNOWN_FORMS)
     {
         result = SPECIES_UNOWN;
-        *buffer = mailSpecies - 30000;
+        *buffer = mailSpecies - UNOWN_OFFSET;
     }
     else
     {
@@ -107,11 +109,11 @@ u16 MailSpeciesToSpecies(u16 mailSpecies, u16 *buffer)
     return result;
 }
 
-u8 GiveMailToMon2(struct Pokemon *mon, struct MailStruct *mail)
+u8 GiveMailToMon(struct Pokemon *mon, struct Mail *mail)
 {
     u8 heldItem[2];
     u16 itemId = mail->itemId;
-    u8 mailId = GiveMailToMon(mon, itemId);
+    u8 mailId = GiveMailToMonByItemId(mon, itemId);
 
     if (mailId == MAIL_NONE)
         return MAIL_NONE;
@@ -169,7 +171,7 @@ u8 TakeMailFromMon2(struct Pokemon *mon)
     {
         if (gSaveBlock1Ptr->mail[i].itemId == ITEM_NONE)
         {
-            memcpy(&gSaveBlock1Ptr->mail[i], &gSaveBlock1Ptr->mail[GetMonData(mon, MON_DATA_MAIL)], sizeof(struct MailStruct));
+            memcpy(&gSaveBlock1Ptr->mail[i], &gSaveBlock1Ptr->mail[GetMonData(mon, MON_DATA_MAIL)], sizeof(struct Mail));
             gSaveBlock1Ptr->mail[GetMonData(mon, MON_DATA_MAIL)].itemId = ITEM_NONE;
             SetMonData(mon, MON_DATA_MAIL, &newMailId);
             SetMonData(mon, MON_DATA_HELD_ITEM, newHeldItem);