PKHeX/PKHeX.Core/Legality/Encounters/IEncounterConvertible.cs
Kurt fc754b346b
File scoped namespaces (#3529)
[Language Reference](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/proposals/csharp-10.0/file-scoped-namespaces)

Updates all the files, one less level of indentation.

Some small changes were made to API surfaces, renaming `PKM pkm` -> `PKM pk`, and `LegalityAnalysis.pkm` -> `LegalityAnalysis.Entity`
2022-06-18 11:04:24 -07:00

19 lines
889 B
C#

namespace PKHeX.Core;
/// <summary>
/// Exposes conversion methods to create a <see cref="PKM"/> from the object's data.
/// </summary>
public interface IEncounterConvertible
{
/// <summary>
/// Creates a <see cref="PKM"/> from the template, using the input <see cref="tr"/> as the trainer data.
/// </summary>
/// <remarks>This method calls <see cref="ConvertToPKM(ITrainerInfo, EncounterCriteria)"/> with a fixed criteria containing no restrictions on the generated data.</remarks>
PKM ConvertToPKM(ITrainerInfo tr);
/// <summary>
/// Creates a <see cref="PKM"/> from the template, using the input <see cref="tr"/> as the trainer data.
/// <br>The generation routine will try to yield a result that matches the specifications in the <see cref="criteria"/>.</br>
/// </summary>
PKM ConvertToPKM(ITrainerInfo tr, EncounterCriteria criteria);
}