PKHeX/PKHeX.Core/Legality/Moves/Breeding/MoveBreed3.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

174 lines
5.3 KiB
C#

using System;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;
using static PKHeX.Core.EggSource34;
using static PKHeX.Core.LearnSource3;
namespace PKHeX.Core;
/// <summary>
/// Inheritance logic for Generation 3.
/// </summary>
/// <remarks>Refer to <see cref="EggSource34"/> for inheritance ordering.</remarks>
public static class MoveBreed3
{
private const int level = 5;
/// <inheritdoc cref="MoveBreed.Validate"/>
public static bool Validate(int species, GameVersion version, ReadOnlySpan<int> moves, Span<byte> origins)
{
var count = moves.IndexOf(0);
if (count == 0)
return false;
if (count == -1)
count = moves.Length;
var learn = GameData.GetLearnsets(version);
var table = GameData.GetPersonal(version);
var learnset = learn[species];
var pi = table[species];
var egg = Legal.EggMovesRS[species].Moves;
var actual = MemoryMarshal.Cast<byte, EggSource34>(origins);
Span<byte> possible = stackalloc byte[count];
var value = new BreedInfo<EggSource34>(actual, possible, learnset, moves, level);
if (species is (int)Species.Pichu && moves[count - 1] is (int)Move.VoltTackle && version == GameVersion.E)
actual[--count] = VoltTackle;
bool valid;
if (count == 0)
{
valid = VerifyBaseMoves(value);
}
else
{
bool inherit = Breeding.GetCanInheritMoves(species);
MarkMovesForOrigin(value, egg, count, inherit, pi);
valid = RecurseMovesForOrigin(value, count - 1);
}
if (!valid)
CleanResult(actual, possible);
return valid;
}
private static void CleanResult(Span<EggSource34> valueActual, Span<byte> valuePossible)
{
for (int i = 0; i < valuePossible.Length; i++)
{
var poss = valuePossible[i];
if (poss == 0)
continue;
if (valueActual[i] != 0)
continue;
for (int j = 0; j < (int)Max; j++)
{
if ((poss & (1 << j)) == 0)
continue;
valueActual[i] = (EggSource34)j;
break;
}
}
}
private static bool RecurseMovesForOrigin(in BreedInfo<EggSource34> info, int start, EggSource34 type = Max - 1)
{
int i = start;
do
{
var unpeel = type - 1;
if (unpeel != 0 && RecurseMovesForOrigin(info, i, unpeel))
return true;
var permit = info.Possible[i];
if ((permit & (1 << (int)type)) == 0)
return false;
info.Actual[i] = type;
} while (--i >= 0);
return VerifyBaseMoves(info);
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
private static bool VerifyBaseMoves(in BreedInfo<EggSource34> info)
{
var count = 0;
foreach (var x in info.Actual)
{
if (x == Base)
count++;
else
break;
}
var moves = info.Moves;
if (count == -1)
return moves[^1] != 0;
var baseMoves = info.Learnset.GetBaseEggMoves(info.Level);
if (baseMoves.Length < count)
return false;
if (moves[^1] == 0 && count != baseMoves.Length)
return false;
for (int i = count - 1, b = baseMoves.Length - 1; i >= 0; i--, b--)
{
var move = moves[i];
var expect = baseMoves[b];
if (expect != move)
return false;
}
// A low-index base egg move may be nudged out, but can only reappear if sufficient non-base moves are before it.
if (baseMoves.Length == count)
return true;
for (int i = count; i < info.Actual.Length; i++)
{
var isBase = (info.Possible[i] & (1 << (int)Base)) != 0;
if (!isBase)
continue;
var baseIndex = baseMoves.IndexOf(moves[i]);
var min = moves.Length - baseMoves.Length + baseIndex;
if (i < min + count)
return false;
}
return true;
}
private static void MarkMovesForOrigin(in BreedInfo<EggSource34> value, ReadOnlySpan<int> eggMoves, int count, bool inheritLevelUp, PersonalInfo info)
{
var possible = value.Possible;
var learn = value.Learnset;
var baseEgg = value.Learnset.GetBaseEggMoves(value.Level);
var tm = info.TMHM;
var tmlist = TM_3.AsSpan(0, 50);
var hmlist = HM_3.AsSpan();
var moves = value.Moves;
for (int i = 0; i < count; i++)
{
var move = moves[i];
if (baseEgg.IndexOf(move) != -1)
possible[i] |= 1 << (int)Base;
if (inheritLevelUp && learn.GetLevelLearnMove(move) != -1)
possible[i] |= 1 << (int)ParentLevelUp;
if (eggMoves.Contains(move))
possible[i] |= 1 << (int)FatherEgg;
var tmIndex = tmlist.IndexOf(move);
if (tmIndex != -1 && tm[tmIndex])
possible[i] |= 1 << (int)FatherTM;
var hmIndex = hmlist.IndexOf(move);
if (hmIndex != -1 && tm[hmIndex + 50])
possible[i] |= 1 << (int)FatherTM;
}
}
}