Merge pull request #1344 from GriffinRichards/doc-ec

Document easy chat and mail, script.c cleanup, add/use some general constants

1 files changed, 14 insertions, 13 deletions

diff --git a/src/mail_data.c b/src/mail_data.c
index e0553af99..2ae9bedab 100644
--- a/src/mail_data.c
+++ b/src/mail_data.c
@@ -5,6 +5,7 @@
 #include "pokemon_icon.h"
 #include "text.h"
 #include "international_string_util.h"
+#include "constants/easy_chat.h"
 
 void ClearMailData(void)
 {
@@ -19,12 +20,12 @@ void ClearMailStruct(struct MailStruct *mail)
     s32 i;
 
     for (i = 0; i < MAIL_WORDS_COUNT; i++)
-        mail->words[i] = 0xFFFF;
+        mail->words[i] = EC_EMPTY_WORD;
 
     for (i = 0; i < PLAYER_NAME_LENGTH + 1; i++)
         mail->playerName[i] = EOS;
 
-    for (i = 0; i < 4; i++)
+    for (i = 0; i < TRAINER_ID_LENGTH; i++)
         mail->trainerId[i] = 0;
 
     mail->species = SPECIES_BULBASAUR;
@@ -34,7 +35,7 @@ void ClearMailStruct(struct MailStruct *mail)
 bool8 MonHasMail(struct Pokemon *mon)
 {
     u16 heldItem = GetMonData(mon, MON_DATA_HELD_ITEM);
-    if (ItemIsMail(heldItem) && GetMonData(mon, MON_DATA_MAIL) != 0xFF)
+    if (ItemIsMail(heldItem) && GetMonData(mon, MON_DATA_MAIL) != MAIL_NONE)
         return TRUE;
     else
         return FALSE;
@@ -52,12 +53,12 @@ u8 GiveMailToMon(struct Pokemon *mon, u16 itemId)
 
     for (id = 0; id < PARTY_SIZE; id++)
     {
-        if (gSaveBlock1Ptr->mail[id].itemId == 0)
+        if (gSaveBlock1Ptr->mail[id].itemId == ITEM_NONE)
         {
             for (i = 0; i < MAIL_WORDS_COUNT; i++)
-                gSaveBlock1Ptr->mail[id].words[i] = 0xFFFF;
+                gSaveBlock1Ptr->mail[id].words[i] = EC_EMPTY_WORD;
 
-            for (i = 0; i < PLAYER_NAME_LENGTH + 1 - 1; i++)
+            for (i = 0; i < PLAYER_NAME_LENGTH; i++)
                 gSaveBlock1Ptr->mail[id].playerName[i] = gSaveBlock2Ptr->playerName[i];
             gSaveBlock1Ptr->mail[id].playerName[i] = EOS;
             PadNameString(gSaveBlock1Ptr->mail[id].playerName, CHAR_SPACE);
@@ -75,7 +76,7 @@ u8 GiveMailToMon(struct Pokemon *mon, u16 itemId)
         }
     }
 
-    return 0xFF;
+    return MAIL_NONE;
 }
 
 u16 SpeciesToMailSpecies(u16 species, u32 personality)
@@ -93,7 +94,7 @@ u16 MailSpeciesToSpecies(u16 mailSpecies, u16 *buffer)
 {
     u16 result;
 
-    if (mailSpecies >= 30000 && mailSpecies < (30000 + UNOWN_FORM_COUNT))
+    if (mailSpecies >= 30000 && mailSpecies < (30000 + NUM_UNOWN_FORMS))
     {
         result = SPECIES_UNOWN;
         *buffer = mailSpecies - 30000;
@@ -112,8 +113,8 @@ u8 GiveMailToMon2(struct Pokemon *mon, struct MailStruct *mail)
     u16 itemId = mail->itemId;
     u8 mailId = GiveMailToMon(mon, itemId);
 
-    if (mailId == 0xFF)
-        return 0xFF;
+    if (mailId == MAIL_NONE)
+        return MAIL_NONE;
 
     gSaveBlock1Ptr->mail[mailId] = *mail;
 
@@ -141,7 +142,7 @@ void TakeMailFromMon(struct Pokemon *mon)
     {
         mailId = GetMonData(mon, MON_DATA_MAIL);
         gSaveBlock1Ptr->mail[mailId].itemId = ITEM_NONE;
-        mailId = 0xFF;
+        mailId = MAIL_NONE;
         heldItem[0] = ITEM_NONE;
         heldItem[1] = ITEM_NONE << 8;
         SetMonData(mon, MON_DATA_MAIL, &mailId);
@@ -162,7 +163,7 @@ u8 TakeMailFromMon2(struct Pokemon *mon)
 
     newHeldItem[0] = ITEM_NONE;
     newHeldItem[1] = ITEM_NONE << 8;
-    newMailId = 0xFF;
+    newMailId = MAIL_NONE;
 
     for (i = PARTY_SIZE; i < MAIL_COUNT; i++)
     {
@@ -176,7 +177,7 @@ u8 TakeMailFromMon2(struct Pokemon *mon)
         }
     }
 
-    return 0xFF;
+    return MAIL_NONE;
 }
 
 bool8 ItemIsMail(u16 itemId)