PKHeX/PKHeX.Core/Legality/LearnSource/Group/LearnGroup3.cs

202 lines
7.9 KiB
C#
Raw Normal View History

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 23:15:27 +00:00
using System;
namespace PKHeX.Core;
/// <summary>
/// Group that checks the source of a move in <see cref="GameVersion.Gen3"/>.
/// </summary>
public sealed class LearnGroup3 : ILearnGroup
{
public static readonly LearnGroup3 Instance = new();
private const int Generation = 3;
public ILearnGroup? GetPrevious(PKM pk, EvolutionHistory history, IEncounterTemplate enc, LearnOption option) => null; // Gen3 is the end of the line!
public bool HasVisited(PKM pk, EvolutionHistory history) => history.HasVisitedGen3;
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 23:15:27 +00:00
public bool Check(Span<MoveResult> result, ReadOnlySpan<int> current, PKM pk, EvolutionHistory history, IEncounterTemplate enc,
MoveSourceType types = MoveSourceType.All, LearnOption option = LearnOption.Current)
{
var evos = history.Gen3;
for (var i = 0; i < evos.Length; i++)
Check(result, current, pk, evos[i], i, types);
if (types.HasFlagFast(MoveSourceType.Encounter) && enc is EncounterEgg { Generation: Generation } egg)
CheckEncounterMoves(result, current, egg);
if (types.HasFlagFast(MoveSourceType.LevelUp) && enc.Species is (int)Species.Nincada && evos.Length == 2 && evos[0].Species == (int)Species.Shedinja)
CheckNincadaMoves(result, current, evos[^1]);
return MoveResult.AllParsed(result);
}
private static void CheckNincadaMoves(Span<MoveResult> result, ReadOnlySpan<int> current, EvoCriteria nincada)
{
if (MoveResult.AllParsed(result))
return;
// If a Ninjask move is already marked as learned, it's not a valid move for Nincada. Reset that index and try again.
for (int i = 0; i < current.Length; i++)
{
if (result[i].Info.Method is not LearnMethod.ShedinjaEvo)
continue;
result[i] = default;
break;
}
// If a result is not valid, check to see if it is a Shedinja move.
var shedinja = LearnSource3E.Instance;
var moves = shedinja.GetLearnset((int)Species.Ninjask, 0);
for (var i = 0; i < result.Length; i++)
{
if (result[i].Valid)
continue;
var move = current[i];
if (move == 0)
break;
var level = moves.GetLevelLearnMove(move);
if (level == -1 || !nincada.InsideLevelRange(level))
continue;
var info = new MoveLearnInfo(LearnMethod.ShedinjaEvo, LearnEnvironment.Pt, (byte)level);
result[i] = new MoveResult(info, 0, Generation);
break; // Can only have one Ninjask move.
}
}
private static void CheckEncounterMoves(Span<MoveResult> result, ReadOnlySpan<int> current, EncounterEgg egg)
{
ReadOnlySpan<int> eggMoves, levelMoves;
if (egg.Version is GameVersion.E)
{
var inst = LearnSource3E.Instance;
eggMoves = inst.GetEggMoves(egg.Species, egg.Form);
levelMoves = egg.CanInheritMoves
? inst.GetLearnset(egg.Species, egg.Form).Moves
: ReadOnlySpan<int>.Empty;
}
else if (egg.Version is GameVersion.FR)
{
var inst = LearnSource3FR.Instance;
eggMoves = inst.GetEggMoves(egg.Species, egg.Form);
levelMoves = egg.CanInheritMoves
? inst.GetLearnset(egg.Species, egg.Form).Moves
: ReadOnlySpan<int>.Empty;
}
else if (egg.Version is GameVersion.LG)
{
var inst = LearnSource3LG.Instance;
eggMoves = inst.GetEggMoves(egg.Species, egg.Form);
levelMoves = egg.CanInheritMoves
? inst.GetLearnset(egg.Species, egg.Form).Moves
: ReadOnlySpan<int>.Empty;
}
else
{
var inst = LearnSource3RS.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)
{
var rs = LearnSource3RS.Instance;
var species = evo.Species;
if (!rs.TryGetPersonal(species, evo.Form, out var rp))
return; // should never happen.
var e = LearnSource3E.Instance;
var fr = LearnSource3FR.Instance;
var lg = LearnSource3LG.Instance;
var ep = e[species];
var fp = fr[species];
var lp = lg[species];
for (int i = result.Length - 1; i >= 0; i--)
{
if (result[i].Valid)
continue;
// Level Up moves are different for each game, but TM/HM is shared (use Emerald).
var move = current[i];
var chk = e.GetCanLearn(pk, ep, evo, move, types);
if (chk != default)
{
result[i] = new(chk, (byte)stage, Generation);
continue;
}
chk = rs.GetCanLearn(pk, rp, evo, move, types & (MoveSourceType.LevelUp | MoveSourceType.AllTutors));
if (chk != default)
{
result[i] = new(chk, (byte)stage, Generation);
continue;
}
chk = fr.GetCanLearn(pk, fp, evo, move, types & (MoveSourceType.LevelUp | MoveSourceType.AllTutors));
if (chk != default)
{
result[i] = new(chk, (byte)stage, Generation);
continue;
}
chk = lg.GetCanLearn(pk, lp, evo, move, types & MoveSourceType.LevelUp); // Tutors same as FR
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 evos = history.Gen3;
foreach (var evo in evos)
GetAllMoves(result, pk, evo, types);
if (enc.Species is (int)Species.Nincada && evos.Length == 2 && evos[0].Species == (int)Species.Shedinja)
{
var shedinja = LearnSource3E.Instance;
var moves = shedinja.GetLearnset((int)Species.Ninjask, 0);
(bool HasMoves, int start, int end) = moves.GetMoveRange(evos[0].LevelMax, 20);
if (HasMoves)
{
var all = moves.Moves;
for (int i = start; i < end; i++)
result[all[i]] = true;
}
}
}
private static void GetAllMoves(Span<bool> result, PKM pk, EvoCriteria evo, MoveSourceType types)
{
LearnSource3E.Instance.GetAllMoves(result, pk, evo, types);
LearnSource3RS.Instance.GetAllMoves(result, pk, evo, types & (MoveSourceType.LevelUp | MoveSourceType.AllTutors));
LearnSource3FR.Instance.GetAllMoves(result, pk, evo, types & (MoveSourceType.LevelUp | MoveSourceType.AllTutors));
LearnSource3LG.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;
}
}
}