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
|
|
|
namespace PKHeX.Core;
|
2019-12-06 07:04:24 +00:00
|
|
|
|
2022-08-21 08:39:16 +00:00
|
|
|
/// <summary>
|
|
|
|
/// Evolution Info tracking how an evolution was performed, and the end result species and form.
|
|
|
|
/// </summary>
|
2022-08-27 06:43:36 +00:00
|
|
|
public readonly record struct EvoCriteria : ISpeciesForm
|
2021-12-26 08:57:40 +00:00
|
|
|
{
|
2022-04-24 04:33:17 +00:00
|
|
|
public ushort Species { get; init; }
|
|
|
|
public byte Form { get; init; }
|
2022-08-21 08:39:16 +00:00
|
|
|
|
2022-04-24 04:33:17 +00:00
|
|
|
public byte LevelUpRequired { get; init; }
|
|
|
|
public byte LevelMax { get; init; }
|
|
|
|
public byte LevelMin { get; init; }
|
2019-01-07 00:22:45 +00:00
|
|
|
|
2022-04-24 04:33:17 +00:00
|
|
|
public EvolutionType Method { get; init; }
|
2020-07-19 18:32:40 +00:00
|
|
|
|
2022-04-24 04:33:17 +00:00
|
|
|
public bool RequiresLvlUp => LevelUpRequired != 0;
|
|
|
|
|
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 bool InsideLevelRange(int level) => LevelMin <= level && level <= LevelMax;
|
|
|
|
|
2022-04-24 04:33:17 +00:00
|
|
|
public override string ToString() => $"{(Species) Species}{(Form != 0 ? $"-{Form}" : "")}}} [{LevelMin},{LevelMax}] via {Method}";
|
2018-06-19 02:10:21 +00:00
|
|
|
}
|