Document smart shopper TV show

1 files changed, 53 insertions, 46 deletions

diff --git a/src/tv.c b/src/tv.c
index 50adde3f4..b7b490aa3 100644
--- a/src/tv.c
+++ b/src/tv.c
@@ -335,19 +335,19 @@ static const u8 *const sTVPokemonTodaySuccessfulTextGroup[] = {
 };
 
 static const u8 *const sTVTodaysSmartShopperTextGroup[] = {
-    gTVTodaysSmartShopperText00,
-    gTVTodaysSmartShopperText01,
-    gTVTodaysSmartShopperText02,
-    gTVTodaysSmartShopperText03,
-    gTVTodaysSmartShopperText04,
-    gTVTodaysSmartShopperText05,
-    gTVTodaysSmartShopperText06,
-    gTVTodaysSmartShopperText07,
-    gTVTodaysSmartShopperText08,
-    gTVTodaysSmartShopperText09,
-    gTVTodaysSmartShopperText10,
-    gTVTodaysSmartShopperText11,
-    gTVTodaysSmartShopperText12
+    [SMARTSHOPPER_STATE_INTRO]          = SmartShopper_Text_Intro,
+    [SMARTSHOPPER_STATE_CLERK_NORMAL]   = SmartShopper_Text_ClerkNormal,
+    [SMARTSHOPPER_STATE_RAND_COMMENT_1] = SmartShopper_Text_RandomComment1,
+    [SMARTSHOPPER_STATE_RAND_COMMENT_2] = SmartShopper_Text_RandomComment2,
+    [SMARTSHOPPER_STATE_RAND_COMMENT_3] = SmartShopper_Text_RandomComment3,
+    [SMARTSHOPPER_STATE_RAND_COMMENT_4] = SmartShopper_Text_RandomComment4,
+    [SMARTSHOPPER_STATE_SECOND_ITEM]    = SmartShopper_Text_SecondItem,
+    [SMARTSHOPPER_STATE_THIRD_ITEM]     = SmartShopper_Text_ThirdItem,
+    [SMARTSHOPPER_STATE_DURING_SALE]    = SmartShopper_Text_DuringSale,
+    [SMARTSHOPPER_STATE_OUTRO_NORMAL]   = SmartShopper_Text_OutroNormal,
+    [SMARTSHOPPER_STATE_IS_VIP]         = SmartShopper_Text_IsVIP,
+    [SMARTSHOPPER_STATE_CLERK_MAX]      = SmartShopper_Text_ClerkMax,
+    [SMARTSHOPPER_STATE_OUTRO_MAX]      = SmartShopper_Text_OutroMax
 };
 
 static const u8 *const sTVBravoTrainerTextGroup[] = {
@@ -2785,7 +2785,7 @@ size_t CountDigits(int value)
     return 1;
 }
 
-static void sub_80EF40C(u8 varIdx, TVShow *show)
+static void SmartShopper_BufferPurchaseTotal(u8 varIdx, TVShow *show)
 {
     u8 i;
     int price;
@@ -4460,78 +4460,85 @@ static void DoTVShowTodaysSmartShopper(void)
     state = sTVShowState;
     switch(state)
     {
-    case 0:
+    case SMARTSHOPPER_STATE_INTRO:
         TVShowConvertInternationalString(gStringVar1, show->smartshopperShow.playerName, show->smartshopperShow.language);
         GetMapName(gStringVar2, show->smartshopperShow.shopLocation, 0);
         if (show->smartshopperShow.itemAmounts[0] >= 255)
-            sTVShowState = 11;
+            sTVShowState = SMARTSHOPPER_STATE_CLERK_MAX;
         else
-            sTVShowState = 1;
+            sTVShowState = SMARTSHOPPER_STATE_CLERK_NORMAL;
         break;
-    case 1:
+    case SMARTSHOPPER_STATE_CLERK_NORMAL:
         TVShowConvertInternationalString(gStringVar1, show->smartshopperShow.playerName, show->smartshopperShow.language);
         StringCopy(gStringVar2, ItemId_GetName(show->smartshopperShow.itemIds[0]));
         ConvertIntToDecimalString(2, show->smartshopperShow.itemAmounts[0]);
-        sTVShowState += 1 + (Random() % 4);
+        // Pick a random comment (SMARTSHOPPER_STATE_RAND_COMMENT_#)
+        sTVShowState += SMARTSHOPPER_STATE_CLERK_NORMAL + (Random() % (SMARTSHOPPER_STATE_RAND_COMMENT_4 - SMARTSHOPPER_STATE_RAND_COMMENT_1 + 1));
         break;
-    case 2:
-    case 4:
-    case 5:
+    case SMARTSHOPPER_STATE_RAND_COMMENT_1:
+    case SMARTSHOPPER_STATE_RAND_COMMENT_3:
+    case SMARTSHOPPER_STATE_RAND_COMMENT_4:
         if (show->smartshopperShow.itemIds[1] != ITEM_NONE)
-            sTVShowState = 6;
+            sTVShowState = SMARTSHOPPER_STATE_SECOND_ITEM;
         else
-            sTVShowState = 10;
+            sTVShowState = SMARTSHOPPER_STATE_IS_VIP;
         break;
-    case 3:
+    case SMARTSHOPPER_STATE_RAND_COMMENT_2:
         ConvertIntToDecimalString(2, show->smartshopperShow.itemAmounts[0] + 1);
         if (show->smartshopperShow.itemIds[1] != ITEM_NONE)
-            sTVShowState = 6;
+            sTVShowState = SMARTSHOPPER_STATE_SECOND_ITEM;
         else
-            sTVShowState = 10;
+            sTVShowState = SMARTSHOPPER_STATE_IS_VIP;
         break;
-    case 6:
+    case SMARTSHOPPER_STATE_SECOND_ITEM:
+        // Clerk describes 2nd type of item player purchased
         StringCopy(gStringVar2, ItemId_GetName(show->smartshopperShow.itemIds[1]));
         ConvertIntToDecimalString(2, show->smartshopperShow.itemAmounts[1]);
         if (show->smartshopperShow.itemIds[2] != ITEM_NONE)
-            sTVShowState = 7;
+            sTVShowState = SMARTSHOPPER_STATE_THIRD_ITEM;
         else if (show->smartshopperShow.priceReduced == TRUE)
-            sTVShowState = 8;
+            sTVShowState = SMARTSHOPPER_STATE_DURING_SALE;
         else
-            sTVShowState = 9;
+            sTVShowState = SMARTSHOPPER_STATE_OUTRO_NORMAL;
         break;
-    case 7:
+    case SMARTSHOPPER_STATE_THIRD_ITEM:
+        // Clerk describes 3rd type of item player purchased
         StringCopy(gStringVar2, ItemId_GetName(show->smartshopperShow.itemIds[2]));
         ConvertIntToDecimalString(2, show->smartshopperShow.itemAmounts[2]);
         if (show->smartshopperShow.priceReduced == TRUE)
-            sTVShowState = 8;
+            sTVShowState = SMARTSHOPPER_STATE_DURING_SALE;
         else
-            sTVShowState = 9;
+            sTVShowState = SMARTSHOPPER_STATE_OUTRO_NORMAL;
         break;
-    case 8:
+    case SMARTSHOPPER_STATE_DURING_SALE:
         if (show->smartshopperShow.itemAmounts[0] >= 255)
-            sTVShowState = 12;
+            sTVShowState = SMARTSHOPPER_STATE_OUTRO_MAX;
         else
-            sTVShowState = 9;
+            sTVShowState = SMARTSHOPPER_STATE_OUTRO_NORMAL;
         break;
-    case 9:
-        sub_80EF40C(1, show);
+    case SMARTSHOPPER_STATE_OUTRO_NORMAL:
+        SmartShopper_BufferPurchaseTotal(1, show);
         TVShowDone();
         break;
-    case 10:
+    case SMARTSHOPPER_STATE_IS_VIP:
+        // Clerk says customer is a VIP
+        // Said if player only purchased one type of item
         if (show->smartshopperShow.priceReduced == TRUE)
-            sTVShowState = 8;
+            sTVShowState = SMARTSHOPPER_STATE_DURING_SALE;
         else
-            sTVShowState = 9;
+            sTVShowState = SMARTSHOPPER_STATE_OUTRO_NORMAL;
         break;
-    case 11:
+    case SMARTSHOPPER_STATE_CLERK_MAX:
+        // Clerk's comments if player purchased maximum number of 1st item
         TVShowConvertInternationalString(gStringVar1, show->smartshopperShow.playerName, show->smartshopperShow.language);
         StringCopy(gStringVar2, ItemId_GetName(show->smartshopperShow.itemIds[0]));
         if (show->smartshopperShow.priceReduced == TRUE)
-            sTVShowState = 8;
+            sTVShowState = SMARTSHOPPER_STATE_DURING_SALE;
         else
-            sTVShowState = 12;
+            sTVShowState = SMARTSHOPPER_STATE_OUTRO_MAX;
         break;
-    case 12:
+    case SMARTSHOPPER_STATE_OUTRO_MAX:
+        // Outro comments if player purchased maximum number of 1st item
         TVShowConvertInternationalString(gStringVar1, show->smartshopperShow.playerName, show->smartshopperShow.language);
         TVShowDone();
         break;