mirror of
https://github.com/kwsch/PKHeX
synced 2024-12-22 10:23:09 +00:00
9166d0eb64
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
86 lines
3.5 KiB
C#
86 lines
3.5 KiB
C#
using System.Collections.Generic;
|
|
|
|
namespace PKHeX.Core;
|
|
|
|
/// <summary>
|
|
/// Calculated Information storage with properties useful for parsing the legality of the input <see cref="PKM"/>.
|
|
/// </summary>
|
|
public sealed class LegalInfo : IGeneration
|
|
{
|
|
/// <summary>The <see cref="PKM"/> object used for comparisons.</summary>
|
|
public readonly PKM Entity;
|
|
|
|
/// <summary>The generation of games the <see cref="PKM"/> originated from.</summary>
|
|
public int Generation { get; private set; }
|
|
|
|
/// <summary>The matched Encounter details for the <see cref="PKM"/>. </summary>
|
|
public IEncounterable EncounterMatch
|
|
{
|
|
get => _match;
|
|
set
|
|
{
|
|
if (!ReferenceEquals(_match, EncounterInvalid.Default) && (value.LevelMin != _match.LevelMin || value.Species != _match.Species))
|
|
_evochains = null; // clear if evo chain has the potential to be different
|
|
_match = value;
|
|
Parse.Clear();
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Original encounter data for the <see cref="Entity"/>.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Generation 1/2 <see cref="Entity"/> that are transferred forward to Generation 7 are restricted to new encounter details.
|
|
/// By retaining their original match, more information can be provided by the parse.
|
|
/// </remarks>
|
|
public IEncounterable EncounterOriginal => EncounterOriginalGB ?? EncounterMatch;
|
|
|
|
internal IEncounterable? EncounterOriginalGB;
|
|
private IEncounterable _match = EncounterInvalid.Default;
|
|
|
|
/// <summary>Top level Legality Check result list for the <see cref="EncounterMatch"/>.</summary>
|
|
internal readonly List<CheckResult> Parse;
|
|
|
|
private const int MoveCount = 4;
|
|
public readonly MoveResult[] Relearn = new MoveResult[MoveCount];
|
|
public readonly MoveResult[] Moves = new MoveResult[MoveCount];
|
|
|
|
public EvolutionHistory EvoChainsAllGens => _evochains ??= EvolutionChain.GetEvolutionChainsAllGens(Entity, EncounterMatch);
|
|
private EvolutionHistory? _evochains;
|
|
|
|
/// <summary><see cref="RNG"/> related information that generated the <see cref="PKM.PID"/>/<see cref="PKM.IVs"/> value(s).</summary>
|
|
public PIDIV PIDIV
|
|
{
|
|
get => _pidiv;
|
|
internal set
|
|
{
|
|
_pidiv = value;
|
|
PIDParsed = true;
|
|
}
|
|
}
|
|
|
|
public bool PIDParsed { get; private set; }
|
|
private PIDIV _pidiv;
|
|
|
|
/// <summary>Indicates whether or not the <see cref="PIDIV"/> can originate from the <see cref="EncounterMatch"/>.</summary>
|
|
/// <remarks>This boolean is true until all valid <see cref="PIDIV"/> encounters are tested, after which it is false.</remarks>
|
|
public bool PIDIVMatches { get; internal set; } = true;
|
|
|
|
/// <summary>Indicates whether or not the <see cref="PIDIV"/> can originate from the <see cref="EncounterMatch"/> with explicit <see cref="RNG"/> <see cref="Frame"/> matching.</summary>
|
|
/// <remarks>This boolean is true until all valid <see cref="Frame"/> entries are tested for all possible <see cref="EncounterSlot"/> matches, after which it is false.</remarks>
|
|
public bool FrameMatches { get; internal set; } = true;
|
|
|
|
public LegalInfo(PKM pk, List<CheckResult> parse)
|
|
{
|
|
Entity = pk;
|
|
Parse = parse;
|
|
StoreMetadata(pk.Generation);
|
|
}
|
|
|
|
internal void StoreMetadata(int gen)
|
|
{
|
|
// We can call this method at the start for any Gen3+ encounter iteration.
|
|
// We need to call this for each Gen1/2 encounter as Version is not stored for those origins.
|
|
Generation = gen;
|
|
}
|
|
}
|