mirror of
https://github.com/kwsch/PKHeX
synced 2024-12-19 00:43:14 +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
61 lines
2.5 KiB
C#
61 lines
2.5 KiB
C#
using static PKHeX.Core.EvolutionRestrictions;
|
|
using static PKHeX.Core.LegalityCheckStrings;
|
|
|
|
namespace PKHeX.Core;
|
|
|
|
/// <summary>
|
|
/// Verify Evolution Information for a matched <see cref="IEncounterable"/>
|
|
/// </summary>
|
|
public static class EvolutionVerifier
|
|
{
|
|
/// <summary>
|
|
/// Verifies Evolution scenarios of an <see cref="IEncounterable"/> for an input <see cref="PKM"/> and relevant <see cref="LegalInfo"/>.
|
|
/// </summary>
|
|
/// <param name="pk">Source data to verify</param>
|
|
/// <param name="info">Source supporting information to verify with</param>
|
|
public static CheckResult VerifyEvolution(PKM pk, LegalInfo info)
|
|
{
|
|
// Check if basic evolution methods are satisfiable with this encounter.
|
|
if (!IsValidEvolution(pk, info))
|
|
return new CheckResult(Severity.Invalid, LEvoInvalid, CheckIdentifier.Evolution);
|
|
|
|
// Check if complex evolution methods are satisfiable with this encounter.
|
|
if (!IsValidEvolutionWithMove(pk, info))
|
|
return new CheckResult(Severity.Invalid, string.Format(LMoveEvoFCombination_0, ParseSettings.SpeciesStrings[pk.Species]), CheckIdentifier.Evolution);
|
|
|
|
return VALID;
|
|
}
|
|
|
|
private static readonly CheckResult VALID = new(CheckIdentifier.Evolution);
|
|
|
|
/// <summary>
|
|
/// Checks if the Evolution from the source <see cref="IEncounterable"/> is valid.
|
|
/// </summary>
|
|
/// <param name="pk">Source data to verify</param>
|
|
/// <param name="info">Source supporting information to verify with</param>
|
|
/// <returns>Evolution is valid or not</returns>
|
|
private static bool IsValidEvolution(PKM pk, LegalInfo info)
|
|
{
|
|
var chains = info.EvoChainsAllGens;
|
|
if (chains.Get(pk.Context).Length == 0)
|
|
return false; // Can't exist as current species
|
|
|
|
// OK if un-evolved from original encounter
|
|
int species = pk.Species;
|
|
var enc = info.EncounterMatch;
|
|
if (species == enc.Species) // never evolved
|
|
return true;
|
|
|
|
// Bigender->Fixed (non-Genderless) destination species, accounting for PID-Gender relationship
|
|
if (species == (int)Species.Vespiquen && enc.Generation < 6 && (pk.EncryptionConstant & 0xFF) >= 0x1F) // Combee->Vespiquen Invalid Evolution
|
|
return false;
|
|
|
|
// Double check that our encounter was able to exist as the encounter species.
|
|
foreach (var z in chains.Get(enc.Context))
|
|
{
|
|
if (z.Species == enc.Species)
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
}
|