PKHeX/PKHeX.Core/Legality/Encounters/EncounterStatic/EncounterStatic1.cs

94 lines
3.1 KiB
C#
Raw Normal View History

namespace PKHeX.Core
{
/// <summary>
/// Generation 1 Static Encounter
/// </summary>
/// <inheritdoc cref="EncounterStatic"/>
public record EncounterStatic1 : EncounterStatic
{
public override int Generation => 1;
public sealed override byte Level { get; init; }
private const int LightBallPikachuCatchRate = 0xA3; // 163
public EncounterStatic1(byte species, byte level, GameVersion game) : base(game)
{
Species = species;
Level = level;
}
2021-02-03 23:22:48 +00:00
protected override void ApplyDetails(ITrainerInfo sav, EncounterCriteria criteria, PKM pk)
{
base.ApplyDetails(sav, criteria, pk);
var pk1 = (PK1) pk;
if (Species == (int) Core.Species.Pikachu && Version == GameVersion.YW && Level == 5 && Moves.Count == 0)
{
pk1.Catch_Rate = LightBallPikachuCatchRate; // Light Ball
2021-02-03 23:22:48 +00:00
return;
}
// Encounters can have different Catch Rates (RBG vs Y)
2021-06-10 05:56:19 +00:00
var table = Version == GameVersion.YW ? PersonalTable.Y : PersonalTable.RB;
2021-02-03 23:22:48 +00:00
pk1.Catch_Rate = table[Species].CatchRate;
}
protected override bool IsMatchLevel(PKM pkm, IDexLevel evo)
{
// Met Level is not stored in the PK1 format.
// Check if it is at or above the encounter level.
return Level <= evo.LevelMax;
}
protected override bool IsMatchLocation(PKM pkm)
{
// Met Location is not stored in the PK1 format.
return true;
}
public override bool IsMatchExact(PKM pkm, IDexLevel evo)
{
if (!base.IsMatchExact(pkm, evo))
return false;
// Encounters with this version have to originate from the Japanese Blue game.
if (!pkm.Japanese && Version == GameVersion.BU)
return false;
return true;
}
Fracture the encounter matching checks to allow progressive validation (#3137) ## Issue We want to discard-but-remember any slots that aren't a perfect fit, on the off chance that a better one exists later in the search space. If there's no better match, then we gotta go with what we got. ## Example: Wurmple exists in area `X`, and also has a more rare slot for Silcoon, with the same level for both slots. * We have a Silcoon that we've leveled up a few times. Was our Silcoon originally a Wurmple, or was it caught as a Silcoon? * To be sure, we have to check the EC/PID if the Wurmple wouldn't evolve into Cascoon instead. * We don't want to wholly reject that Wurmple slot, as maybe the Met Level isn't within Silcoon's slot range. --- Existing implementation would store "deferred" matches in a list; we only need to keep 1 of these matches around (less allocation!). We also want to differentiate between a "good" deferral and a "bad" deferral; I don't think this is necessary but it's currently used by Mystery Gift matching (implemented for the Eeveelution mystery gifts which matter for evolution moves). The existing logic didn't use inheritance, and instead had static methods being reused across generations. Quite kludgy. Also, the existing logic was a pain to modify the master encounter yield methods, as one generation's quirks had to not impact all other generations that used the method. --- The new implementation splits out the encounter yielding methods to be separate for each generation / subset. Now, things don't have to check `WasLink` for Gen7 origin, because Pokémon Link wasn't a thing in Gen7. --- ## Future Maybe refactoring yielders into "GameCores" that expose yielding behaviors / properties, rather than the static logic. As more generations and side-gamegroups get added (thanks LGPE/GO/GameCube), all this switch stuff gets annoying to maintain instead of just overriding/inheritance. ## Conclusion This shouldn't impact any legality results negatively; if you notice any regressions, report them! This should reduce false flags where we didn't defer-discard an encounter when we should have (wild area mons being confused with raids).
2021-01-30 01:55:27 +00:00
protected override bool IsMatchPartial(PKM pkm)
{
if (pkm is not PK1 pk1)
return false;
if (PK1.IsCatchRateHeldItem(pk1.Catch_Rate))
return false;
if (IsCatchRateValid(pk1))
return false;
return true;
}
private bool IsCatchRateValid(PK1 pk1)
{
var catch_rate = pk1.Catch_Rate;
// Light Ball (Yellow) starter
if (Version == GameVersion.YW && Species == (int)Core.Species.Pikachu && Level == 5)
{
return catch_rate == LightBallPikachuCatchRate;
}
if (Version == GameVersion.Stadium)
{
// Amnesia Psyduck has different catch rates depending on language
if (Species == (int)Core.Species.Psyduck)
return catch_rate == (pk1.Japanese ? 167 : 168);
2020-12-25 20:30:26 +00:00
return catch_rate is 167 or 168;
}
// Encounters can have different Catch Rates (RBG vs Y)
2021-06-10 05:54:21 +00:00
return GBRestrictions.RateMatchesEncounter(Species, Version, catch_rate);
}
}
}