PKHeX/PKHeX.Core/Legality/Encounters/IEncounterTemplate.cs
Kurt 9166d0eb64
Refactoring: Move Source (Legality) (#3560)
Rewrites a good amount of legality APIs pertaining to:
* Legal moves that can be learned
* Evolution chains & cross-generation paths
* Memory validation with forgotten moves

In generation 8, there are 3 separate contexts an entity can exist in: SW/SH, BD/SP, and LA. Not every entity can cross between them, and not every entity from generation 7 can exist in generation 8 (Gogoat, etc). By creating class models representing the restrictions to cross each boundary, we are able to better track and validate data.

The old implementation of validating moves was greedy: it would iterate for all generations and evolutions, and build a full list of every move that can be learned, storing it on the heap. Now, we check one game group at a time to see if the entity can learn a move that hasn't yet been validated. End result is an algorithm that requires 0 allocation, and a smaller/quicker search space.

The old implementation of storing move parses was inefficient; for each move that was parsed, a new object is created and adjusted depending on the parse. Now, move parse results are `struct` and store the move parse contiguously in memory. End result is faster parsing and 0 memory allocation.

* `PersonalTable` objects have been improved with new API methods to check if a species+form can exist in the game.
* `IEncounterTemplate` objects have been improved to indicate the `EntityContext` they originate in (similar to `Generation`).
* Some APIs have been extended to accept `Span<T>` instead of Array/IEnumerable
2022-08-03 16:15:27 -07:00

39 lines
1.1 KiB
C#

namespace PKHeX.Core;
public interface IEncounterTemplate : ISpeciesForm, IVersion, IGeneration, IShiny
{
/// <summary>
/// Original Context
/// </summary>
EntityContext Context { get; }
/// <summary>
/// Indicates if the encounter originated as an egg.
/// </summary>
bool EggEncounter { get; }
/// <summary>
/// Minimum level for the encounter.
/// </summary>
byte LevelMin { get; }
byte LevelMax { get; }
}
public static partial class Extensions
{
private static bool IsWithinEncounterRange(this IEncounterTemplate encounter, int lvl)
{
return encounter.LevelMin <= lvl && lvl <= encounter.LevelMax;
}
public static bool IsWithinEncounterRange(this IEncounterTemplate encounter, PKM pk)
{
if (!pk.HasOriginalMetLocation)
return encounter.IsWithinEncounterRange(pk.CurrentLevel);
if (encounter.EggEncounter)
return pk.CurrentLevel == encounter.LevelMin;
if (encounter is MysteryGift g)
return pk.CurrentLevel == g.Level;
return pk.CurrentLevel == pk.Met_Level;
}
}