PKHeX/PKHeX.Core/Legality/Encounters/EncounterMisc/EncounterInvalid.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

46 lines
1.4 KiB
C#

using System;
namespace PKHeX.Core;
/// <summary>
/// Invalid Encounter Data
/// </summary>
public sealed record EncounterInvalid : IEncounterable
{
public static readonly EncounterInvalid Default = new();
public int Species { get; }
public int Form { get; }
public byte LevelMin { get; }
public byte LevelMax { get; }
public bool EggEncounter { get; }
public int Generation { get; }
public EntityContext Context { get; }
public GameVersion Version { get; }
public bool IsShiny => false;
public Shiny Shiny => Shiny.Never;
public string Name => "Invalid";
public string LongName => "Invalid";
public int Location => 0;
public int EggLocation => 0;
public AbilityPermission Ability => AbilityPermission.Any12H;
public Ball FixedBall => Ball.None;
private EncounterInvalid() { }
public EncounterInvalid(PKM pk)
{
Species = pk.Species;
Form = pk.Form;
LevelMin = (byte)pk.Met_Level;
LevelMax = (byte)pk.CurrentLevel;
EggEncounter = pk.WasEgg;
Generation = pk.Generation;
Version = (GameVersion)pk.Version;
Context = pk.Context;
}
public PKM ConvertToPKM(ITrainerInfo tr) => ConvertToPKM(tr, EncounterCriteria.Unrestricted);
public PKM ConvertToPKM(ITrainerInfo tr, EncounterCriteria criteria) => throw new ArgumentException($"Cannot convert an {nameof(EncounterInvalid)} to PKM.");
}