mirror of
https://github.com/kwsch/PKHeX
synced 2024-12-24 19:33:10 +00:00
9166d0eb64
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
73 lines
3 KiB
C#
73 lines
3 KiB
C#
namespace PKHeX.Core;
|
|
|
|
/// <summary>
|
|
/// Caches a reference to the most recently loaded trainer data.
|
|
/// </summary>
|
|
/// <remarks>Useful for sourcing trainer info for the <see cref="PKM"/> ConvertTo methods.</remarks>
|
|
public static class RecentTrainerCache
|
|
{
|
|
private static ITrainerInfo Trainer = new SimpleTrainerInfo();
|
|
private static IRegionOrigin Trainer67 = new SimpleTrainerInfo(GameVersion.SN);
|
|
|
|
private static IRegionOrigin GetTrainer3DS(ITrainerInfo tr) => tr as IRegionOrigin ?? Trainer67;
|
|
|
|
/// <summary> Most recently loaded <see cref="ITrainerInfo.OT"/>. </summary>
|
|
public static string OT_Name => Trainer.OT;
|
|
|
|
/// <summary> Most recently loaded <see cref="ITrainerInfo.Gender"/>. </summary>
|
|
public static int OT_Gender => Trainer.Gender;
|
|
|
|
/// <summary> Most recently loaded <see cref="ITrainerInfo.Language"/>. </summary>
|
|
public static int Language => Trainer.Language;
|
|
|
|
/// <summary> Most recently loaded <see cref="ITrainerInfo.Generation"/>. </summary>
|
|
public static int Format => Trainer.Generation;
|
|
|
|
/// <summary> Most recently loaded <see cref="ITrainerInfo.Game"/>. </summary>
|
|
public static int Game => Trainer.Game;
|
|
|
|
/// <summary> Most recently loaded <see cref="ITrainerInfo.Context"/>. </summary>
|
|
public static EntityContext Context => Trainer.Context;
|
|
|
|
/// <summary>
|
|
/// Updates the cache with the most recently loaded trainer reference.
|
|
/// </summary>
|
|
/// <param name="trainer"></param>
|
|
public static void SetRecentTrainer(ITrainerInfo trainer)
|
|
{
|
|
Trainer = trainer;
|
|
if (trainer is IRegionOrigin g67)
|
|
Trainer67 = g67;
|
|
}
|
|
|
|
/// <inheritdoc cref="SetConsoleRegionData3DS(IRegionOrigin, ITrainerInfo)"/>
|
|
public static void SetConsoleRegionData3DS(IRegionOrigin pk) => SetConsoleRegionData3DS(pk, Trainer);
|
|
|
|
/// <inheritdoc cref="SetFirstCountryRegion(IGeoTrack, ITrainerInfo)"/>
|
|
public static void SetFirstCountryRegion(IGeoTrack pk) => SetFirstCountryRegion(pk, Trainer);
|
|
|
|
/// <summary>
|
|
/// Fetches an <see cref="IRegionOrigin"/> trainer to apply details to the input <see cref="pk"/>.
|
|
/// </summary>
|
|
/// <param name="pk">Entity to apply details to.</param>
|
|
/// <param name="trainer">Trainer that is receiving the entity.</param>
|
|
public static void SetConsoleRegionData3DS(IRegionOrigin pk, ITrainerInfo trainer)
|
|
{
|
|
var tr = GetTrainer3DS(trainer);
|
|
pk.ConsoleRegion = tr.ConsoleRegion;
|
|
pk.Country = tr.Country;
|
|
pk.Region = tr.Region;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Fetches an <see cref="IRegionOrigin"/> trainer to apply details to the input <see cref="pk"/>.
|
|
/// </summary>
|
|
/// <param name="pk">Entity to apply details to.</param>
|
|
/// <param name="trainer">Trainer that is receiving the entity.</param>
|
|
public static void SetFirstCountryRegion(IGeoTrack pk, ITrainerInfo trainer)
|
|
{
|
|
var tr = GetTrainer3DS(trainer);
|
|
pk.Geo1_Country = tr.Country;
|
|
pk.Geo1_Region = tr.Region;
|
|
}
|
|
}
|