Secondary/primary effects overhaul

[cfmnephrite]

Revamping the way move secondary/primary effects are stored and handled by adding a compound literal of AdditionalEffects to the BattleMove struct.

Description

Each AdditionalEffect looks like this and lets you define primary/secondary effects and ones that target the opponent or the attacker::

struct AdditionalEffect
{
    u8 self:1;
    u8 onlyIfTargetRaisedStats:1;
    u8 onChargeTurnOnly:1;
    u8 chance; // 0% = effect certain, primary effect
    u16 moveEffect;
};

The ADDITIONAL_EFFECTS macro let you define an array of them in a compound literal that also counts them:

#define ADDITIONAL_EFFECTS(...) EFFECTS_ARR( __VA_ARGS__ ), .numAdditionalEffects = ARRAY_COUNT(EFFECTS_ARR( __VA_ARGS__ ))

#define EFFECTS_ARR(...) (const struct AdditionalEffect[]) { __VA_ARGS__ }

Example:

[MOVE_TRIPLE_ARROWS] =
{
    #if B_UPDATED_MOVE_DATA >= GEN_9
        .power = 90,
        .pp = 10,
    #else
        .power = 50,
        .pp = 15,
    #endif
    .effect = EFFECT_HIT,
    .type = TYPE_FIGHTING,
    .accuracy = 100,
    .criticalHitStage = 1,
    .target = MOVE_TARGET_SELECTED,
    .priority = 0,
    .category = BATTLE_CATEGORY_PHYSICAL,
    .sheerForceBoost = TRUE,
    .additionalEffects = ADDITIONAL_EFFECTS({
        .moveEffect = MOVE_EFFECT_DEF_MINUS_1,
        .chance = 50,
    },
    {
        .moveEffect = MOVE_EFFECT_FLINCH,
        .chance = 30,
    }),
},

In order to call an array of multiple effects, we modify the seteffectwithchance macro (renamed to setadditionaleffects) to loop if we set the move effect to MOVE_EFFECT_CONTINUE (see below).

.macro setadditionaleffects
+1:
.byte 0x15
+jumpifhalfword CMP_EQUAL, sMOVE_EFFECT, MOVE_EFFECT_CONTINUE, 1b
.endm

As we loop through, it's necessary to track the index in gBattleStruct->additionalEffectsCounter - if this value is less than the total number of effects this move has in additionalEffects, increment the counter, set gBattlescripting.moveEffect to MOVE_EFFECT_CONTINUE and the macro calls the function again.

if (gBattleMoves[gCurrentMove].numAdditionalEffects > gBattleStruct->additionalEffectsCounter)
{
    u32 percentChance;
    const u8 *currentPtr = gBattlescriptCurrInstr;
    const struct AdditionalEffect *additionalEffect = &gBattleMoves[gCurrentMove].additionalEffects[gBattleStruct->additionalEffectsCounter];

    // Check additional effect flags
    // self-targeting move effects cannot occur multiple times per turn
    // only occur on the last setmoveeffect when there are multiple targets
    if (!(gBattleMoves[gCurrentMove].additionalEffects[gBattleStruct->additionalEffectsCounter].self
        && GetNextTarget(gBattleMoves[gCurrentMove].target, TRUE) != MAX_BATTLERS_COUNT)
        && !(additionalEffect->onlyIfTargetRaisedStats && !gProtectStructs[gBattlerTarget].statRaised)
        && additionalEffect->onChargeTurnOnly == gProtectStructs[gBattlerAttacker].chargingTurn)
    {
        percentChance = CalcSecondaryEffectChance(gBattlerAttacker, GetBattlerAbility(gBattlerAttacker), additionalEffect);

        // Activate effect if it's primary (chance == 0) or if RNGesus says so
        if ((percentChance == 0) || RandomPercentage(RNG_SECONDARY_EFFECT + gBattleStruct->additionalEffectsCounter, percentChance))
        {
            gBattleScripting.moveEffect = additionalEffect->moveEffect | (MOVE_EFFECT_AFFECTS_USER * (additionalEffect->self));

            SetMoveEffect(
                percentChance == 0, // a primary effect
                percentChance >= 100 // certain to happen
            );
        }
    }

    // Move script along if we haven't jumped elsewhere
    if (gBattlescriptCurrInstr == currentPtr)
        gBattlescriptCurrInstr = cmd->nextInstr;

    // Call setadditionaleffects again in the case of a move with multiple effects
    gBattleStruct->additionalEffectsCounter++;
    if (gBattleMoves[gCurrentMove].numAdditionalEffects > gBattleStruct->additionalEffectsCounter)
        gBattleScripting.moveEffect = MOVE_EFFECT_CONTINUE;
    else
        gBattleScripting.moveEffect = gBattleStruct->additionalEffectsCounter = 0;
}
else
{
    gBattleScripting.moveEffect = 0;
    gBattlescriptCurrInstr = cmd->nextInstr;
}

Out of scope:

• AI improvements (much has been changed to check for move_effects rather than effects but still more to be done)
• an issue where moves with self-targeting effects that hit multiple mons and are only supposed to activate once may not activate if the move fails to connect with the last target

Discord contact info

thechurchofcage

[cfmnephrite]

Please solve conflicts :)

Done. I've had to do this like three or four times already because by the nature of this PR, pretty much any change in upcoming to battle_scripts, battle_move_effects, or gBattleMoves will cause a conflict. If there are conflicts next time you check, please disregard and check anyway and I'll merge once more when it's approved.

[AlexOn1ine]

A couple more things. Why do some effects have a 100%, some don't? E.g Thousand Waves and Spirit Shackle. Additionally can you write a test for Payday where Player and AI use them on the same turn?

Also I've noticed some minor details when going over the moves. Mighty Cleave doesn't break Protect and Sky Attack has a high critical ratio.

PR looks clean and so far I haven't found a broken move though I noticed some inconsistencies for Payday but high chance I'm wrong here.

[cfmnephrite]

A couple more things. Why do some effects have a 100%, some don't? E.g Thousand Waves and Spirit Shackle. Additionally can you write a test for Payday where Player and AI use them on the same turn?

Also I've noticed some minor details when going over the moves. Mighty Cleave doesn't break Protect and Sky Attack has a high critical ratio.

PR looks clean and so far I haven't found a broken move though I noticed some inconsistencies for Payday but high chance I'm wrong here.

Thanks for checking! For anyone else checking, we discussed Thousand Waves vs Spirit Shackle here. Mighty Cleave was given EFFECT_FEINT when I started so I simply gave it the move effect - I didn't think to check what its correct effect was. I don't know what happened with Sky Attack... Both fixed now

[AsparagusEduardo]

So close 👀