mirror of
https://github.com/kwsch/PKHeX
synced 2024-11-28 06:50:23 +00:00
69cf1eaa9c
adds a bunch of documentation useful for those unfamiliar with the core library
33 lines
1.1 KiB
C#
33 lines
1.1 KiB
C#
namespace PKHeX.Core
|
|
{
|
|
/// <summary>
|
|
/// Common Encounter Properties base interface.
|
|
/// </summary>
|
|
public interface IEncounterable
|
|
{
|
|
int Species { get; }
|
|
string Name { get; }
|
|
bool EggEncounter { get; }
|
|
int LevelMin { get; }
|
|
int LevelMax { get; }
|
|
}
|
|
|
|
public static partial class Extensions
|
|
{
|
|
private static bool IsWithinRange(this IEncounterable encounter, int lvl)
|
|
{
|
|
return encounter.LevelMin <= lvl && lvl <= encounter.LevelMax;
|
|
}
|
|
public static bool IsWithinRange(this IEncounterable encounter, PKM pkm)
|
|
{
|
|
if (!pkm.HasOriginalMetLocation)
|
|
return encounter.IsWithinRange(pkm.CurrentLevel);
|
|
if (encounter.EggEncounter)
|
|
return pkm.CurrentLevel == Legal.GetEggHatchLevel(pkm);
|
|
if (encounter is MysteryGift g)
|
|
return pkm.CurrentLevel == g.Level;
|
|
return pkm.CurrentLevel == pkm.Met_Level;
|
|
}
|
|
internal static string GetEncounterTypeName(this IEncounterable Encounter) => Encounter?.Name ?? "Unknown";
|
|
}
|
|
}
|