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;
|
2021-04-02 23:47:37 +00:00
|
|
|
using static PKHeX.Core.GameVersion;
|
2018-03-30 08:02:22 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
namespace PKHeX.Core;
|
|
|
|
|
|
|
|
|
|
public static class GameData
|
2018-03-30 08:02:22 +00:00
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
public static Learnset[] GetLearnsets(GameVersion game) => Learnsets(game);
|
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 static IPersonalTable GetPersonal(GameVersion game) => Personal(game);
|
2022-06-18 18:04:24 +00:00
|
|
|
|
2022-08-27 19:53:30 +00:00
|
|
|
public static Learnset GetLearnset(GameVersion game, ushort species, byte form)
|
2018-03-30 08:02:22 +00:00
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
var pt = Personal(game);
|
|
|
|
|
var index = pt.GetFormIndex(species, form);
|
|
|
|
|
var sets = Learnsets(game);
|
|
|
|
|
return sets[index];
|
2018-03-30 08:02:22 +00:00
|
|
|
}
|
2022-06-18 18:04:24 +00:00
|
|
|
|
|
|
|
|
private static Learnset[] Learnsets(GameVersion game) => game switch
|
|
|
|
|
{
|
|
|
|
|
RD or GN or BU or RB => Legal.LevelUpRB,
|
|
|
|
|
YW or RBY => Legal.LevelUpY,
|
|
|
|
|
GD or SI or GS => Legal.LevelUpGS,
|
|
|
|
|
C or GSC => Legal.LevelUpC,
|
|
|
|
|
|
|
|
|
|
R or S or RS or RSE => Legal.LevelUpRS,
|
|
|
|
|
E or COLO or XD or FRLG or CXD => Legal.LevelUpE,
|
|
|
|
|
FR => Legal.LevelUpFR,
|
|
|
|
|
LG => Legal.LevelUpLG,
|
|
|
|
|
|
|
|
|
|
D or P or DP => Legal.LevelUpDP,
|
|
|
|
|
Pt or DPPt => Legal.LevelUpPt,
|
|
|
|
|
HG or SS or HGSS => Legal.LevelUpHGSS,
|
|
|
|
|
|
|
|
|
|
B or W or BW => Legal.LevelUpBW,
|
|
|
|
|
B2 or W2 or B2W2 => Legal.LevelUpB2W2,
|
|
|
|
|
|
|
|
|
|
X or Y or XY => Legal.LevelUpXY,
|
|
|
|
|
AS or OR or ORAS => Legal.LevelUpAO,
|
|
|
|
|
|
|
|
|
|
SN or MN or SM => Legal.LevelUpSM,
|
|
|
|
|
US or UM or USUM => Legal.LevelUpUSUM,
|
|
|
|
|
GO or GP or GE or GG => Legal.LevelUpGG,
|
|
|
|
|
|
|
|
|
|
SW or SH or SWSH => Legal.LevelUpSWSH,
|
|
|
|
|
BD or SP or BDSP => Legal.LevelUpBDSP,
|
|
|
|
|
PLA => Legal.LevelUpLA,
|
|
|
|
|
|
2022-11-25 01:42:17 +00:00
|
|
|
SL or VL => Legal.LevelUpSV,
|
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
Gen1 => Legal.LevelUpY,
|
|
|
|
|
Gen2 => Legal.LevelUpC,
|
|
|
|
|
Gen3 => Legal.LevelUpE,
|
|
|
|
|
Gen4 => Legal.LevelUpHGSS,
|
|
|
|
|
Gen5 => Legal.LevelUpB2W2,
|
|
|
|
|
Gen6 => Legal.LevelUpAO,
|
|
|
|
|
Gen7 => Legal.LevelUpSM,
|
|
|
|
|
Gen7b => Legal.LevelUpGG,
|
|
|
|
|
Gen8 => Legal.LevelUpSWSH,
|
2022-11-25 01:42:17 +00:00
|
|
|
Gen9 => Legal.LevelUpSV,
|
2022-06-18 18:04:24 +00:00
|
|
|
|
|
|
|
|
Stadium => Legal.LevelUpY,
|
|
|
|
|
Stadium2 => Legal.LevelUpGS,
|
|
|
|
|
|
|
|
|
|
_ => throw new ArgumentOutOfRangeException(nameof(game), $"{game} is not a valid entry in the expression."),
|
|
|
|
|
};
|
|
|
|
|
|
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
|
|
|
private static IPersonalTable Personal(GameVersion game) => game switch
|
2022-06-18 18:04:24 +00:00
|
|
|
{
|
|
|
|
|
RD or GN or BU or RB => PersonalTable.RB,
|
|
|
|
|
YW or RBY => PersonalTable.Y,
|
|
|
|
|
GD or SI or GS => PersonalTable.GS,
|
|
|
|
|
C or GSC => PersonalTable.C,
|
|
|
|
|
|
|
|
|
|
R or S or RS or RSE => PersonalTable.RS,
|
|
|
|
|
E or COLO or XD or FRLG or CXD => PersonalTable.E,
|
|
|
|
|
FR => PersonalTable.FR,
|
|
|
|
|
LG => PersonalTable.LG,
|
|
|
|
|
|
|
|
|
|
D or P or DP => PersonalTable.DP,
|
|
|
|
|
Pt or DPPt => PersonalTable.Pt,
|
|
|
|
|
HG or SS or HGSS => PersonalTable.HGSS,
|
|
|
|
|
|
|
|
|
|
B or W or BW => PersonalTable.BW,
|
|
|
|
|
B2 or W2 or B2W2 => PersonalTable.B2W2,
|
|
|
|
|
|
|
|
|
|
X or Y or XY => PersonalTable.XY,
|
|
|
|
|
AS or OR or ORAS => PersonalTable.AO,
|
|
|
|
|
|
|
|
|
|
SN or MN or SM => PersonalTable.SM,
|
|
|
|
|
US or UM or USUM => PersonalTable.USUM,
|
|
|
|
|
GO or GP or GE or GG => PersonalTable.GG,
|
|
|
|
|
|
|
|
|
|
SW or SH or SWSH => PersonalTable.SWSH,
|
|
|
|
|
BD or SP or BDSP => PersonalTable.BDSP,
|
|
|
|
|
PLA => PersonalTable.LA,
|
|
|
|
|
|
2022-11-25 01:42:17 +00:00
|
|
|
SL or VL or SV => PersonalTable.SV,
|
|
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
Gen1 => PersonalTable.Y,
|
|
|
|
|
Gen2 => PersonalTable.C,
|
|
|
|
|
Gen3 => PersonalTable.E,
|
|
|
|
|
Gen4 => PersonalTable.HGSS,
|
|
|
|
|
Gen5 => PersonalTable.B2W2,
|
|
|
|
|
Gen6 => PersonalTable.AO,
|
|
|
|
|
Gen7 => PersonalTable.USUM,
|
|
|
|
|
Gen7b => PersonalTable.GG,
|
|
|
|
|
Gen8 => PersonalTable.SWSH,
|
|
|
|
|
|
|
|
|
|
Stadium => PersonalTable.Y,
|
|
|
|
|
Stadium2 => PersonalTable.GS,
|
|
|
|
|
|
|
|
|
|
_ => throw new ArgumentOutOfRangeException(nameof(game), $"{game} is not a valid entry in the expression."),
|
|
|
|
|
};
|
2018-03-30 08:02:22 +00:00
|
|
|
}
|
