Gimmick Refactor

data/battle_scripts_1.s

@@ -6510,6 +6510,9 @@ BattleScript_PerishSongCountGoesDown::
 	waitmessage B_WAIT_TIME_LONG
 	end2
 
+BattleScript_AllStatsUpZMove::
+	printfromtable gZEffectStringIds
+	waitmessage B_WAIT_TIME_LONG
 BattleScript_AllStatsUp::
 	jumpifstat BS_ATTACKER, CMP_LESS_THAN, STAT_ATK, MAX_STAT_STAGE, BattleScript_AllStatsUpAtk
 	jumpifstat BS_ATTACKER, CMP_LESS_THAN, STAT_DEF, MAX_STAT_STAGE, BattleScript_AllStatsUpAtk
@@ -6968,13 +6971,13 @@ BattleScript_MegaEvolution::
 BattleScript_MegaEvolutionAfterString:
 	waitmessage B_WAIT_TIME_LONG
 	setbyte gIsCriticalHit, 0
-	handlemegaevo BS_ATTACKER, 0
-	playanimation BS_ATTACKER, B_ANIM_MEGA_EVOLUTION
+	handlemegaevo BS_SCRIPTING, 0
+	playanimation BS_SCRIPTING, B_ANIM_MEGA_EVOLUTION
 	waitanimation
-	handlemegaevo BS_ATTACKER, 1
+	handlemegaevo BS_SCRIPTING, 1
 	printstring STRINGID_MEGAEVOEVOLVED
 	waitmessage B_WAIT_TIME_LONG
-	switchinabilities BS_ATTACKER
+	switchinabilities BS_SCRIPTING
 	end3
 
 BattleScript_WishMegaEvolution::
@@ -7011,13 +7014,13 @@ BattleScript_UltraBurst::
 	printstring STRINGID_ULTRABURSTREACTING
 	waitmessage B_WAIT_TIME_LONG
 	setbyte gIsCriticalHit, 0
-	handleultraburst BS_ATTACKER, 0
-	playanimation BS_ATTACKER, B_ANIM_ULTRA_BURST
+	handleultraburst BS_SCRIPTING, 0
+	playanimation BS_SCRIPTING, B_ANIM_ULTRA_BURST
 	waitanimation
-	handleultraburst BS_ATTACKER, 1
+	handleultraburst BS_SCRIPTING, 1
 	printstring STRINGID_ULTRABURSTCOMPLETED
 	waitmessage B_WAIT_TIME_LONG
-	switchinabilities BS_ATTACKER
+	switchinabilities BS_SCRIPTING
 	end3
 
 BattleScript_GulpMissileFormChange::

include/battle.h

@@ -16,6 +16,7 @@
 #include "battle_debug.h"
 #include "battle_dynamax.h"
 #include "battle_terastal.h"
+#include "battle_gimmick.h"
 #include "random.h" // for rng_value_t
 
 // Helper for accessing command arguments and advancing gBattlescriptCurrInstr.
@@ -364,8 +365,6 @@ struct AiLogicData
     bool8 weatherHasEffect; // The same as WEATHER_HAS_EFFECT. Stored here, so it's called only once.
     u8 mostSuitableMonId[MAX_BATTLERS_COUNT]; // Stores result of GetMostSuitableMonToSwitchInto, which decides which generic mon the AI would switch into if they decide to switch. This can be overruled by specific mons found in ShouldSwitch; the final resulting mon is stored in AI_monToSwitchIntoId.
     struct SwitchinCandidate switchinCandidate; // Struct used for deciding which mon to switch to in battle_ai_switch_items.c
-    bool8 shouldTerastal[MAX_BATTLERS_COUNT];
-    bool8 shouldDynamax[MAX_BATTLERS_COUNT];
 };
 
 struct AI_ThinkingStruct
@@ -552,24 +551,6 @@ struct LinkBattlerHeader
     struct BattleEnigmaBerry battleEnigmaBerry;
 };
 
-struct MegaEvolutionData
-{
-    u8 toEvolve; // As flags using gBitTable.
-    bool8 alreadyEvolved[4]; // Array id is used for mon position.
-    u8 battlerId;
-    bool8 playerSelect;
-    u8 triggerSpriteId;
-};
-
-struct UltraBurstData
-{
-    u8 toBurst; // As flags using gBitTable.
-    bool8 alreadyBursted[4]; // Array id is used for mon position.
-    u8 battlerId;
-    bool8 playerSelect;
-    u8 triggerSpriteId;
-};
-
 struct Illusion
 {
     u8 on;
@@ -581,48 +562,30 @@ struct Illusion
 
 struct ZMoveData
 {
-    u8 viable:1;    // current move can become a z move
+    u8 viable:1;   // current move can become a z move
     u8 viewing:1;  // if player is viewing the z move name instead of regular moves
-    u8 active:1;   // is z move being used this turn
-    u8 zStatusActive:1;
-    u8 healReplacement:1;
-    u8 activeCategory:2;  // active z move category
-    u8 zUnused:1;
-    u8 triggerSpriteId;
+    u8 healReplacement:6;
     u8 possibleZMoves[MAX_BATTLERS_COUNT];
-    u16 chosenZMove;  // z move of move cursor is on
-    u8 effect;
-    u8 used[MAX_BATTLERS_COUNT];   //one per bank for multi-battles
-    u16 toBeUsed[MAX_BATTLERS_COUNT];  // z moves per battler to be used
     u16 baseMoves[MAX_BATTLERS_COUNT];
-    u8 categories[MAX_BATTLERS_COUNT];
 };
 
 struct DynamaxData
 {
-    bool8 playerSelect;
-    u8 triggerSpriteId;
-    u8 toDynamax; // flags using gBitTable
-    bool8 alreadyDynamaxed[NUM_BATTLE_SIDES];
-    bool8 dynamaxed[MAX_BATTLERS_COUNT];
     u8 dynamaxTurns[MAX_BATTLERS_COUNT];
-    u8 usingMaxMove[MAX_BATTLERS_COUNT];
-    u8 activeCategory;
-    u8 categories[MAX_BATTLERS_COUNT];
-    u16 baseMove[MAX_BATTLERS_COUNT]; // base move of Max Move
+    u16 baseMoves[MAX_BATTLERS_COUNT]; // base move of Max Move
     u16 lastUsedBaseMove;
     u16 levelUpHP;
 };
 
-struct TeraData
+struct BattleGimmickData
 {
-    bool8 toTera; // flags using gBitTable
-    bool8 isTerastallized[NUM_BATTLE_SIDES]; // stored as a bitfield for each side's party members
-    bool8 alreadyTerastallized[MAX_BATTLERS_COUNT];
-    bool8 playerSelect;
-    u32 stellarBoostFlags[NUM_BATTLE_SIDES]; // stored as a bitfield of flags for all types for each side
+    u8 usableGimmick[MAX_BATTLERS_COUNT];                // first usable gimmick that can be selected for each battler
+    bool8 playerSelect;                                  // used to toggle trigger and update battle UI
     u8 triggerSpriteId;
     u8 indicatorSpriteId[MAX_BATTLERS_COUNT];
+    u8 toActivate;                                       // stores whether a battler should transform at start of turn as bitfield
+    u8 activeGimmick[NUM_BATTLE_SIDES][PARTY_SIZE];      // stores the active gimmick for each party member
+    bool8 activated[MAX_BATTLERS_COUNT][GIMMICKS_COUNT]; // stores whether a trainer has used gimmick
 };
 
 struct LostItem
@@ -743,11 +706,9 @@ struct BattleStruct
     u8 activeAbilityPopUps; // as bits for each battler
     u8 abilityPopUpSpriteIds[MAX_BATTLERS_COUNT][2];    // two per battler
     bool8 throwingPokeBall;
-    struct MegaEvolutionData mega;
-    struct UltraBurstData burst;
     struct ZMoveData zmove;
     struct DynamaxData dynamax;
-    struct TeraData tera;
+    struct BattleGimmickData gimmick;
     const u8 *trainerSlideMsg;
     bool8 trainerSlideLowHpMsgDone;
     u8 introState;
@@ -818,6 +779,8 @@ struct BattleStruct
     u8 quickDrawRandom[MAX_BATTLERS_COUNT];
     u8 boosterEnergyActivates;
     u8 distortedTypeMatchups;
+    u8 categoryOverride; // for Z-Moves and Max Moves
+    u32 stellarBoostFlags[NUM_BATTLE_SIDES]; // stored as a bitfield of flags for all types for each side
 };
 
 // The palaceFlags member of struct BattleStruct contains 1 flag per move to indicate which moves the AI should consider,

include/battle_controllers.h

@@ -98,10 +98,7 @@ enum {
 
 // Special return values in gBattleBufferB from Battle Controller functions.
 #define RET_VALUE_LEVELED_UP   11
-#define RET_MEGA_EVOLUTION (1 << 7)
-#define RET_ULTRA_BURST    (1 << 6)
-#define RET_DYNAMAX        (1 << 5)
-#define RET_TERASTAL       (1 << 4)
+#define RET_GIMMICK        (1 << 7)
 
 struct UnusedControllerStruct
 {
@@ -131,8 +128,6 @@ struct ChooseMoveStruct
     u8 monType1;
     u8 monType2;
     u8 monType3;
-    struct MegaEvolutionData mega;
-    struct UltraBurstData burst;
     struct ZMoveData zmove;
 };
 

include/battle_dynamax.h

@@ -56,21 +56,19 @@ enum MaxMoveEffect
 	MAX_EFFECT_BYPASS_PROTECT,
 };
 
-bool32 IsDynamaxed(u16 battlerId);
-bool32 CanDynamax(u16 battlerId);
-bool32 IsGigantamaxed(u16 battlerId);
+bool32 CanDynamax(u32 battler);
+bool32 IsGigantamaxed(u32 battler);
 void ApplyDynamaxHPMultiplier(u32 battler, struct Pokemon* mon);
-void PrepareBattlerForDynamax(u16 battlerId);
-u16 GetNonDynamaxHP(u16 battlerId);
-u16 GetNonDynamaxMaxHP(u32 battlerId);
-void UndoDynamax(u16 battlerId);
-bool32 IsMoveBlockedByMaxGuard(u16 move);
-bool32 IsMoveBlockedByDynamax(u16 move);
+void ActivateDynamax(u32 battler);
+u16 GetNonDynamaxHP(u32 battler);
+u16 GetNonDynamaxMaxHP(u32 battler);
+void UndoDynamax(u32 battler);
+bool32 IsMoveBlockedByMaxGuard(u32 move);
+bool32 IsMoveBlockedByDynamax(u32 move);
 
-bool32 ShouldUseMaxMove(u16 battlerId, u16 baseMove);
-u16 GetMaxMove(u16 battlerId, u16 baseMove);
-u8 GetMaxMovePower(u16 move);
-bool32 IsMaxMove(u16 move);
+u16 GetMaxMove(u32 battler, u32 baseMove);
+u8 GetMaxMovePower(u32 move);
+bool32 IsMaxMove(u32 move);
 void ChooseDamageNonTypesString(u8 type);
 
 void BS_UpdateDynamax(void);
@@ -83,10 +81,4 @@ void BS_HealOneSixth(void);
 void BS_TryRecycleBerry(void);
 void BS_JumpIfDynamaxed(void);
 
-void ChangeDynamaxTriggerSprite(u8 spriteId, u8 animId);
-void CreateDynamaxTriggerSprite(u8, bool8);
-void HideDynamaxTriggerSprite(void);
-bool32 IsDynamaxTriggerSpriteActive(void);
-void DestroyDynamaxTriggerSprite(void);
-
 #endif

include/battle_gimmick.h

@@ -0,0 +1,52 @@
+#ifndef GUARD_BATTLE_GIMMICK_H
+#define GUARD_BATTLE_GIMMICK_H
+
+enum Gimmick
+{
+    GIMMICK_NONE,
+    GIMMICK_MEGA,
+    GIMMICK_ULTRA_BURST,
+    GIMMICK_Z_MOVE,
+    GIMMICK_DYNAMAX,
+    GIMMICK_TERA,
+    GIMMICKS_COUNT,
+};
+
+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;
+    bool32 (*CanActivate)(u32 battler);
+    void (*ActivateGimmick)(u32 battler);
+};
+
+void AssignUsableGimmicks(void);
+bool32 CanActivateGimmick(u32 battler, enum Gimmick gimmick);
+bool32 IsGimmickSelected(u32 battler, enum Gimmick gimmick);
+void SetActiveGimmick(u32 battler, enum Gimmick gimmick);
+enum Gimmick GetActiveGimmick(u32 battler);
+bool32 ShouldTrainerBattlerUseGimmick(u32 battler, enum Gimmick gimmick);
+bool32 HasTrainerUsedGimmick(u32 battler, enum Gimmick gimmick);
+void SetGimmickAsActivated(u32 battler, enum Gimmick gimmick);
+
+void ChangeGimmickTriggerSprite(u32 spriteId, u32 animId);
+void CreateGimmickTriggerSprite(u32 battler);
+bool32 IsGimmickTriggerSpriteActive(void);
+void HideGimmickTriggerSprite(void);
+void DestroyGimmickTriggerSprite(void);
+
+void LoadIndicatorSpritesGfx(void);
+u32 GetIndicatorTileTag(u32 battler);
+u32 GetIndicatorPalTag(u32 battler);
+void UpdateIndicatorVisibilityAndType(u32 healthboxId, bool32 invisible);
+void UpdateIndicatorOamPriority(u32 healthboxId, u32 oamPriority);
+void UpdateIndicatorLevelData(u32 healthboxId, u32 level);
+void CreateIndicatorSprite(u32 battler);
+void DestroyIndicatorSprite(u32 healthboxId);
+
+extern const struct GimmickInfo gGimmicksInfo[];
+
+#endif

include/battle_interface.h

@@ -48,13 +48,10 @@ enum
 #define TAG_HEALTHBAR_PAL               TAG_HEALTHBAR_PLAYER1_TILE
 #define TAG_HEALTHBOX_PAL               TAG_HEALTHBOX_PLAYER1_TILE
 
-#define TAG_MEGA_TRIGGER_TILE           0xD777
+#define TAG_GIMMICK_TRIGGER_TILE        0xD777
 #define TAG_MEGA_INDICATOR_TILE         0xD778
 #define TAG_ALPHA_INDICATOR_TILE        0xD779
 #define TAG_OMEGA_INDICATOR_TILE        0xD77A
-#define TAG_ZMOVE_TRIGGER_TILE          0xD77B
-#define TAG_BURST_TRIGGER_TILE          0xD77C
-#define TAG_DYNAMAX_TRIGGER_TILE        0xD77D
 #define TAG_DYNAMAX_INDICATOR_TILE      0xD77E
 
 #define TAG_NORMAL_INDICATOR_TILE       0xD77F
@@ -79,14 +76,10 @@ enum
 #define TAG_STELLAR_INDICATOR_TILE      0xD792
 #define TAG_TERA_TRIGGER_TILE           0xD793
 
-#define TAG_MEGA_TRIGGER_PAL            0xD777
+#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_ZMOVE_TRIGGER_PAL           0xD77B
-#define TAG_BURST_TRIGGER_PAL           0xD77C
-#define TAG_DYNAMAX_TRIGGER_PAL         0xD77D
 #define TAG_TERA_INDICATOR_PAL          0xD77E
-#define TAG_TERA_TRIGGER_PAL            0xD77F
 
 enum
 {
@@ -116,18 +109,6 @@ void InitBattlerHealthboxCoords(u8 battler);
 void GetBattlerHealthboxCoords(u8 battler, s16 *x, s16 *y);
 void UpdateHpTextInHealthbox(u32 healthboxSpriteId, u32 maxOrCurrent, s16 currHp, s16 maxHp);
 void SwapHpBarsWithHpText(void);
-void ChangeMegaTriggerSprite(u8 spriteId, u8 animId);
-void CreateMegaTriggerSprite(u8 battlerId, u8 palId);
-bool32 IsMegaTriggerSpriteActive(void);
-void HideMegaTriggerSprite(void);
-void DestroyMegaTriggerSprite(void);
-void ChangeBurstTriggerSprite(u8 spriteId, u8 animId);
-void CreateBurstTriggerSprite(u8 battlerId, u8 palId);
-bool32 IsBurstTriggerSpriteActive(void);
-void HideBurstTriggerSprite(void);
-void DestroyBurstTriggerSprite(void);
-void MegaIndicator_LoadSpritesGfx(void);
-void MegaIndicator_SetVisibilities(u32 healthboxId, bool32 invisible);
 u8 CreatePartyStatusSummarySprites(u8 battler, struct HpAndStatus *partyInfo, bool8 skipPlayer, bool8 isBattleStart);
 void Task_HidePartyStatusSummary(u8 taskId);
 void UpdateHealthboxAttribute(u8 healthboxSpriteId, struct Pokemon *mon, u8 elementId);
@@ -136,7 +117,6 @@ u8 GetScaledHPFraction(s16 hp, s16 maxhp, u8 scale);
 u8 GetHPBarLevel(s16 hp, s16 maxhp);
 void CreateAbilityPopUp(u8 battlerId, u32 ability, bool32 isDoubleBattle);
 void DestroyAbilityPopUp(u8 battlerId);
-void HideTriggerSprites(void);
 bool32 CanThrowLastUsedBall(void);
 void TryHideLastUsedBall(void);
 void TryRestoreLastUsedBall(void);

include/battle_script_commands.h

@@ -47,7 +47,7 @@ bool32 IsShieldsDownProtected(u32 battler);
 u32 IsAbilityStatusProtected(u32 battler);
 bool32 TryResetBattlerStatChanges(u8 battler);
 bool32 CanCamouflage(u8 battlerId);
-u16 GetNaturePowerMove(void);
+u32 GetNaturePowerMove(u32 battler);
 void StealTargetItem(u8 battlerStealer, u8 battlerItem);
 u8 GetCatchingBattler(void);
 u32 GetHighestStatId(u32 battlerId);

include/battle_scripts.h

@@ -84,6 +84,7 @@ extern const u8 BattleScript_DmgHazardsOnBattlerScripting[];
 extern const u8 BattleScript_DmgHazardsOnFaintedBattler[];
 extern const u8 BattleScript_PerishSongTakesLife[];
 extern const u8 BattleScript_PerishSongCountGoesDown[];
+extern const u8 BattleScript_AllStatsUpZMove[];
 extern const u8 BattleScript_AllStatsUp[];
 extern const u8 BattleScript_RapidSpinAway[];
 extern const u8 BattleScript_WrapFree[];

include/battle_terastal.h

@@ -1,31 +1,14 @@
 #ifndef GUARD_BATTLE_TERASTAL_H
 #define GUARD_BATTLE_TERASTAL_H
 
-void PrepareBattlerForTera(u32 battler);
+void ActivateTera(u32 battler);
 void ApplyBattlerVisualsForTeraAnim(u32 battler);
 bool32 CanTerastallize(u32 battler);
 u32 GetBattlerTeraType(u32 battler);
-bool32 IsTerastallized(u32 battler);
 void ExpendTypeStellarBoost(u32 battler, u32 type);
 bool32 IsTypeStellarBoosted(u32 battler, u32 type);
 uq4_12_t GetTeraMultiplier(u32 battler, u32 type);
 
 u16 GetTeraTypeRGB(u32 type);
 
-void ChangeTeraTriggerSprite(u8 spriteId, u8 animId);
-void CreateTeraTriggerSprite(u8 battler, u8 palId);
-bool32 IsTeraTriggerSpriteActive(void);
-void HideTeraTriggerSprite(void);
-void DestroyTeraTriggerSprite(void);
-
-void TeraIndicator_LoadSpriteGfx(void);
-bool32 TeraIndicator_ShouldBeInvisible(u32 battler);
-u8 TeraIndicator_GetSpriteId(u32 healthboxSpriteId);
-void TeraIndicator_SetVisibilities(u32 healthboxId, bool32 invisible);
-void TeraIndicator_UpdateOamPriorities(u32 healthboxId, u32 oamPriority);
-void TeraIndicator_UpdateLevel(u32 healthboxId, u32 level);
-void TeraIndicator_CreateSprite(u32 battler, u32 healthboxSpriteId);
-void TeraIndicator_DestroySprite(u32 healthboxSpriteId);
-void TeraIndicator_UpdateType(u32 battler, u32 healthboxSpriteId);
-
 #endif