Gimmick Refactor

[AgustinGDLV]

The goal of this PR is to unify common features of generational mechanics in the codebase, provide an easy to use interface, and hopefully remove and simplify a lot of redundant code. The graphics behind a gimmick are now probably as simple as it would be to add an icon for an item, and I was able to remove a lot of redundant data in gBattleStruct.

Ideally, gimmicks become nearly as easy to implement as abilities: potentially difficult depending on complexity, but very specific to the ability itself.

New Gimmick Interface

• Defined general struct gBattleStruct->gimmick for common variables belonging to each generational gimmick (allowing the complete removal of MegaData, BurstData, and TeraData):

struct BattleGimmickData
{
    u8 usableGimmick[MAX_BATTLERS_COUNT];
    bool8 playerSelect;
    u8 triggerSpriteId;
    u8 toActivate;
    u8 activeGimmick[NUM_BATTLE_SIDES][PARTY_SIZE];
    bool8 activated[MAX_BATTLERS_COUNT][GIMMICKS_COUNT];
};

• Defined info struct (organized in gGimmicksInfo in data/gimmicks.h) to quickly implement common features of generational gimmicks:

struct GimmickInfo
{
    const struct SpritePalette * triggerPal;
    const struct SpriteSheet * triggerSheet;
    const struct SpriteTemplate * triggerTemplate;
    const struct SpritePalette * indicatorPal;
    const struct SpriteSheet * indicatorSheet;
    bool32 (*CanActivate)(u32 battler);
    void (*ActivateGimmick)(u32 battler);
};

• Defined set of common functions to interact with gimmicks:

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);

• Consolidated RET_MEGA_EVO, RET_ULTRA_BURST, etc. into RET_GIMMICK (we were out of bits, lol)
• Consolidated triggers into one set of functions, choosing to display the first usable gimmick.
• Consolidated indicators into one set of functions that work with the refactor.

Other Changes

• Refactored Z-Move logic to simplify the code and eliminate the majority of the fields in ZMoveData.
• Updated test runner to work with new interface and with Z-Moves.
• Updated AI and trainer_proc to work with new interface.

Issues Fixed

• Resolves Add Z-Move support in battle tests #4393 by implementing battle controller functionality for Z-Moves.
• [TBD] Resolves Z-Moves desync Recorded Battles #3332 for the same reason.
• Writes tests for all of the untested Z-Move status effects in Missing Battle Tests #2706.
• Fixes Z_EFFECT_ALL_STATS_UP functionality, which had not been raised as an issue yet.
• Fixes Z-Nature Power, Z-Copycat, Z-Me First, and Z-Sleep Talk incorrectly using a normal move and not a Z-Move, which had not been raised as an issue yet. (some of these were caught recently!)
• Fixes Breakneck Blitz incorrectly being affected by -ate abilities, which had not been raised as an issue yet.
• Fixes Instruct incorrectly not failing if the target last used a Z-Move, which had not been raised as an issue yet.
• On the order of ~500-1000 lines of redundant / duplicate code removed! :^)
• Fixes Guardian of Alola incorrectly doing 50% of the target's HP instead of 75%.

Videos

These videos are a bit out-of-date (as of 5/20/24), but nothing other than graphics should have changed.

Here!

Ultra Burst

gimmick.refactor.1.mp4

Mega

gimmick.refactor.2.mp4

Dynamax and Terastallization

gimmick.refactor.3.mp4

[AgustinGDLV]

Reminder to redefine.

[Bassoonian]

Don't forget this :)

[AsparagusEduardo]

Suggested change

	// #define NDEBUG
	#define NDEBUG

[Bassoonian]

There's a bunch of conflicts for you to solve before I can start reviewing :)

[Bassoonian]

Preliminary code review. @AlexOn1ine will take care of trying to break things :)

[Bassoonian]

Don't forget this :)

[Bassoonian]

Out of scope, but this makes me wonder if a BattlerHasType function would be useful for cases like these

[AsparagusEduardo]

Yeah, would be useful for other stuff like type immunity to moves, such as Grass types being immune to powder moves. Let's write it down so we don't forget.

[AsparagusEduardo]

Suggested change

	TURN { MOVE(opponent, MOVE_TACKLE);
	MOVE(player, MOVE_QUICK_ATTACK, gimmick: GIMMICK_Z_MOVE); }
	TURN { MOVE(opponent, MOVE_TACKLE); MOVE(player, MOVE_QUICK_ATTACK, gimmick: GIMMICK_Z_MOVE); }

[AsparagusEduardo]

If Ion Deluge changes type, shouldn't it change the move animation to be Gigavolt Havoc?

We might need to test in USUM.

[AgustinGDLV]

Bulbapedia specifically says that Breakneck Blitz is transformed into an Electric-type move, so I want to say that it stays as Breakneck Blitz, but we may need to test to confirm.

[AsparagusEduardo]

If that's the case that should be fine, we can check post-merge :)

[AsparagusEduardo]

Just some style changes left to do. After that, should be ready to merge :)

[AlexOn1ine]

Thanks for the change. Just maybe a minor optimization?

[AlexOn1ine]

@AsparagusEduardo Can you merge? There are two minor things that need to be addressed but they aren't urgent. I will open an issue for it.

Mia