Gimmick Refactor

include/battle_controllers.h

@@ -98,7 +98,7 @@ enum {
 
 // Special return values in gBattleBufferB from Battle Controller functions.
 #define RET_VALUE_LEVELED_UP   11
-#define RET_GIMMICK        (1 << 7)
+#define RET_GIMMICK            (1 << 7)
 
 struct UnusedControllerStruct
 {

include/battle_gimmick.h

@@ -14,11 +14,11 @@ enum Gimmick
 
 struct GimmickInfo
 {
-    const struct SpritePalette * triggerPal;        // trigger gfx data
-    const struct SpriteSheet * triggerSheet;
-    const struct SpriteTemplate * triggerTemplate;
-    const struct SpritePalette * indicatorPal;      // indicator gfx data
-    const struct SpriteSheet * indicatorSheet;
+    const struct SpritePalette *triggerPal;        // trigger gfx data
+    const struct SpriteSheet *triggerSheet;
+    const struct SpriteTemplate *triggerTemplate;
+    const struct SpritePalette *indicatorPal;      // indicator gfx data
+    const struct SpriteSheet *indicatorSheet;
     bool32 (*CanActivate)(u32 battler);
     void (*ActivateGimmick)(u32 battler);
 };

include/battle_interface.h

@@ -52,34 +52,34 @@ enum
 #define TAG_MEGA_INDICATOR_TILE         0xD778
 #define TAG_ALPHA_INDICATOR_TILE        0xD779
 #define TAG_OMEGA_INDICATOR_TILE        0xD77A
-#define TAG_DYNAMAX_INDICATOR_TILE      0xD77E
-
-#define TAG_NORMAL_INDICATOR_TILE       0xD77F
-#define TAG_FIGHTING_INDICATOR_TILE     0xD780
-#define TAG_FLYING_INDICATOR_TILE       0xD781
-#define TAG_POISON_INDICATOR_TILE       0xD782
-#define TAG_GROUND_INDICATOR_TILE       0xD783
-#define TAG_ROCK_INDICATOR_TILE         0xD784
-#define TAG_BUG_INDICATOR_TILE          0xD785
-#define TAG_GHOST_INDICATOR_TILE        0xD786
-#define TAG_STEEL_INDICATOR_TILE        0xD787
+#define TAG_DYNAMAX_INDICATOR_TILE      0xD77B
+
+#define TAG_NORMAL_INDICATOR_TILE       0xD77C
+#define TAG_FIGHTING_INDICATOR_TILE     0xD77D
+#define TAG_FLYING_INDICATOR_TILE       0xD77E
+#define TAG_POISON_INDICATOR_TILE       0xD77F
+#define TAG_GROUND_INDICATOR_TILE       0xD780
+#define TAG_ROCK_INDICATOR_TILE         0xD781
+#define TAG_BUG_INDICATOR_TILE          0xD782
+#define TAG_GHOST_INDICATOR_TILE        0xD783
+#define TAG_STEEL_INDICATOR_TILE        0xD784
 // empty spot for TYPE_MYSTERY
-#define TAG_FIRE_INDICATOR_TILE         0xD789
-#define TAG_WATER_INDICATOR_TILE        0xD78A
-#define TAG_GRASS_INDICATOR_TILE        0xD78B
-#define TAG_ELECTRIC_INDICATOR_TILE     0xD78C
-#define TAG_PSYCHIC_INDICATOR_TILE      0xD78D
-#define TAG_ICE_INDICATOR_TILE          0xD78E
-#define TAG_DRAGON_INDICATOR_TILE       0xD78F
-#define TAG_DARK_INDICATOR_TILE         0xD790
-#define TAG_FAIRY_INDICATOR_TILE        0xD791
-#define TAG_STELLAR_INDICATOR_TILE      0xD792
-#define TAG_TERA_TRIGGER_TILE           0xD793
+#define TAG_FIRE_INDICATOR_TILE         0xD786
+#define TAG_WATER_INDICATOR_TILE        0xD787
+#define TAG_GRASS_INDICATOR_TILE        0xD788
+#define TAG_ELECTRIC_INDICATOR_TILE     0xD789
+#define TAG_PSYCHIC_INDICATOR_TILE      0xD78A
+#define TAG_ICE_INDICATOR_TILE          0xD78B
+#define TAG_DRAGON_INDICATOR_TILE       0xD78C
+#define TAG_DARK_INDICATOR_TILE         0xD78D
+#define TAG_FAIRY_INDICATOR_TILE        0xD78E
+#define TAG_STELLAR_INDICATOR_TILE      0xD78F
+#define TAG_TERA_TRIGGER_TILE           0xD790
 
 #define TAG_GIMMICK_TRIGGER_PAL         0xD777
 #define TAG_MEGA_INDICATOR_PAL          0xD778
 #define TAG_MISC_INDICATOR_PAL          0xD779 // Alpha, Omega, and Dynamax indicators use the same palette as each of them only uses 4 different colors.
-#define TAG_TERA_INDICATOR_PAL          0xD77E
+#define TAG_TERA_INDICATOR_PAL          0xD77A
 
 enum
 {

include/config.h

@@ -6,7 +6,7 @@
 // still has them in the ROM. This is because the developers forgot
 // to define NDEBUG before release, however this has been changed as
 // Ruby's actual debug build does not use the AGBPrint features.
-// #define NDEBUG
+#define NDEBUG
 
 // To enable printf debugging, comment out "#define NDEBUG". This allows
 // the various AGBPrint functions to be used. (See include/gba/isagbprint.h).

include/data.h

@@ -70,10 +70,11 @@ struct TrainerMon
     u8 nature:5;
     bool8 gender:2;
     bool8 isShiny:1;
+    u8 useGimmick:4;
     u8 dynamaxLevel:4;
     u8 teraType:5;
     bool8 gigantamaxFactor:1;
-    u8 useGimmick:4;
+    u8 padding:2;
 };
 
 #define TRAINER_PARTY(partyArray) partyArray, .partySize = ARRAY_COUNT(partyArray)

src/battle_ai_util.c

@@ -648,6 +648,7 @@ s32 AI_CalcDamage(u32 move, u32 battlerAtk, u32 battlerDef, u8 *typeEffectivenes
     *typeEffectiveness = AI_GetEffectiveness(effectivenessMultiplier);
 
     // Undo temporary settings
+    gBattleStruct->aiCalcInProgress = FALSE;
     gBattleStruct->swapDamageCategory = FALSE;
     gBattleStruct->zmove.baseMoves[battlerAtk] = MOVE_NONE;
     if (toggledGimmick)
@@ -3764,20 +3765,20 @@ bool32 ShouldUseZMove(u32 battlerAtk, u32 battlerDef, u32 chosenMove)
     if (IsViableZMove(battlerAtk, chosenMove))
     {
         u8 effectiveness;
-        u32 zmove = GetUsableZMove(battlerAtk, chosenMove);
+        u32 zMove = GetUsableZMove(battlerAtk, chosenMove);
 
         if (gBattleMons[battlerDef].ability == ABILITY_DISGUISE
-            && !gMovesInfo[zmove].ignoresTargetAbility
+            && !gMovesInfo[zMove].ignoresTargetAbility
             && (gBattleMons[battlerDef].species == SPECIES_MIMIKYU_DISGUISED || gBattleMons[battlerDef].species == SPECIES_MIMIKYU_TOTEM_DISGUISED))
             return FALSE; // Don't waste a Z-Move busting disguise
         if (gBattleMons[battlerDef].ability == ABILITY_ICE_FACE
-            && !gMovesInfo[zmove].ignoresTargetAbility
+            && !gMovesInfo[zMove].ignoresTargetAbility
             && gBattleMons[battlerDef].species == SPECIES_EISCUE_ICE_FACE && IS_MOVE_PHYSICAL(chosenMove))
             return FALSE; // Don't waste a Z-Move busting Ice Face
 
-        if (IS_MOVE_STATUS(chosenMove) && !IS_MOVE_STATUS(zmove))
+        if (IS_MOVE_STATUS(chosenMove) && !IS_MOVE_STATUS(zMove))
             return FALSE;
-        else if (!IS_MOVE_STATUS(chosenMove) && IS_MOVE_STATUS(zmove))
+        else if (!IS_MOVE_STATUS(chosenMove) && IS_MOVE_STATUS(zMove))
             return FALSE;
 
         if (!IS_MOVE_STATUS(chosenMove) && AI_CalcDamageSaveBattlers(chosenMove, battlerAtk, battlerDef, &effectiveness, FALSE, DMG_ROLL_DEFAULT) >= gBattleMons[battlerDef].hp)

src/battle_controller_opponent.c

@@ -554,15 +554,13 @@ static void OpponentHandleChooseMove(u32 battler)
                     }
                     // If opponent can and should use a gimmick (considering trainer data), do it
                     if (gBattleStruct->gimmick.usableGimmick[battler] != GIMMICK_NONE
-                        && !(gBattleStruct->gimmick.usableGimmick[battler] == GIMMICK_Z_MOVE
-                        && !ShouldUseZMove(battler, gBattlerTarget, moveInfo->moves[chosenMoveId])))
+                     && !(gBattleStruct->gimmick.usableGimmick[battler] == GIMMICK_Z_MOVE
+                     && !ShouldUseZMove(battler, gBattlerTarget, moveInfo->moves[chosenMoveId])))
                     {
                         BtlController_EmitTwoReturnValues(battler, BUFFER_B, 10, (chosenMoveId) | (RET_GIMMICK) | (gBattlerTarget << 8));
                     }
                     else
-                    {
                         BtlController_EmitTwoReturnValues(battler, BUFFER_B, 10, (chosenMoveId) | (gBattlerTarget << 8));
-                    }
                 }
                 break;
             }

src/battle_controller_player.c

@@ -780,14 +780,13 @@ static void HandleInputChooseMove(u32 battler)
     else if ((JOY_NEW(B_BUTTON) || gPlayerDpadHoldFrames > 59)  && !sDescriptionSubmenu)
     {
         PlaySE(SE_SELECT);
+        gBattleStruct->gimmick.playerSelect = FALSE;
         if (gBattleStruct->zmove.viewing)
         {
-            gBattleStruct->gimmick.playerSelect = FALSE;
             ReloadMoveNames(battler);
         }
         else
         {
-            gBattleStruct->gimmick.playerSelect = FALSE;
             BtlController_EmitTwoReturnValues(battler, BUFFER_B, 10, 0xFFFF);
             HideGimmickTriggerSprite();
             PlayerBufferExecCompleted(battler);

src/battle_controller_player_partner.c

@@ -370,15 +370,13 @@ static void PlayerPartnerHandleChooseMove(u32 battler)
         }
         // If partner can and should use a gimmick (considering trainer data), do it
         if (gBattleStruct->gimmick.usableGimmick[battler] != GIMMICK_NONE
-            && !(gBattleStruct->gimmick.usableGimmick[battler] == GIMMICK_Z_MOVE
-            && !ShouldUseZMove(battler, gBattlerTarget, moveInfo->moves[chosenMoveId])))
+         && !(gBattleStruct->gimmick.usableGimmick[battler] == GIMMICK_Z_MOVE
+         && !ShouldUseZMove(battler, gBattlerTarget, moveInfo->moves[chosenMoveId])))
         {
             BtlController_EmitTwoReturnValues(battler, BUFFER_B, 10, (chosenMoveId) | (RET_GIMMICK) | (gBattlerTarget << 8));
         }
         else
-        {
             BtlController_EmitTwoReturnValues(battler, BUFFER_B, 10, (chosenMoveId) | (gBattlerTarget << 8));
-        }
     }
 
     PlayerPartnerBufferExecCompleted(battler);

src/battle_dynamax.c

@@ -77,12 +77,13 @@ bool32 CanDynamax(u32 battler)
     u16 holdEffect = GetBattlerHoldEffect(battler, FALSE);
 
     // Check if Dynamax battle flag is set. This needs to be defined in include/config/battle.h
-    if ((B_FLAG_DYNAMAX_BATTLE == 0 || (B_FLAG_DYNAMAX_BATTLE != 0 && !FlagGet(B_FLAG_DYNAMAX_BATTLE))) && !TESTING)
+    if (!TESTING && (B_FLAG_DYNAMAX_BATTLE == 0 || (B_FLAG_DYNAMAX_BATTLE != 0 && !FlagGet(B_FLAG_DYNAMAX_BATTLE))))
         return FALSE;
 
     // Check if Player has a Dynamax Band.
-    if ((GetBattlerPosition(battler) == B_POSITION_PLAYER_LEFT || (!(gBattleTypeFlags & BATTLE_TYPE_MULTI) && GetBattlerPosition(battler) == B_POSITION_PLAYER_RIGHT))
-          && !CheckBagHasItem(ITEM_DYNAMAX_BAND, 1) && !TESTING)
+    if (!TESTING && (GetBattlerPosition(battler) == B_POSITION_PLAYER_LEFT
+        || (!(gBattleTypeFlags & BATTLE_TYPE_MULTI) && GetBattlerPosition(battler) == B_POSITION_PLAYER_RIGHT))
+         && !CheckBagHasItem(ITEM_DYNAMAX_BAND, 1))
         return FALSE;
 
     // Check if species isn't allowed to Dynamax.
@@ -104,7 +105,7 @@ bool32 CanDynamax(u32 battler)
         return FALSE;
 
     // Check if battler is holding a Z-Crystal or Mega Stone.
-    if ((holdEffect == HOLD_EFFECT_Z_CRYSTAL || holdEffect == HOLD_EFFECT_MEGA_STONE) && !TESTING)
+    if (!TESTING && (holdEffect == HOLD_EFFECT_Z_CRYSTAL || holdEffect == HOLD_EFFECT_MEGA_STONE))  // tests make this check already
         return FALSE;
 
     // TODO: Cannot Dynamax in a Max Raid if you don't have Dynamax Energy.

src/battle_gimmick.c

@@ -72,7 +72,7 @@ bool32 ShouldTrainerBattlerUseGimmick(u32 battler, enum Gimmick gimmick)
     }
     // The player can bypass these checks because they can choose through the controller.
     else if (GetBattlerSide(battler) == B_SIDE_PLAYER
-             && !((gBattleTypeFlags & BATTLE_TYPE_MULTI) && battler == B_POSITION_PLAYER_RIGHT))
+         && !((gBattleTypeFlags & BATTLE_TYPE_MULTI) && battler == B_POSITION_PLAYER_RIGHT))
     {
         return TRUE;
     }
@@ -100,9 +100,7 @@ bool32 HasTrainerUsedGimmick(u32 battler, enum Gimmick gimmick)
     }
     // Otherwise, return whether current battler has used gimmick.
     else
-    {
         return gBattleStruct->gimmick.activated[battler][gimmick];
-    }
 }
 
 // Sets a gimmick as used by a trainer with checks for Multi Battles.
@@ -137,28 +135,26 @@ void CreateGimmickTriggerSprite(u32 battler)
 
     // Exit if there shouldn't be a sprite produced.
     if (GetBattlerSide(battler) == B_SIDE_OPPONENT
-        || gBattleStruct->gimmick.usableGimmick[battler] == GIMMICK_NONE
-        || gimmick->triggerSheet == NULL)
+     || gBattleStruct->gimmick.usableGimmick[battler] == GIMMICK_NONE
+     || gimmick->triggerSheet == NULL)
     {
         return;
     }
 
     LoadSpritePalette(gimmick->triggerPal);
     if (GetSpriteTileStartByTag(TAG_GIMMICK_TRIGGER_TILE) == 0xFFFF)
-    {
         LoadSpriteSheet(gimmick->triggerSheet);
-    }
 
     if (gBattleStruct->gimmick.triggerSpriteId == 0xFF)
     {
         if (gBattleTypeFlags & BATTLE_TYPE_DOUBLE)
             gBattleStruct->gimmick.triggerSpriteId = CreateSprite(gimmick->triggerTemplate,
-                                                             gSprites[gHealthboxSpriteIds[battler]].x - DOUBLES_GIMMICK_TRIGGER_POS_X_SLIDE,
-                                                             gSprites[gHealthboxSpriteIds[battler]].y - DOUBLES_GIMMICK_TRIGGER_POS_Y_DIFF, 0);
+                                                                  gSprites[gHealthboxSpriteIds[battler]].x - DOUBLES_GIMMICK_TRIGGER_POS_X_SLIDE,
+                                                                  gSprites[gHealthboxSpriteIds[battler]].y - DOUBLES_GIMMICK_TRIGGER_POS_Y_DIFF, 0);
         else
             gBattleStruct->gimmick.triggerSpriteId = CreateSprite(gimmick->triggerTemplate,
-                                                             gSprites[gHealthboxSpriteIds[battler]].x - SINGLES_GIMMICK_TRIGGER_POS_X_SLIDE,
-                                                             gSprites[gHealthboxSpriteIds[battler]].y - SINGLES_GIMMICK_TRIGGER_POS_Y_DIFF, 0);
+                                                                  gSprites[gHealthboxSpriteIds[battler]].x - SINGLES_GIMMICK_TRIGGER_POS_X_SLIDE,
+                                                                  gSprites[gHealthboxSpriteIds[battler]].y - SINGLES_GIMMICK_TRIGGER_POS_Y_DIFF, 0);
     }
 
     gSprites[gBattleStruct->gimmick.triggerSpriteId].tBattler = battler;
@@ -263,17 +259,12 @@ void LoadIndicatorSpritesGfx(void)
     for (gimmick = 0; gimmick < GIMMICKS_COUNT; ++gimmick)
     {
         if (gimmick == GIMMICK_TERA) // special case
-        {
             LoadSpriteSheets(sTeraIndicatorSpriteSheets);
-        }
         else if (gGimmicksInfo[gimmick].indicatorSheet != NULL)
-        {
             LoadSpriteSheet(gGimmicksInfo[gimmick].indicatorSheet);
-        }
+
         if (gGimmicksInfo[gimmick].indicatorPal != NULL)
-        {
             LoadSpritePalette(gGimmicksInfo[gimmick].indicatorPal);
-        }
     }
     // Primal reversion graphics aren't loaded as part of gimmick data
     LoadSpriteSheet(&sSpriteSheet_AlphaIndicator);
@@ -323,17 +314,11 @@ u32 GetIndicatorPalTag(u32 battler)
 {
     u32 gimmick = GetActiveGimmick(battler);
     if (IsBattlerPrimalReverted(battler))
-    {
         return TAG_MISC_INDICATOR_PAL;
-    }
     else if (gGimmicksInfo[gimmick].indicatorPal != NULL)
-    {
         return gGimmicksInfo[gimmick].indicatorPal->tag;
-    }
     else
-    {
         return TAG_NONE;
-    }
 }
 
 void UpdateIndicatorVisibilityAndType(u32 healthboxId, bool32 invisible)

src/battle_main.c

@@ -5784,8 +5784,8 @@ void SetTypeBeforeUsingMove(u32 move, u32 battlerAtk)
 
     attackerAbility = GetBattlerAbility(battlerAtk);
     if (gMovesInfo[move].type == TYPE_NORMAL
-        && TrySetAteType(move, battlerAtk, attackerAbility)
-        && GetActiveGimmick(battlerAtk) != GIMMICK_DYNAMAX)
+     && TrySetAteType(move, battlerAtk, attackerAbility)
+     && GetActiveGimmick(battlerAtk) != GIMMICK_DYNAMAX)
     {
             gBattleStruct->ateBoost[battlerAtk] = 1;
     }

src/battle_script_commands.c

@@ -1364,7 +1364,8 @@ static void Cmd_attackcanceler(void)
     }
 
     // Z-moves and Max Moves bypass protection, but deal reduced damage (factored in AccumulateOtherModifiers)
-    if ((IsZMove(gCurrentMove) || IsMaxMove(gCurrentMove))
+    if ((IsZMove(gCurrentMove)
+        || IsMaxMove(gCurrentMove))
          && IS_BATTLER_PROTECTED(gBattlerTarget))
     {
         BattleScriptPush(cmd->nextInstr);
@@ -9825,7 +9826,8 @@ static void Cmd_various(void)
          || gMovesInfo[move].instructBanned
          || gBattleMoveEffects[gMovesInfo[move].effect].twoTurnEffect
          || (GetActiveGimmick(gBattlerTarget) == GIMMICK_DYNAMAX)
-         || IsZMove(move) || IsMaxMove(move))
+         || IsZMove(move)
+         || IsMaxMove(move))
         {
             gBattlescriptCurrInstr = cmd->failInstr;
         }

src/battle_terastal.c

@@ -64,13 +64,14 @@ bool32 CanTerastallize(u32 battler)
     u32 holdEffect = GetBattlerHoldEffect(battler, FALSE);
 
     // Check if Player has Tera Orb and has charge.
-    if ((!CheckBagHasItem(ITEM_TERA_ORB, 1)
-        || !((B_FLAG_TERA_ORB_NO_COST != 0 && FlagGet(B_FLAG_TERA_ORB_NO_COST))
-        || (B_FLAG_TERA_ORB_CHARGED != 0 && FlagGet(B_FLAG_TERA_ORB_CHARGED)
-        && ((battler == B_POSITION_PLAYER_LEFT || (!(gBattleTypeFlags & BATTLE_TYPE_MULTI) && battler == B_POSITION_PLAYER_RIGHT))))))
-        && !TESTING)
+    if (!TESTING && !(B_FLAG_TERA_ORB_NO_COST != 0 && FlagGet(B_FLAG_TERA_ORB_NO_COST))
+        && (battler == B_POSITION_PLAYER_LEFT
+        || (!(gBattleTypeFlags & BATTLE_TYPE_MULTI) && battler == B_POSITION_PLAYER_RIGHT)))
     {
-        return FALSE;
+        if (!CheckBagHasItem(ITEM_TERA_ORB, 1))
+            return FALSE;
+        if (B_FLAG_TERA_ORB_CHARGED != 0 && !FlagGet(B_FLAG_TERA_ORB_CHARGED))
+            return FALSE;
     }
 
     // Check if Trainer has already Terastallized.
@@ -86,7 +87,7 @@ bool32 CanTerastallize(u32 battler)
         return FALSE;
 
     // Check if battler is holding a Z-Crystal or Mega Stone.
-    if ((holdEffect == HOLD_EFFECT_Z_CRYSTAL || holdEffect == HOLD_EFFECT_MEGA_STONE) && !TESTING)
+    if (!TESTING && (holdEffect == HOLD_EFFECT_Z_CRYSTAL || holdEffect == HOLD_EFFECT_MEGA_STONE)) // tests make this check already
         return FALSE;
 
     // Every check passed!