PKHeX/PKHeX.Core/Legality/Evolutions/EvolutionSets/EvolutionSet3.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

81 lines
3 KiB
C#

using System;
using System.Collections.Generic;
using static System.Buffers.Binary.BinaryPrimitives;
namespace PKHeX.Core;
/// <summary>
/// Generation 3 Evolution Branch Entries
/// </summary>
public static class EvolutionSet3
{
private static EvolutionMethod GetMethod(ReadOnlySpan<byte> data)
{
var method = data[0];
var arg = ReadUInt16LittleEndian(data[2..]);
var species = SpeciesConverter.GetG4Species(ReadUInt16LittleEndian(data[4..]));
//2 bytes padding
switch (method)
{
case 1: /* Friendship*/
case 2: /* Friendship day*/
case 3: /* Friendship night*/
return new EvolutionMethod((EvolutionType)method, species, Argument: arg, LevelUp: 1);
case 5: /* Trade */
case 6: /* Trade while holding */
return new EvolutionMethod((EvolutionType)method, species, Argument: arg);
case 4: /* Level Up */
return new EvolutionMethod(EvolutionType.LevelUp, species, Argument: arg, Level: (byte)arg, LevelUp: 1);
case 7: /* Use item */
return new EvolutionMethod((EvolutionType)(method + 1), species, Argument: arg);
case 15: /* Beauty evolution*/
return new EvolutionMethod((EvolutionType)(method + 1), species, Argument: arg, LevelUp: 1);
case 8: /* Tyrogue -> Hitmonchan */
case 9: /* Tyrogue -> Hitmonlee */
case 10: /* Tyrogue -> Hitmontop*/
case 11: /* Wurmple -> Silcoon evolution */
case 12: /* Wurmple -> Cascoon evolution */
case 13: /* Nincada -> Ninjask evolution */
case 14: /* Shedinja spawn in Nincada -> Ninjask evolution */
return new EvolutionMethod((EvolutionType)(method + 1), species, Argument: arg, Level: (byte)arg, LevelUp: 1);
default:
throw new ArgumentOutOfRangeException(nameof(method));
}
}
public static IReadOnlyList<EvolutionMethod[]> GetArray(ReadOnlySpan<byte> data)
{
var evos = new EvolutionMethod[Legal.MaxSpeciesID_3 + 1][];
evos[0] = Array.Empty<EvolutionMethod>();
for (int i = 1; i <= Legal.MaxSpeciesIndex_3; i++)
{
int g4species = SpeciesConverter.GetG4Species(i);
if (g4species == 0)
continue;
const int maxCount = 5;
const int size = 8;
int offset = i * (maxCount * size);
int count = 0;
for (; count < maxCount; count++)
{
if (data[offset + (count * size)] == 0)
break;
}
if (count == 0)
{
evos[g4species] = Array.Empty<EvolutionMethod>();
continue;
}
var set = new EvolutionMethod[count];
for (int j = 0; j < set.Length; j++)
set[j] = GetMethod(data.Slice(offset + (j * size), size));
evos[g4species] = set;
}
return evos;
}
}