Name and use general purpose vars

11 files changed, 76 insertions, 76 deletions

diff --git a/src/battle/battle_setup.c b/src/battle/battle_setup.c
index f71aad090..2f94dd407 100644
--- a/src/battle/battle_setup.c
+++ b/src/battle/battle_setup.c
@@ -858,7 +858,7 @@ static void CB2_GiveStarter(void)
 {
     u16 starterPoke;
 
-    *GetVarPointer(0x4023) = gSpecialVar_Result;
+    *GetVarPointer(VAR_STARTER_MON) = gSpecialVar_Result;
     starterPoke = GetStarterPokemon(gSpecialVar_Result);
     ScriptGiveMon(starterPoke, 5, 0, 0, 0, 0);
     ResetTasks();
diff --git a/src/engine/mystery_event_script.c b/src/engine/mystery_event_script.c
index 12ad329da..2fc62d4f8 100644
--- a/src/engine/mystery_event_script.c
+++ b/src/engine/mystery_event_script.c
@@ -317,7 +317,7 @@ bool8 MEScrCmd_setenigmaberry(struct ScriptContext *ctx)
     ctx->data[2] = 2;
 
     if (IsEnigmaBerryValid() == TRUE)
-        VarSet(0x402D, 1);
+        VarSet(VAR_ENIGMA_BERRY_AVAILABLE, 1);
     else
         ctx->data[2] = 1;
 
diff --git a/src/field/field_special_scene.c b/src/field/field_special_scene.c
index 853234f32..67b652a57 100644
--- a/src/field/field_special_scene.c
+++ b/src/field/field_special_scene.c
@@ -291,7 +291,7 @@ bool8 sub_80C7754(void)
 void Task_HandlePorthole(u8 taskId)
 {
     s16 *data = gTasks[taskId].data;
-    u16 *var = GetVarPointer(VAR_PORTHOLE);
+    u16 *var = GetVarPointer(VAR_PORTHOLE_STATE);
     struct WarpData *location = &gSaveBlock1.location;
 
     switch (data[0])
@@ -352,7 +352,7 @@ void sub_80C78A0(void)
 
     gSprites[spriteId].coordOffsetEnabled = FALSE;
 
-    if (VarGet(0x40B4) == 2)
+    if (VarGet(VAR_PORTHOLE_STATE) == 2)
     {
         StartSpriteAnim(&gSprites[spriteId], FieldObjectDirectionToImageAnimId(4));
     }
diff --git a/src/field/field_specials.c b/src/field/field_specials.c
index 87a9e2d5d..43921ed55 100644
--- a/src/field/field_specials.c
+++ b/src/field/field_specials.c
@@ -99,13 +99,13 @@ u16 GetPlayerAvatarBike(void)
     return 0;
 }
 
-static void DetermineCyclingRoadResults(u32 arg0, u8 arg1)
+static void DetermineCyclingRoadResults(u32 numFrames, u8 numBikeCollisions)
 {
     u8 result;
 
-    if (arg1 <= 99)
+    if (numBikeCollisions <= 99)
     {
-        ConvertIntToDecimalStringN(gStringVar1, arg1, STR_CONV_MODE_LEFT_ALIGN, 2);
+        ConvertIntToDecimalStringN(gStringVar1, numBikeCollisions, STR_CONV_MODE_LEFT_ALIGN, 2);
         StringAppend(gStringVar1, gOtherText_Times);
     }
     else
@@ -113,11 +113,11 @@ static void DetermineCyclingRoadResults(u32 arg0, u8 arg1)
         StringCopy(gStringVar1, gOtherText_99Times);
     }
 
-    if (arg0 < 3600)
+    if (numFrames < 3600)
     {
-        ConvertIntToDecimalStringN(gStringVar2, arg0 / 60, STR_CONV_MODE_RIGHT_ALIGN, 2);
+        ConvertIntToDecimalStringN(gStringVar2, numFrames / 60, STR_CONV_MODE_RIGHT_ALIGN, 2);
         gStringVar2[2] = CHAR_DECIMAL_SEPARATOR;
-        ConvertIntToDecimalStringN(&gStringVar2[3], ((arg0 % 60) * 100) / 60, STR_CONV_MODE_LEADING_ZEROS, 2);
+        ConvertIntToDecimalStringN(&gStringVar2[3], ((numFrames % 60) * 100) / 60, STR_CONV_MODE_LEADING_ZEROS, 2);
         StringAppend(gStringVar2, gOtherText_Seconds);
     }
     else
@@ -126,44 +126,44 @@ static void DetermineCyclingRoadResults(u32 arg0, u8 arg1)
     }
 
     result = 0;
-    if (arg1 == 0)
+    if (numBikeCollisions == 0)
     {
         result = 5;
     }
-    else if (arg1 < 4)
+    else if (numBikeCollisions < 4)
     {
         result = 4;
     }
-    else if (arg1 < 10)
+    else if (numBikeCollisions < 10)
     {
         result = 3;
     }
-    else if (arg1 < 20)
+    else if (numBikeCollisions < 20)
     {
         result = 2;
     }
-    else if (arg1 < 100)
+    else if (numBikeCollisions < 100)
     {
         result = 1;
     }
 
-    if (arg0 / 60 <= 10)
+    if (numFrames / 60 <= 10)
     {
         result += 5;
     }
-    else if (arg0 / 60 <= 15)
+    else if (numFrames / 60 <= 15)
     {
         result += 4;
     }
-    else if (arg0 / 60 <= 20)
+    else if (numFrames / 60 <= 20)
     {
         result += 3;
     }
-    else if (arg0 / 60 <= 40)
+    else if (numFrames / 60 <= 40)
     {
         result += 2;
     }
-    else if (arg0 / 60 < 60)
+    else if (numFrames / 60 < 60)
     {
         result += 1;
     }
@@ -173,36 +173,36 @@ static void DetermineCyclingRoadResults(u32 arg0, u8 arg1)
 }
 
 void FinishCyclingRoadChallenge(void) {
-    const u32 time = gMain.vblankCounter1 - gBikeCyclingTimer;
+    const u32 numFrames = gMain.vblankCounter1 - gBikeCyclingTimer;
 
-    DetermineCyclingRoadResults(time, gBikeCollisions);
-    RecordCyclingRoadResults(time, gBikeCollisions);
+    DetermineCyclingRoadResults(numFrames, gBikeCollisions);
+    RecordCyclingRoadResults(numFrames, gBikeCollisions);
 }
 
-static void RecordCyclingRoadResults(u32 arg0, u8 arg1) {
-    u16 high = VarGet(0x4028);
-    u16 low = VarGet(0x4029);
-    u32 record = high + (low << 16);
+static void RecordCyclingRoadResults(u32 numFrames, u8 numBikeCollisions) {
+    u16 low = VarGet(VAR_CYCLING_ROAD_RECORD_TIME_L);
+    u16 high = VarGet(VAR_CYCLING_ROAD_RECORD_TIME_H);
+    u32 framesRecord = low + (high << 16);
 
-    if (record > arg0 || record == 0)
+    if (framesRecord > numFrames || framesRecord == 0)
     {
-        VarSet(0x4028, arg0);
-        VarSet(0x4029, arg0 >> 16);
-        VarSet(0x4027, arg1);
+        VarSet(VAR_CYCLING_ROAD_RECORD_TIME_L, numFrames);
+        VarSet(VAR_CYCLING_ROAD_RECORD_TIME_H, numFrames >> 16);
+        VarSet(VAR_CYCLING_ROAD_RECORD_COLLISIONS, numBikeCollisions);
     }
 }
 
 u16 GetRecordedCyclingRoadResults(void) {
-    u16 high = VarGet(0x4028);
-    u16 low = VarGet(0x4029);
-    u32 record = high + (low << 16);
+    u16 low = VarGet(VAR_CYCLING_ROAD_RECORD_TIME_L);
+    u16 high = VarGet(VAR_CYCLING_ROAD_RECORD_TIME_H);
+    u32 framesRecord = low + (high << 16);
 
-    if (record == 0)
+    if (framesRecord == 0)
     {
         return FALSE;
     }
 
-    DetermineCyclingRoadResults(record, VarGet(0x4027));
+    DetermineCyclingRoadResults(framesRecord, VarGet(VAR_CYCLING_ROAD_RECORD_COLLISIONS));
     return TRUE;
 }
 
@@ -212,9 +212,9 @@ void UpdateCyclingRoadState(void) {
         return;
     }
 
-    if (VarGet(0x40a9) == 2 || VarGet(0x40a9) == 3)
+    if (VarGet(VAR_CYCLING_CHALLENGE_STATE) == 2 || VarGet(VAR_CYCLING_CHALLENGE_STATE) == 3)
     {
-        VarSet(0x40a9, 0);
+        VarSet(VAR_CYCLING_CHALLENGE_STATE, 0);
         Overworld_SetSavedMusic(SE_STOP);
     }
 }
@@ -242,7 +242,7 @@ bool32 CountSSTidalStep(u16 delta)
 u8 GetSSTidalLocation(s8 *mapGroup, s8 *mapNum, s16 *x, s16 *y)
 {
     u16 *varCruiseStepCount = GetVarPointer(VAR_CRUISE_STEP_COUNT);
-    switch (*GetVarPointer(VAR_PORTHOLE))
+    switch (*GetVarPointer(VAR_PORTHOLE_STATE))
     {
         case 1:
         case 8:
@@ -1885,12 +1885,12 @@ u8 sub_810F5BC(void)
     {
         if (FlagGet(FLAG_HIDE_RUSTURF_TUNNEL_ROCK_1))
         {
-            VarSet(VAR_0x409a, 4);
+            VarSet(VAR_RUSTURF_TUNNEL_STATE, 4);
             return TRUE;
         }
         else if (FlagGet(FLAG_HIDE_RUSTURF_TUNNEL_ROCK_2))
         {
-            VarSet(VAR_0x409a, 5);
+            VarSet(VAR_RUSTURF_TUNNEL_STATE, 5);
             return TRUE;
         }
     }
@@ -1919,7 +1919,7 @@ void PutZigzagoonInPlayerParty(void)
 bool8 IsStarterInParty(void)
 {
     u8 i;
-    u16 starter = GetStarterPokemon(VarGet(VAR_FIRST_POKE));
+    u16 starter = GetStarterPokemon(VarGet(VAR_STARTER_MON));
     u8 partyCount = CalculatePlayerPartyCount();
     for (i = 0; i < partyCount; i++)
     {
@@ -2047,8 +2047,8 @@ void sub_810F8FC(void)
 
 u16 sub_810F908(void)
 {
-    u16 var40c2 = VarGet(VAR_0x40C2);
-    if (gLocalTime.days - var40c2 >= 7)
+    u16 tmReceivedDay = VarGet(VAR_PACIFIDLOG_TM_RECEIVED_DAY);
+    if (gLocalTime.days - tmReceivedDay >= 7)
     {
         return 0;
     }
@@ -2056,12 +2056,12 @@ u16 sub_810F908(void)
     {
         return 8;
     }
-    return 7 - (gLocalTime.days - var40c2);
+    return 7 - (gLocalTime.days - tmReceivedDay);
 }
 
 u16 sub_810F950(void)
 {
-    VarSet(VAR_0x40C2, gLocalTime.days);
+    VarSet(VAR_PACIFIDLOG_TM_RECEIVED_DAY, gLocalTime.days);
     return gLocalTime.days;
 }
 
@@ -2146,13 +2146,13 @@ void sub_810FAA0(void)
         FlagClear(0x316);
         FlagClear(0x317);
         FlagClear(0x318);
-        VarSet(VAR_0x4095, 1);
+        VarSet(VAR_LILYCOVE_FAN_CLUB_STATE, 1);
     }
 }
 
 u8 sub_810FB10(u8 a0)
 {
-    if (VarGet(VAR_0x4095) == 2)
+    if (VarGet(VAR_LILYCOVE_FAN_CLUB_STATE) == 2)
     {
         if ((gSaveBlock1.vars[0x41] & 0x7f) + gUnknown_083F8404[a0] >= 20)
         {
@@ -2355,7 +2355,7 @@ void sub_810FE1C(void *linkRecords, u8 a, u8 b)
 
 void sub_810FEFC(void)
 {
-    if (VarGet(VAR_0x4095) == 2)
+    if (VarGet(VAR_LILYCOVE_FAN_CLUB_STATE) == 2)
     {
         sub_810FA74();
         if (gBattleOutcome == 1)
diff --git a/src/field/fldeff_secret_base_pc.c b/src/field/fldeff_secret_base_pc.c
index 8d71a4fb9..394c4bc56 100644
--- a/src/field/fldeff_secret_base_pc.c
+++ b/src/field/fldeff_secret_base_pc.c
@@ -60,7 +60,7 @@ void DoSecretBasePCTurnOffEffect(void)
     GetXYCoordsOneStepInFrontOfPlayer(&x, &y);
     PlaySE(SE_PC_OFF);
 
-    if (!VarGet(VAR_0x4054))
+    if (!VarGet(VAR_CURRENT_SECRET_BASE))
         MapGridSetMetatileIdAt(x, y, 3616);
     else
         MapGridSetMetatileIdAt(x, y, 3617);
diff --git a/src/field/item_use.c b/src/field/item_use.c
index 37cd8ba78..cf5f05eb9 100644
--- a/src/field/item_use.c
+++ b/src/field/item_use.c
@@ -921,7 +921,7 @@ static void PrepareItemUseMessage(void)
 
 void ItemUseOutOfBattle_Repel(u8 var)
 {
-    if (VarGet(VAR_REPEL_STEP_COUNT) == FALSE)
+    if (VarGet(VAR_REPEL_STEP_COUNT) == 0)
     {
         VarSet(VAR_REPEL_STEP_COUNT, ItemId_GetHoldEffectParam(gSpecialVar_ItemId));
         PrepareItemUseMessage();
diff --git a/src/field/lottery_corner.c b/src/field/lottery_corner.c
index 83febc56e..03de26054 100644
--- a/src/field/lottery_corner.c
+++ b/src/field/lottery_corner.c
@@ -30,7 +30,7 @@ void ResetLotteryCorner(void)
     u16 rand = Random();
 
     SetLotteryNumber((Random() << 16) | rand);
-    VarSet(VAR_POKELOT_PRIZE, 0);
+    VarSet(VAR_LOTTERY_PRIZE, 0);
 }
 
 void SetRandomLotteryNumber(u16 i)
@@ -152,19 +152,19 @@ static u8 GetMatchingDigits(u16 winNumber, u16 otId)
 // lottery numbers go from 0 to 99999, not 65535 (0xFFFF). interestingly enough, the function that calls GetLotteryNumber shifts to u16, so it cant be anything above 65535 anyway.
 void SetLotteryNumber(u32 lotteryNum)
 {
-    u16 lowNum = lotteryNum >> 16;
-    u16 highNum = lotteryNum;
+    u16 high = lotteryNum >> 16;
+    u16 low = lotteryNum;
 
-    VarSet(VAR_POKELOT_RND1, highNum);
-    VarSet(VAR_POKELOT_RND2, lowNum);
+    VarSet(VAR_LOTTERY_RND_L, low);
+    VarSet(VAR_LOTTERY_RND_H, high);
 }
 
 u32 GetLotteryNumber(void)
 {
-    u16 highNum = VarGet(VAR_POKELOT_RND1);
-    u16 lowNum = VarGet(VAR_POKELOT_RND2);
+    u16 low = VarGet(VAR_LOTTERY_RND_L);
+    u16 high = VarGet(VAR_LOTTERY_RND_H);
 
-    return (lowNum << 16) | highNum;
+    return (high << 16) | low;
 }
 
 // interestingly, this may have been the original lottery number set function, but GF tried to change it to 32-bit later but didnt finish changing all calls as one GetLotteryNumber still shifts to u16.
diff --git a/src/field/overworld.c b/src/field/overworld.c
index 834a2afa4..5594d23e6 100644
--- a/src/field/overworld.c
+++ b/src/field/overworld.c
@@ -816,7 +816,7 @@ static bool16 ShouldLegendaryMusicPlayAtLocation(struct WarpData *warp)
 
 static bool16 IsInfiltratedWeatherInstitute(struct WarpData *warp)
 {
-    if (VarGet(VAR_WEATHER_INSTITUTE_CLEARED))
+    if (VarGet(VAR_WEATHER_INSTITUTE_STATE))
         return FALSE;
     if (warp->mapGroup != MAP_GROUP(ROUTE119_WEATHER_INSTITUTE_1F))
         return FALSE;
diff --git a/src/field/secret_base.c b/src/field/secret_base.c
index 19f8e18dc..400074604 100644
--- a/src/field/secret_base.c
+++ b/src/field/secret_base.c
@@ -180,7 +180,7 @@ void sub_80BB5E4(void)
         if (gUnknown_020387DC != gSaveBlock1.secretBases[i].secretBaseId)
             continue;
         gSpecialVar_Result = 1;
-        VarSet(VAR_0x4054, i);
+        VarSet(VAR_CURRENT_SECRET_BASE, i);
         break;
     }
 }
@@ -284,7 +284,7 @@ void sub_80BB8CC(void)
     for (idx=0; idx<4; idx++) {
         gSaveBlock1.secretBases[0].trainerId[idx] = gSaveBlock2.playerTrainerId[idx];
     }
-    VarSet(VAR_0x4054, 0);
+    VarSet(VAR_CURRENT_SECRET_BASE, 0);
     nameLength = sub_80BB8A8(gSaveBlock2.playerName);
     memset(gSaveBlock1.secretBases[0].playerName, 0xFF, OT_NAME_LENGTH);
     StringCopyN(gSaveBlock1.secretBases[0].playerName, gSaveBlock2.playerName, nameLength);
@@ -333,7 +333,7 @@ void sub_80BBA48(u8 taskid)
         }
         break;
     case 2:
-        curbaseid = VarGet(VAR_0x4054);
+        curbaseid = VarGet(VAR_CURRENT_SECRET_BASE);
         if (gSaveBlock1.secretBases[curbaseid].sbr_field_10 < 0xff)
             gSaveBlock1.secretBases[curbaseid].sbr_field_10++;
         sub_80BBA14();
@@ -412,7 +412,7 @@ void sub_80BBCCC(u8 flagIn)
     u16 curBaseId;
     u16 x, y;
     if (CurrentMapIsSecretBase()) {
-        curBaseId = VarGet(VAR_0x4054);
+        curBaseId = VarGet(VAR_CURRENT_SECRET_BASE);
         for (x=0; x<16; x++) {
             if (gSaveBlock1.secretBases[curBaseId].decorations[x] > 0 && gSaveBlock1.secretBases[curBaseId].decorations[x] <= 0x78 && gDecorations[gSaveBlock1.secretBases[curBaseId].decorations[x]].permission != DECORPERM_SOLID_MAT) {
                 sub_80FF394((gSaveBlock1.secretBases[curBaseId].decorationPos[x] >> 4) + 7, (gSaveBlock1.secretBases[curBaseId].decorationPos[x] & 0xF) + 7, gSaveBlock1.secretBases[curBaseId].decorations[x]);
@@ -437,7 +437,7 @@ void sub_80BBDD0(void)
     u8 metatile;
     u8 permission;
     u8 ndecor;
-    u16 curBase = VarGet(VAR_0x4054);
+    u16 curBase = VarGet(VAR_CURRENT_SECRET_BASE);
     if (!CurrentMapIsSecretBase()) {
         roomdecor = gSaveBlock1.playerRoomDecor;
         roomdecorpos = gSaveBlock1.playerRoomDecorPos;
@@ -478,7 +478,7 @@ void sub_80BBDD0(void)
 
 void sub_80BBFA4(void)
 {
-    int curBase = VarGet(VAR_0x4054);
+    int curBase = VarGet(VAR_CURRENT_SECRET_BASE);
     VarSet(VAR_OBJ_GFX_ID_F, gUnknown_083D13EC[sub_80BCCA4(curBase)]);
 }
 
@@ -571,12 +571,12 @@ u8 *sub_80BC190(u8 *dest, u8 arg1) { // 80bc190
 }
 
 u8 *GetSecretBaseMapName(u8 *dest) {
-    gUnknown_020387DC = gSaveBlock1.secretBases[VarGet(VAR_0x4054)].secretBaseId;
-    return sub_80BC190(dest, VarGet(VAR_0x4054));
+    gUnknown_020387DC = gSaveBlock1.secretBases[VarGet(VAR_CURRENT_SECRET_BASE)].secretBaseId;
+    return sub_80BC190(dest, VarGet(VAR_CURRENT_SECRET_BASE));
 }
 
 void sub_80BC224(void) {
-    u8 *var0 = gSaveBlock1.secretBases[(u8)VarGet(VAR_0x4054)].playerName;
+    u8 *var0 = gSaveBlock1.secretBases[(u8)VarGet(VAR_CURRENT_SECRET_BASE)].playerName;
     u8 *var1 = gStringVar1;
     u8 var2 = sub_80BB8A8(var0);
     u8 *var3 = StringCopyN(var1, var0, var2);
@@ -1173,7 +1173,7 @@ void sub_80BCBF8(u8 taskId)
 
 void sub_80BCC54(u8 taskId)
 {
-    u16 curBaseIndex = VarGet(VAR_0x4054);
+    u16 curBaseIndex = VarGet(VAR_CURRENT_SECRET_BASE);
 
     BuyMenuFreeMemory();
     DestroyVerticalScrollIndicator(0);
@@ -1199,7 +1199,7 @@ u8 sub_80BCCA4(u8 secretBaseIndex)
 
 const u8 *sub_80BCCE8(void)
 {
-    u8 param = sub_80BCCA4(VarGet(VAR_0x4054));
+    u8 param = sub_80BCCA4(VarGet(VAR_CURRENT_SECRET_BASE));
     if (param == 0) return UnknownString_81A1BB2;
     if (param == 1) return UnknownString_81A1F67;
     if (param == 2) return UnknownString_81A2254;
@@ -1229,7 +1229,7 @@ void unref_sub_80BCD7C(u8 secretBaseIndex)
 
 void sub_80BCE1C(void)
 {
-    u16 curBaseIndex = VarGet(VAR_0x4054);
+    u16 curBaseIndex = VarGet(VAR_CURRENT_SECRET_BASE);
     sub_810FB10(1);
 
     CreateSecretBaseEnemyParty(&gSaveBlock1.secretBases[curBaseIndex]);
@@ -1237,12 +1237,12 @@ void sub_80BCE1C(void)
 
 void sub_80BCE4C()
 {
-    gSaveBlock1.secretBases[VarGet(VAR_0x4054)].sbr_field_1_5 = gSpecialVar_Result;
+    gSaveBlock1.secretBases[VarGet(VAR_CURRENT_SECRET_BASE)].sbr_field_1_5 = gSpecialVar_Result;
 }
 
 void sub_80BCE90()
 {
-    u16 curBaseIndex = VarGet(VAR_0x4054);
+    u16 curBaseIndex = VarGet(VAR_CURRENT_SECRET_BASE);
 
     if (!FlagGet(FLAG_DAILY_UNKNOWN_8C2))
     {
diff --git a/src/field/tv.c b/src/field/tv.c
index e9c92335f..c38da1f4c 100644
--- a/src/field/tv.c
+++ b/src/field/tv.c
@@ -2193,7 +2193,7 @@ void GetMomOrDadStringForTVMessage(void)
 
 void sub_80BFD20(void)
 {
-    VarSet(VAR_0x40BC, 0);
+    VarSet(VAR_BRAVO_TRAINER_BATTLE_TOWER_ON, 0);
     RemoveFieldObjectByLocalIdAndMap(5, gSaveBlock1.location.mapNum, gSaveBlock1.location.mapGroup);
 }
 
diff --git a/src/scene/credits.c b/src/scene/credits.c
index 81be60c9f..e7744822b 100644
--- a/src/scene/credits.c
+++ b/src/scene/credits.c
@@ -1606,7 +1606,7 @@ void spritecb_814580C(struct Sprite *sprite)
 static void sub_81458DC(void)
 {
     struct Unk201C000 *unk201C000 = &ewram1c000;
-    u16 starter = SpeciesToNationalPokedexNum(GetStarterPokemon(VarGet(VAR_FIRST_POKE)));
+    u16 starter = SpeciesToNationalPokedexNum(GetStarterPokemon(VarGet(VAR_STARTER_MON)));
     u16 seenTypesCount;
     u16 page;
     u16 dexNum;