PKHeX/PKHeX.Core/Legality/Encounters/EncounterStatic/EncounterStatic6.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

57 lines
1.7 KiB
C#

namespace PKHeX.Core;
/// <summary>
/// Generation 6 Static Encounter
/// </summary>
/// <inheritdoc cref="EncounterStatic"/>
public sealed record EncounterStatic6(GameVersion Version) : EncounterStatic(Version), IContestStats
{
public override int Generation => 6;
public override EntityContext Context => EntityContext.Gen6;
public byte CNT_Cool { get; init; }
public byte CNT_Beauty { get; init; }
public byte CNT_Cute { get; init; }
public byte CNT_Smart { get; init; }
public byte CNT_Tough { get; init; }
public byte CNT_Sheen { get; init; }
protected override bool IsMatchLocation(PKM pk)
{
if (base.IsMatchLocation(pk))
return true;
if (Species != (int) Core.Species.Pikachu)
return false;
// Cosplay Pikachu is given from multiple locations
var loc = pk.Met_Location;
return loc is 180 or 186 or 194;
}
protected override bool IsMatchEggLocation(PKM pk)
{
if (!EggEncounter)
return base.IsMatchEggLocation(pk);
var eggloc = pk.Egg_Location;
if (!pk.IsEgg) // hatched
return eggloc == EggLocation || eggloc == Locations.LinkTrade6;
// Unhatched:
if (eggloc != EggLocation)
return false;
if (pk.Met_Location is not (0 or Locations.LinkTrade6))
return false;
return true;
}
protected override void ApplyDetails(ITrainerInfo tr, EncounterCriteria criteria, PKM pk)
{
base.ApplyDetails(tr, criteria, pk);
var pk6 = (PK6)pk;
this.CopyContestStatsTo(pk6);
pk6.SetRandomMemory6();
pk6.SetRandomEC();
}
}