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;
|
|
|
|
|
using System.Diagnostics.CodeAnalysis;
|
|
|
|
|
using static PKHeX.Core.LearnMethod;
|
|
|
|
|
using static PKHeX.Core.LearnEnvironment;
|
|
|
|
|
|
|
|
|
|
namespace PKHeX.Core;
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Exposes information about how moves are learned in <see cref="XY"/>.
|
|
|
|
|
/// </summary>
|
|
|
|
|
public sealed class LearnSource6XY : ILearnSource, IEggSource
|
|
|
|
|
{
|
|
|
|
|
public static readonly LearnSource6XY Instance = new();
|
|
|
|
|
private static readonly PersonalTable6XY Personal = PersonalTable.XY;
|
|
|
|
|
private static readonly Learnset[] Learnsets = Legal.LevelUpXY;
|
|
|
|
|
private static readonly EggMoves6[] EggMoves = Legal.EggMovesXY;
|
|
|
|
|
private const int MaxSpecies = Legal.MaxSpeciesID_6;
|
|
|
|
|
private const LearnEnvironment Game = XY;
|
|
|
|
|
|
2022-08-27 19:53:30 +00:00
|
|
|
public Learnset GetLearnset(ushort species, byte form) => Learnsets[Personal.GetFormIndex(species, form)];
|
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
|
|
|
|
2022-08-27 19:53:30 +00:00
|
|
|
public bool TryGetPersonal(ushort species, byte form, [NotNullWhen(true)] out PersonalInfo? pi)
|
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
|
|
|
{
|
|
|
|
|
pi = null;
|
|
|
|
|
if ((uint)species > MaxSpecies)
|
|
|
|
|
return false;
|
|
|
|
|
pi = Personal[species];
|
|
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
|
2022-08-27 19:53:30 +00:00
|
|
|
public bool GetIsEggMove(ushort species, byte form, ushort move)
|
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
|
|
|
{
|
|
|
|
|
if ((uint)species > MaxSpecies)
|
|
|
|
|
return false;
|
|
|
|
|
var moves = EggMoves[species];
|
|
|
|
|
return moves.GetHasEggMove(move);
|
|
|
|
|
}
|
|
|
|
|
|
2022-08-27 19:53:30 +00:00
|
|
|
public ReadOnlySpan<ushort> GetEggMoves(ushort species, byte form)
|
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
|
|
|
{
|
|
|
|
|
if ((uint)species > MaxSpecies)
|
2022-08-27 06:43:36 +00:00
|
|
|
return ReadOnlySpan<ushort>.Empty;
|
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
|
|
|
return EggMoves[species].Moves;
|
|
|
|
|
}
|
|
|
|
|
|
2022-08-27 06:43:36 +00:00
|
|
|
public MoveLearnInfo GetCanLearn(PKM pk, PersonalInfo pi, EvoCriteria evo, ushort move, MoveSourceType types = MoveSourceType.All, LearnOption option = LearnOption.Current)
|
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
|
|
|
{
|
|
|
|
|
if (types.HasFlagFast(MoveSourceType.LevelUp))
|
|
|
|
|
{
|
|
|
|
|
var learn = GetLearnset(evo.Species, evo.Form);
|
|
|
|
|
var level = learn.GetLevelLearnMove(move);
|
|
|
|
|
if (level != -1 && level <= evo.LevelMax)
|
|
|
|
|
return new(LevelUp, Game, (byte)level);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (types.HasFlagFast(MoveSourceType.Machine) && GetIsTM(pi, move))
|
|
|
|
|
return new(TMHM, Game);
|
|
|
|
|
|
|
|
|
|
if (types.HasFlagFast(MoveSourceType.TypeTutor) && GetIsTypeTutor(pi, move))
|
|
|
|
|
return new(Tutor, Game);
|
|
|
|
|
|
|
|
|
|
if (types.HasFlagFast(MoveSourceType.EnhancedTutor) && GetIsEnhancedTutor(evo, pk, move, option))
|
|
|
|
|
return new(Tutor, Game);
|
|
|
|
|
|
|
|
|
|
return default;
|
|
|
|
|
}
|
|
|
|
|
|
2022-08-27 06:43:36 +00:00
|
|
|
private static bool GetIsEnhancedTutor(EvoCriteria evo, ISpeciesForm current, ushort move, LearnOption option) => evo.Species switch
|
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
|
|
|
{
|
|
|
|
|
(int)Species.Keldeo => move is (int)Move.SecretSword,
|
|
|
|
|
(int)Species.Meloetta => move is (int)Move.RelicSong,
|
|
|
|
|
(int)Species.Rotom => move switch
|
|
|
|
|
{
|
|
|
|
|
(int)Move.Overheat => option == LearnOption.AtAnyTime || current.Form == 1,
|
|
|
|
|
(int)Move.HydroPump => option == LearnOption.AtAnyTime || current.Form == 2,
|
|
|
|
|
(int)Move.Blizzard => option == LearnOption.AtAnyTime || current.Form == 3,
|
|
|
|
|
(int)Move.AirSlash => option == LearnOption.AtAnyTime || current.Form == 4,
|
|
|
|
|
(int)Move.LeafStorm => option == LearnOption.AtAnyTime || current.Form == 5,
|
|
|
|
|
_ => false,
|
|
|
|
|
},
|
|
|
|
|
_ => false,
|
|
|
|
|
};
|
|
|
|
|
|
2022-08-27 06:43:36 +00:00
|
|
|
private static bool GetIsTypeTutor(PersonalInfo pi, ushort move)
|
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
|
|
|
{
|
|
|
|
|
var index = Array.IndexOf(LearnSource5.TypeTutor567, move);
|
|
|
|
|
if (index == -1)
|
|
|
|
|
return false;
|
|
|
|
|
return pi.TypeTutors[index];
|
|
|
|
|
}
|
|
|
|
|
|
2022-08-27 06:43:36 +00:00
|
|
|
private static bool GetIsTM(PersonalInfo info, ushort move)
|
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
|
|
|
{
|
|
|
|
|
var index = Array.IndexOf(TMHM_XY, move);
|
|
|
|
|
if (index == -1)
|
|
|
|
|
return false;
|
|
|
|
|
return info.TMHM[index];
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public void GetAllMoves(Span<bool> result, PKM pk, EvoCriteria evo, MoveSourceType types = MoveSourceType.All)
|
|
|
|
|
{
|
|
|
|
|
if (!TryGetPersonal(evo.Species, evo.Form, out var pi))
|
|
|
|
|
return;
|
|
|
|
|
|
|
|
|
|
if (types.HasFlagFast(MoveSourceType.LevelUp))
|
|
|
|
|
{
|
|
|
|
|
var learn = GetLearnset(evo.Species, evo.Form);
|
|
|
|
|
(bool hasMoves, int start, int end) = learn.GetMoveRange(evo.LevelMax);
|
|
|
|
|
if (hasMoves)
|
|
|
|
|
{
|
|
|
|
|
var moves = learn.Moves;
|
|
|
|
|
for (int i = end; i >= start; i--)
|
|
|
|
|
result[moves[i]] = true;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (types.HasFlagFast(MoveSourceType.Machine))
|
|
|
|
|
{
|
|
|
|
|
var flags = pi.TMHM;
|
|
|
|
|
var moves = TMHM_XY;
|
|
|
|
|
for (int i = 0; i < moves.Length; i++)
|
|
|
|
|
{
|
|
|
|
|
if (flags[i])
|
|
|
|
|
result[moves[i]] = true;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (types.HasFlagFast(MoveSourceType.TypeTutor))
|
|
|
|
|
{
|
|
|
|
|
// Beams
|
|
|
|
|
var flags = pi.TypeTutors;
|
|
|
|
|
var moves = LearnSource5.TypeTutor567;
|
|
|
|
|
for (int i = 0; i < moves.Length; i++)
|
|
|
|
|
{
|
|
|
|
|
if (flags[i])
|
|
|
|
|
result[moves[i]] = true;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (types.HasFlagFast(MoveSourceType.EnhancedTutor))
|
|
|
|
|
{
|
|
|
|
|
var species = evo.Species;
|
|
|
|
|
if (species is (int)Species.Rotom && evo.Form is not 0)
|
|
|
|
|
result[MoveTutor.GetRotomFormMove(evo.Form)] = true;
|
|
|
|
|
else if (species is (int)Species.Keldeo)
|
|
|
|
|
result[(int)Move.SecretSword] = true;
|
|
|
|
|
else if (species is (int)Species.Meloetta)
|
|
|
|
|
result[(int)Move.RelicSong] = true;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2022-08-27 06:43:36 +00:00
|
|
|
private static readonly ushort[] TMHM_XY =
|
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
|
|
|
{
|
|
|
|
|
468, 337, 473, 347, 046, 092, 258, 339, 474, 237,
|
|
|
|
|
241, 269, 058, 059, 063, 113, 182, 240, 355, 219,
|
|
|
|
|
218, 076, 479, 085, 087, 089, 216, 091, 094, 247,
|
|
|
|
|
280, 104, 115, 482, 053, 188, 201, 126, 317, 332,
|
|
|
|
|
259, 263, 488, 156, 213, 168, 490, 496, 497, 315,
|
|
|
|
|
211, 411, 412, 206, 503, 374, 451, 507, 510, 511,
|
|
|
|
|
261, 512, 373, 153, 421, 371, 514, 416, 397, 148,
|
|
|
|
|
444, 521, 086, 360, 014, 522, 244, 523, 524, 157,
|
|
|
|
|
404, 525, 611, 398, 138, 447, 207, 214, 369, 164,
|
|
|
|
|
430, 433, 528, 249, 555, 267, 399, 612, 605, 590,
|
|
|
|
|
|
|
|
|
|
15, 19, 57, 70, 127,
|
|
|
|
|
};
|
|
|
|
|
}
|
