PKHeX/PKHeX.Core/Legality/LearnSource/Sources/Shared/ILearnSource.cs
Kurt 88830e0d00
Update from .NET Framework 4.6 to .NET 7 (#3729)
Updates from net46->net7, dropping support for mono in favor of using the latest runtime (along with the performance/API improvements). Releases will be posted as 64bit only for now.

Refactors a good amount of internal API methods to be more performant and more customizable for future updates & fixes.

Adds functionality for Batch Editor commands to `>`, `<` and <=/>=

TID/SID properties renamed to TID16/SID16 for clarity; other properties exposed for Gen7 / display variants.

Main window has a new layout to account for DPI scaling (8 point grid)

Fixed: Tatsugiri and Paldean Tauros now output Showdown form names as Showdown expects
Changed: Gen9 species now interact based on the confirmed National Dex IDs (closes #3724)
Fixed: Pokedex set all no longer clears species with unavailable non-base forms (closes #3720)
Changed: Hyper Training suggestions now apply for level 50 in SV. (closes #3714)
Fixed: B2/W2 hatched egg met locations exclusive to specific versions are now explicitly checked (closes #3691)
Added: Properties for ribbon/mark count (closes #3659)
Fixed: Traded SV eggs are now checked correctly (closes #3692)
2023-01-21 20:02:33 -08:00

54 lines
2.5 KiB
C#

using System;
using System.Diagnostics.CodeAnalysis;
namespace PKHeX.Core;
/// <summary>
/// Exposes information about how moves are learned in game.
/// </summary>
public interface ILearnSource
{
/// <summary>
/// Yields an iterable list of all potential moves that an <see cref="evo"/> can learn from this <see cref="ILearnSource"/>.
/// </summary>
/// <param name="result">Result storage for flags</param>
/// <param name="pk">Entity reference</param>
/// <param name="evo">Details about the state of the entity</param>
/// <param name="types">Types of move sources to iterate</param>
public void GetAllMoves(Span<bool> result, PKM pk, EvoCriteria evo, MoveSourceType types = MoveSourceType.All);
/// <summary>
/// Gets the learnset for the given <see cref="species"/> and <see cref="form"/>.
/// </summary>
/// <param name="species">Entity species</param>
/// <param name="form">Entity form</param>
public Learnset GetLearnset(ushort species, byte form);
}
/// <summary>
/// Exposes information about how moves are learned in game based on the game's <see cref="PersonalInfo"/>.
/// </summary>
public interface ILearnSource<T> : ILearnSource where T : PersonalInfo
{
/// <summary>
/// Checks if the <see cref="pk"/> can learn the requested <see cref="move"/> while existing as <see cref="evo"/>.
/// </summary>
/// <param name="pk">Entity reference</param>
/// <param name="pi">Entity game stats</param>
/// <param name="evo">Details about the state of the entity</param>
/// <param name="move">Move ID to check</param>
/// <param name="types">Types of move sources to iterate</param>
/// <param name="option">Option to check if it can be currently known, or previously known.</param>
/// <returns>Details about how the move can be learned. Will be equivalent to default if cannot learn.</returns>
public MoveLearnInfo GetCanLearn(PKM pk, T pi, EvoCriteria evo, ushort move, MoveSourceType types = MoveSourceType.All, LearnOption option = LearnOption.Current);
/// <summary>
/// Gets the <see cref="T"/> for the given <see cref="species"/> and <see cref="form"/>.
/// </summary>
/// <param name="species">Entity species</param>
/// <param name="form">Entity form</param>
/// <param name="pi">Result value</param>
/// <returns>True if the <see cref="T"/> reference is a valid entity reference.</returns>
public bool TryGetPersonal(ushort species, byte form, [NotNullWhen(true)] out T? pi);
}