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;
|
|
|
|
|
using static PKHeX.Core.LearnSource3;
|
|
|
|
|
|
|
|
|
|
namespace PKHeX.Core;
|
|
|
|
|
|
|
|
|
|
/// <summary>
|
|
|
|
|
/// Exposes information about how moves are learned in <see cref="LG"/>.
|
|
|
|
|
/// </summary>
|
|
|
|
|
public sealed class LearnSource3LG : ILearnSource, IEggSource
|
|
|
|
|
{
|
|
|
|
|
public static readonly LearnSource3LG Instance = new();
|
|
|
|
|
private static readonly PersonalTable3 Personal = PersonalTable.LG;
|
|
|
|
|
private static readonly Learnset[] Learnsets = Legal.LevelUpLG;
|
|
|
|
|
private static readonly EggMoves6[] EggMoves = Legal.EggMovesRS; // same for all Gen3 games
|
|
|
|
|
private const int MaxSpecies = Legal.MaxSpeciesID_3;
|
|
|
|
|
private const LearnEnvironment Game = LG;
|
|
|
|
|
private const int Generation = 3;
|
|
|
|
|
private const int CountTM = 50;
|
|
|
|
|
|
2022-08-27 06:43:36 +00:00
|
|
|
public Learnset GetLearnset(ushort species, int form) => Learnsets[species];
|
|
|
|
|
internal PersonalInfo this[ushort species] => Personal[species];
|
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 06:43:36 +00:00
|
|
|
public bool TryGetPersonal(ushort species, int 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 06:43:36 +00:00
|
|
|
public bool GetIsEggMove(ushort species, int 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 06:43:36 +00:00
|
|
|
public ReadOnlySpan<ushort> GetEggMoves(ushort species, int 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))
|
|
|
|
|
{
|
|
|
|
|
if (GetIsTM(pi, move))
|
|
|
|
|
return new(TMHM, Game);
|
|
|
|
|
if (pk.Format == Generation && GetIsHM(pi, move))
|
|
|
|
|
return new(TMHM, Game);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (types.HasFlagFast(MoveSourceType.SpecialTutor) && GetIsTutor(evo.Species, move))
|
|
|
|
|
return new(Tutor, Game);
|
|
|
|
|
|
|
|
|
|
return default;
|
|
|
|
|
}
|
|
|
|
|
|
2022-08-27 06:43:36 +00:00
|
|
|
private static bool GetIsTutor(ushort species, ushort move) => move 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)Move.BlastBurn => species == (int)Species.Charizard,
|
|
|
|
|
(int)Move.HydroCannon => species == (int)Species.Blastoise,
|
|
|
|
|
(int)Move.FrenzyPlant => species == (int)Species.Venusaur,
|
|
|
|
|
_ => false,
|
|
|
|
|
};
|
|
|
|
|
|
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(TM_3, move);
|
|
|
|
|
if (index == -1)
|
|
|
|
|
return false;
|
|
|
|
|
return info.TMHM[index];
|
|
|
|
|
}
|
|
|
|
|
|
2022-08-27 06:43:36 +00:00
|
|
|
private static bool GetIsHM(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(HM_3, move);
|
|
|
|
|
if (index == -1)
|
|
|
|
|
return false;
|
|
|
|
|
return info.TMHM[CountTM + 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 = TM_3;
|
|
|
|
|
for (int i = 0; i < moves.Length; i++)
|
|
|
|
|
{
|
|
|
|
|
if (flags[i])
|
|
|
|
|
result[moves[i]] = true;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (pk.Format == 3)
|
|
|
|
|
{
|
|
|
|
|
moves = HM_3;
|
|
|
|
|
for (int i = 0; i < moves.Length; i++)
|
|
|
|
|
{
|
|
|
|
|
if (flags[CountTM + i])
|
|
|
|
|
result[moves[i]] = true;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (types.HasFlagFast(MoveSourceType.SpecialTutor))
|
|
|
|
|
{
|
|
|
|
|
if (evo.Species == (int)Species.Charizard)
|
|
|
|
|
result[(int)Move.BlastBurn] = true;
|
|
|
|
|
else if (evo.Species == (int)Species.Blastoise)
|
|
|
|
|
result[(int)Move.HydroCannon] = true;
|
|
|
|
|
else if (evo.Species == (int)Species.Venusaur)
|
|
|
|
|
result[(int)Move.FrenzyPlant] = true;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|