PKHeX/PKHeX.Core/Legality/LearnSource/Group/LearnGroup6.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

216 lines
8.3 KiB
C#

using System;
namespace PKHeX.Core;
/// <summary>
/// Group that checks the source of a move in <see cref="GameVersion.Gen6"/>.
/// </summary>
public sealed class LearnGroup6 : ILearnGroup
{
public static readonly LearnGroup6 Instance = new();
private const int Generation = 6;
public ILearnGroup? GetPrevious(PKM pk, EvolutionHistory history, IEncounterTemplate enc, LearnOption option) => enc.Generation is Generation ? null : LearnGroup5.Instance;
public bool HasVisited(PKM pk, EvolutionHistory history) => history.Gen6.Length != 0;
public bool Check(Span<MoveResult> result, ReadOnlySpan<int> current, PKM pk, EvolutionHistory history, IEncounterTemplate enc,
MoveSourceType types = MoveSourceType.All, LearnOption option = LearnOption.Current)
{
var mode = GetCheckMode(enc, pk);
var evos = history.Gen6;
for (var i = 0; i < evos.Length; i++)
Check(result, current, pk, evos[i], i, types, option, mode);
if (types.HasFlagFast(MoveSourceType.Encounter) && enc is EncounterEgg { Generation: Generation } egg)
CheckEncounterMoves(result, current, egg);
return MoveResult.AllParsed(result);
}
private static void CheckEncounterMoves(Span<MoveResult> result, ReadOnlySpan<int> current, EncounterEgg egg)
{
ReadOnlySpan<int> eggMoves, levelMoves;
if (egg.Version > GameVersion.Y) // OR/AS
{
var inst = LearnSource6AO.Instance;
eggMoves = inst.GetEggMoves(egg.Species, egg.Form);
levelMoves = egg.CanInheritMoves
? inst.GetLearnset(egg.Species, egg.Form).Moves
: ReadOnlySpan<int>.Empty;
}
else
{
var inst = LearnSource6XY.Instance;
eggMoves = inst.GetEggMoves(egg.Species, egg.Form);
levelMoves = egg.CanInheritMoves
? inst.GetLearnset(egg.Species, egg.Form).Moves
: ReadOnlySpan<int>.Empty;
}
for (var i = result.Length - 1; i >= 0; i--)
{
if (result[i].Valid)
continue;
var move = current[i];
if (eggMoves.Contains(move))
result[i] = new(LearnMethod.EggMove);
else if (levelMoves.Contains(move))
result[i] = new(LearnMethod.InheritLevelUp);
else if (move is (int)Move.VoltTackle && egg.CanHaveVoltTackle)
result[i] = new(LearnMethod.SpecialEgg);
}
}
private static void Check(Span<MoveResult> result, ReadOnlySpan<int> current, PKM pk, EvoCriteria evo, int stage, MoveSourceType types, LearnOption option, CheckMode mode)
{
if (!FormChangeUtil.ShouldIterateForms(evo.Species, evo.Form, Generation, option))
{
CheckInternal(result, current, pk, evo, stage, types, option, mode);
return;
}
// Check all forms
var inst = LearnSource6AO.Instance;
if (!inst.TryGetPersonal(evo.Species, evo.Form, out var pi))
return;
var fc = pi.FormCount;
for (int i = 0; i < fc; i++)
CheckInternal(result, current, pk, evo with { Form = (byte)i }, stage, types, option, mode);
}
private static CheckMode GetCheckMode(IGeneration enc, PKM pk)
{
// We can check if it has visited specific sources. We won't check the games it hasn't visited.
if (enc.Generation != Generation || !pk.IsUntraded)
return CheckMode.Both;
if (pk.AO)
return CheckMode.AO;
return CheckMode.XY;
}
private enum CheckMode
{
Both,
XY,
AO,
}
private static void CheckInternal(Span<MoveResult> result, ReadOnlySpan<int> current, PKM pk, EvoCriteria evo, int stage, MoveSourceType types, LearnOption option, CheckMode mode)
{
if (mode == CheckMode.Both)
CheckBoth(result, current, pk, evo, stage, types, option);
else if (mode == CheckMode.AO)
CheckSingle(result, current, pk, evo, stage, LearnSource6AO.Instance, types, option);
else
CheckSingle(result, current, pk, evo, stage, LearnSource6XY.Instance, types, option);
}
private static void CheckBoth(Span<MoveResult> result, ReadOnlySpan<int> current, PKM pk, EvoCriteria evo, int stage, MoveSourceType types, LearnOption option)
{
var ao = LearnSource6AO.Instance;
var species = evo.Species;
if (!ao.TryGetPersonal(species, evo.Form, out var ao_pi))
return; // should never happen.
var xy = LearnSource6XY.Instance;
for (int i = result.Length - 1; i >= 0; i--)
{
if (result[i].Valid)
continue;
// Level Up moves are different for each game, but others (TM/Tutor) are same.
var move = current[i];
var chk = ao.GetCanLearn(pk, ao_pi, evo, move, types, option);
if (chk != default)
{
result[i] = new(chk, (byte)stage, Generation);
continue;
}
xy.GetCanLearn(pk, ao_pi, evo, move, types & MoveSourceType.LevelUp, option);
if (chk != default)
result[i] = new(chk, (byte)stage, Generation);
}
}
private static void CheckSingle<T>(Span<MoveResult> result, ReadOnlySpan<int> current, PKM pk, EvoCriteria evo, int stage, T game, MoveSourceType types, LearnOption option) where T : ILearnSource
{
var species = evo.Species;
if (!game.TryGetPersonal(species, evo.Form, out var pi))
return; // should never happen.
for (int i = result.Length - 1; i >= 0; i--)
{
if (result[i].Valid)
continue;
var move = current[i];
var chk = game.GetCanLearn(pk, pi, evo, move, types, option);
if (chk != default)
result[i] = new(chk, (byte)stage, Generation);
}
}
public void GetAllMoves(Span<bool> result, PKM pk, EvolutionHistory history, IEncounterTemplate enc, MoveSourceType types = MoveSourceType.All, LearnOption option = LearnOption.Current)
{
if (types.HasFlagFast(MoveSourceType.Encounter) && enc.Generation == Generation)
FlagEncounterMoves(enc, result);
var mode = GetCheckMode(enc, pk);
foreach (var evo in history.Gen6)
GetAllMoves(result, pk, evo, types, option, mode);
}
private static void GetAllMoves(Span<bool> result, PKM pk, EvoCriteria evo, MoveSourceType types, LearnOption option, CheckMode mode)
{
if (!FormChangeUtil.ShouldIterateForms(evo.Species, evo.Form, Generation, option))
{
GetAllMovesInternal(result, pk, evo, types, mode);
return;
}
// Check all forms
var inst = LearnSource6AO.Instance;
if (!inst.TryGetPersonal(evo.Species, evo.Form, out var pi))
return;
var fc = pi.FormCount;
for (int i = 0; i < fc; i++)
GetAllMovesInternal(result, pk, evo with { Form = (byte)i }, types, mode);
}
private static void GetAllMovesInternal(Span<bool> result, PKM pk, EvoCriteria evo, MoveSourceType types, CheckMode mode)
{
if (mode is CheckMode.Both)
GetAllMovesBoth(result, pk, evo, types);
else if (mode is CheckMode.AO)
GetAllMovesSingle(result, pk, evo, LearnSource6AO.Instance, types);
else
GetAllMovesSingle(result, pk, evo, LearnSource6XY.Instance, types);
}
private static void GetAllMovesSingle<T>(Span<bool> result, PKM pk, EvoCriteria evo, T instance, MoveSourceType types) where T : ILearnSource
{
instance.GetAllMoves(result, pk, evo, types);
}
private static void GetAllMovesBoth(Span<bool> result, PKM pk, EvoCriteria evo, MoveSourceType types)
{
LearnSource6AO.Instance.GetAllMoves(result, pk, evo, types);
LearnSource6XY.Instance.GetAllMoves(result, pk, evo, types & MoveSourceType.LevelUp);
}
private static void FlagEncounterMoves(IEncounterTemplate enc, Span<bool> result)
{
if (enc is IMoveset { Moves: int[] { Length: not 0 } x })
{
foreach (var move in x)
result[move] = true;
}
if (enc is IRelearn { Relearn: int[] { Length: not 0 } r })
{
foreach (var move in r)
result[move] = true;
}
}
}