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

101 lines
3.1 KiB
C#
Raw Normal View History

using System;
using System.Collections.Generic;
using System.Linq;
namespace PKHeX.Core
{
/// <summary>
/// Event data for Generation 2
/// </summary>
/// <inheritdoc cref="EncounterStatic2"/>
public sealed record EncounterStatic2E : EncounterStatic2, IFixedGBLanguage
{
public EncounterGBLanguage Language { get; init; } = EncounterGBLanguage.Japanese;
/// <summary> Trainer name for the event. </summary>
public string OT_Name { get; init; } = string.Empty;
public IReadOnlyList<string> OT_Names { get; init; } = Array.Empty<string>();
/// <summary> Trainer ID for the event. </summary>
public int TID { get; init; } = -1;
public bool IsGift => TID != -1;
public int CurrentLevel { get; init; } = -1;
public EncounterStatic2E(byte species, byte level, GameVersion ver) : base(species, level, ver)
{
}
public override bool IsMatchExact(PKM pkm, IDexLevel evo)
{
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
if (!base.IsMatchExact(pkm, evo))
return false;
if (Language != EncounterGBLanguage.Any && pkm.Japanese != (Language == EncounterGBLanguage.Japanese))
return false;
if (CurrentLevel != -1 && CurrentLevel > pkm.CurrentLevel)
return false;
2020-10-18 17:57:18 +00:00
// EC/PID check doesn't exist for these, so check Shiny state here.
if (!IsShinyValid(pkm))
2020-10-18 17:57:18 +00:00
return false;
if (EggEncounter && !pkm.IsEgg)
return true;
// Check OT Details
if (TID != -1 && pkm.TID != TID)
return false;
if (OT_Name.Length != 0)
{
if (pkm.OT_Name != OT_Name)
return false;
}
else if (OT_Names.Count != 0)
{
if (!OT_Names.Contains(pkm.OT_Name))
return false;
}
return true;
}
private bool IsShinyValid(PKM pkm) => Shiny switch
{
Shiny.Never => !pkm.IsShiny,
Shiny.Always => pkm.IsShiny,
2021-08-20 20:49:20 +00:00
_ => true,
};
2020-12-31 20:14:24 +00:00
protected override int GetMinimalLevel() => CurrentLevel == -1 ? base.GetMinimalLevel() : CurrentLevel;
protected override PKM GetBlank(ITrainerInfo tr) => Language switch
{
2021-02-03 21:49:14 +00:00
EncounterGBLanguage.Japanese => new PK2(true),
EncounterGBLanguage.International => new PK2(),
_ => new PK2(tr.Language == 1),
};
protected override void ApplyDetails(ITrainerInfo sav, EncounterCriteria criteria, PKM pk)
{
base.ApplyDetails(sav, criteria, pk);
if (CurrentLevel != -1) // Restore met level
pk.Met_Level = LevelMin;
if (TID != -1)
pk.TID = TID;
if (IsGift)
pk.OT_Gender = 0;
if (OT_Name.Length != 0)
pk.OT_Name = OT_Name;
else if (OT_Names.Count != 0)
pk.OT_Name = OT_Names[Util.Rand.Next(OT_Names.Count)];
}
}
}