Frontier ban refactor

[Bassoonian]

Refactors the frontier bans to check base species ID and to give the list of ineligible Pokémon some more flexibility by removing hardcoded numbers. Also adds post-Gen3 species to the ban list with appropriate configs.

Images

Issue(s) that this PR fixes

Fixes #2322

Discord contact info

bassoonian

[mrgriffin]

I'd feel so bad if I accidentally checked the eligibility list a second time :D

[mrgriffin]

Actually, I'm a little intrigued by this existing piece of code... Is that saying that we put a line break if there was an odd number of species? I would have expected it to be more like count % SPECIES_PER_LINE == (SPECIES_PER_LINE - 1)? I think GF had previously assumed that there was always at most 2 species per line, which is why it was valid (& 1 standing in for % 2 == 1)? If there were, e.g. 4 or 6 banned Pokémon does the text get cut off?

[ghoulslash]

This seems like something that would be better served as a scrollable list menu

[leo60228]

Would it potentially make sense to split SPECIES_FLAG_LEGENDARY into SPECIES_FLAG_LEGENDARY and SPECIES_FLAG_SUBLEGENDARY like in modern games, and then just check SPECIES_FLAG_LEGENDARY and SPECIES_FLAG_MYTHICAL?

[LOuroboros]

This seems like something that would be better served as a scrollable list menu

I agree with this because it'd probably mean less text strings to scroll through 😆

Ongoing discussion

[Bassoonian]

I do just want to say the list only includes the banned Pokémon registered as caught in your dex, so the odds of all of them effectively showing up is very small in practice. I'm not sure how exactly what you'd envision a scrollable list menu to look like if it's part of a chain of messages? We could also check what SwSh does with mentioning bans, because if they don't bother anymore, maybe we shouldn't either.

[Bassoonian]

Would it potentially make sense to split SPECIES_FLAG_LEGENDARY into SPECIES_FLAG_LEGENDARY and SPECIES_FLAG_SUBLEGENDARY like in modern games, and then just check SPECIES_FLAG_LEGENDARY and SPECIES_FLAG_MYTHICAL?

We specifically chose not to use flags for this because the flag would then either need to be applied to all forms, which makes it harder to filter them out from the list, or only to the base form, which makes it confusing why it doesn't apply to the forms. Right now, it's a simple, single array of base species that's easy to understand.

[AsparagusEduardo]

I do just want to say the list only includes the banned Pokémon registered as caught in your dex, so the odds of all of them effectively showing up is very small in practice. I'm not sure how exactly what you'd envision a scrollable list menu to look like if it's part of a chain of messages? We could also check what SwSh does with mentioning bans, because if they don't bother anymore, maybe we shouldn't either.

SwSh's Battle Tower doesn't have restriction. Restricted Battling does and it doesn't list the banned Pokémon.
I'm charging my 3DS to see what Gen 7 does.

[AsparagusEduardo]

Found a video that shows what happens if you try to enter with a Special Pokémon in Gen 7: https://youtu.be/jpk_h2HYhUs?si=mMkho8PpfHgBIRQp&t=382

[mrgriffin]

Actually, I'm a little intrigued by this existing piece of code... Is that saying that we put a line break if there was an odd number of species? I would have expected it to be more like count % SPECIES_PER_LINE == (SPECIES_PER_LINE - 1)? I think GF had previously assumed that there was always at most 2 species per line, which is why it was valid (& 1 standing in for % 2 == 1)? If there were, e.g. 4 or 6 banned Pokémon does the text get cut off?

It doesn't get cut off, but it does a little goofy:

Before:

After:

diff --git a/src/frontier_util.c b/src/frontier_util.c
index b385729af2..df3afcd8a2 100644
--- a/src/frontier_util.c
+++ b/src/frontier_util.c
@@ -1922,8 +1922,6 @@ static u8 AppendCaughtBannedMonSpeciesName(u16 species, u8 count, s32 numBannedM
     return count;
 }
 
-#undef SPECIES_PER_LINE
-
 static void AppendIfValid(u16 species, u16 heldItem, u16 hp, u8 lvlMode, u8 monLevel, u16 *speciesArray, u16 *itemsArray, u8 *count)
 {
     s32 i = 0;
@@ -2041,7 +2039,7 @@ static void CheckPartyIneligibility(void)
         }
         else
         {
-            if (count & 1)
+            if (count % SPECIES_PER_LINE == SPECIES_PER_LINE - 1)
                 StringAppend(gStringVar1, gText_LineBreak);
             else
                 StringAppend(gStringVar1, gText_Space2);
@@ -2056,6 +2054,8 @@ static void CheckPartyIneligibility(void)
     #undef numEligibleMons
 }
 
+#undef SPECIES_PER_LINE
+
 static void ValidateVisitingTrainer(void)
 {
     ValidateEReaderTrainer();

[AsparagusEduardo]

This seems like something that would be better served as a scrollable list menu

If someone wants to implement that, they can go right ahead, but it shouldn't postpone this PR.

[Bassoonian]

Found a video that shows what happens if you try to enter with a Special Pokémon in Gen 7: https://youtu.be/jpk_h2HYhUs?si=mMkho8PpfHgBIRQp&t=382

So does this mean we can just yeet the list? Or should I incorporate MGriffin's improvement and call it a day? As mentioned before, it is very unlikely anyone will encounter the full list unless they're 100%ing an enhancement hack

[AsparagusEduardo]

So does this mean we can just yeet the list? Or should I incorporate MGriffin's improvement and call it a day? As mentioned before, it is very unlikely anyone will encounter the full list unless they're 100%ing an enhancement hack

The list is there in Gen 7, but displayed in a separate window. With MGriffin's improvement it should be good enough for now.

[Bassoonian]

Ready for review!