mirror of
https://github.com/kwsch/PKHeX
synced 2024-12-22 10:23:09 +00:00
9166d0eb64
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
69 lines
2.6 KiB
C#
69 lines
2.6 KiB
C#
using System;
|
|
|
|
namespace PKHeX.Core;
|
|
|
|
public static class LearnPossible
|
|
{
|
|
/// <summary>
|
|
/// Populates a list of move indexes that can be learned based on the inputs.
|
|
/// </summary>
|
|
/// <param name="pk">Entity to check</param>
|
|
/// <param name="enc">Encounter it has been matched to</param>
|
|
/// <param name="history">Environment specific evolution history</param>
|
|
/// <param name="result">Flag array, when true, indicating if a move ID can be currently known.</param>
|
|
/// <param name="types">Move types to give</param>
|
|
public static void Get(PKM pk, IEncounterTemplate enc, EvolutionHistory history, Span<bool> result, MoveSourceType types = MoveSourceType.All)
|
|
{
|
|
if (types.HasFlagFast(MoveSourceType.Encounter))
|
|
FlagEncounterMoves(pk, enc, result);
|
|
IterateAndFlag(result, pk, enc, history, types);
|
|
}
|
|
|
|
/// <inheritdoc cref="Get(PKM,IEncounterTemplate,EvolutionHistory,Span{bool},MoveSourceType)"/>
|
|
public static bool[] Get(PKM pk, IEncounterTemplate enc, EvolutionHistory history, MoveSourceType types = MoveSourceType.All)
|
|
{
|
|
var result = new bool[pk.MaxMoveID + 1];
|
|
Get(pk, enc, history, result, types);
|
|
return result;
|
|
}
|
|
|
|
private static void FlagEncounterMoves(PKM pk, IEncounterTemplate enc, Span<bool> result)
|
|
{
|
|
if (pk.IsOriginalMovesetDeleted())
|
|
return;
|
|
if (enc is EncounterSlot8GO g)
|
|
{
|
|
SetAll(g.GetInitialMoves(pk.Met_Level), result);
|
|
}
|
|
else if (enc.Generation >= 6)
|
|
{
|
|
result[pk.RelearnMove1] = true;
|
|
result[pk.RelearnMove2] = true;
|
|
result[pk.RelearnMove3] = true;
|
|
result[pk.RelearnMove4] = true;
|
|
}
|
|
}
|
|
|
|
private static void SetAll(ReadOnlySpan<int> moves, Span<bool> result)
|
|
{
|
|
foreach (var move in moves)
|
|
result[move] = true;
|
|
}
|
|
|
|
private static void IterateAndFlag(Span<bool> result, PKM pk, IEncounterTemplate enc, EvolutionHistory history, MoveSourceType types)
|
|
{
|
|
// Similar to the iteration when validating a set of currently known moves, iterate backwards.
|
|
// Instead of checking if a single move can be learned, get an enumerable of moves and flag.
|
|
// Keep iterating backwards, as an older game may have an exclusive move.
|
|
var game = LearnGroupUtil.GetCurrentGroup(pk);
|
|
while (true)
|
|
{
|
|
game.GetAllMoves(result, pk, history, enc, types);
|
|
var next = game.GetPrevious(pk, history, enc, LearnOption.Current);
|
|
if (next is null)
|
|
return;
|
|
|
|
game = next;
|
|
}
|
|
}
|
|
}
|