PKHeX/PKHeX.Core/Legality/Encounters/EncounterTrade/EncounterTrade6.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

28 lines
1 KiB
C#

namespace PKHeX.Core;
/// <summary>
/// Generation 6 Trade Encounter
/// </summary>
/// <inheritdoc cref="EncounterTrade"/>
public sealed record EncounterTrade6(GameVersion Version, byte OT_Memory, byte OT_Intensity, byte OT_Feeling, ushort OT_TextVar) : EncounterTrade(Version), IMemoryOT
{
public override int Generation => 6;
public override EntityContext Context => EntityContext.Gen6;
public override int Location => Locations.LinkTrade6NPC;
public byte OT_Memory { get; set; } = OT_Memory;
public byte OT_Intensity { get; set; } = OT_Intensity;
public byte OT_Feeling { get; set; } = OT_Feeling;
public ushort OT_TextVar { get; set; } = OT_TextVar;
protected override void ApplyDetails(ITrainerInfo sav, EncounterCriteria criteria, PKM pk)
{
base.ApplyDetails(sav, criteria, pk);
if (pk is IMemoryOT o)
{
o.OT_Memory = OT_Memory;
o.OT_Intensity = OT_Intensity;
o.OT_Feeling = OT_Feeling;
o.OT_TextVar = OT_TextVar;
}
}
}