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 static PKHeX.Core.LegalityCheckStrings;
|
2017-06-18 01:37:19 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
namespace PKHeX.Core;
|
|
|
|
|
|
|
|
/// <summary> Severity indication of the associated <see cref="CheckResult"/> </summary>
|
|
|
|
/// <remarks>
|
|
|
|
/// Severity >= <see cref="Valid"/> is green
|
|
|
|
/// Severity == <see cref="Fishy"/> is yellow
|
|
|
|
/// Severity <= <see cref="Invalid"/> is red
|
|
|
|
/// </remarks>
|
|
|
|
public enum Severity : sbyte
|
2017-05-28 04:17:53 +00:00
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
/// <summary>
|
|
|
|
/// Definitively not valid.
|
|
|
|
/// </summary>
|
|
|
|
Invalid = -1,
|
2018-07-21 03:22:46 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
/// <summary>
|
|
|
|
/// Suspicious values, but still valid.
|
|
|
|
/// </summary>
|
|
|
|
Fishy = 0,
|
2018-07-21 03:22:46 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
/// <summary>
|
|
|
|
/// Values are valid.
|
|
|
|
/// </summary>
|
|
|
|
Valid = 1,
|
|
|
|
}
|
2017-06-18 01:37:19 +00:00
|
|
|
|
2022-06-18 18:04:24 +00:00
|
|
|
public static partial class Extensions
|
|
|
|
{
|
|
|
|
/// <summary>
|
|
|
|
/// Converts a Check result Severity determination (Valid/Invalid/etc) to the localized string.
|
|
|
|
/// </summary>
|
|
|
|
/// <param name="s"><see cref="Severity"/> value to convert to string.</param>
|
|
|
|
/// <returns>Localized <see cref="string"/>.</returns>
|
|
|
|
public static string Description(this Severity s) => s switch
|
2017-06-18 01:37:19 +00:00
|
|
|
{
|
2022-06-18 18:04:24 +00:00
|
|
|
Severity.Invalid => L_SInvalid,
|
|
|
|
Severity.Fishy => L_SFishy,
|
|
|
|
Severity.Valid => L_SValid,
|
|
|
|
_ => L_SNotImplemented,
|
|
|
|
};
|
2017-05-28 04:17:53 +00:00
|
|
|
}
|