PKHeX/PKHeX.Core/Legality/LearnSource/LearnEnvironment.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

51 lines
1.3 KiB
C#

using System;
namespace PKHeX.Core;
using static LearnEnvironment;
public enum LearnEnvironment : byte
{
None,
/* Gen1 */ RB, YW,
/* Gen2 */ GS, C,
/* Gen3 */ RS, E, FR, LG,
/* Gen4 */ DP, Pt, HGSS,
/* Gen5 */ BW, B2W2,
/* Gen6 */ XY, ORAS,
/* Gen7 */ SM, USUM, GG,
/* Gen8 */ SWSH, BDSP, PLA,
}
public static class LearnEnvironmentExtensions
{
public static bool IsSpecified(this LearnEnvironment value) => value is not None;
public static byte GetGeneration(this LearnEnvironment value) => value switch
{
RB or YW => 1,
GS or C => 2,
RS or E or FR or LG => 3,
DP or Pt or HGSS => 4,
BW or B2W2 => 5,
XY or ORAS => 6,
SM or USUM or GG => 7,
SWSH or BDSP or PLA => 8,
_ => 0,
};
public static ReadOnlySpan<EvoCriteria> GetEvolutions(this LearnEnvironment value, EvolutionHistory history) => value switch
{
RB or YW => history.Gen1,
GS or C => history.Gen2,
RS or E or FR or LG => history.Gen3,
DP or Pt or HGSS => history.Gen4,
BW or B2W2 => history.Gen5,
XY or ORAS => history.Gen6,
SM or USUM => history.Gen7,
GG => history.Gen7b,
SWSH => history.Gen8,
PLA => history.Gen8a,
BDSP => history.Gen8b,
_ => ReadOnlySpan<EvoCriteria>.Empty,
};
}