PKHeX/PKHeX.Core/Legality/Structures/GBEncounterData.cs
Kurt 69cf1eaa9c add more pkhex.core xml documentation
adds a bunch of documentation useful for those unfamiliar with the core
library
2017-10-23 23:12:58 -07:00

75 lines
2.7 KiB
C#

using System.Linq;
namespace PKHeX.Core
{
/// <summary>
/// Generation 1/2 Encounter Data type, which serves as a 'best match' priority rating when returning from a list.
/// </summary>
internal enum GBEncounterType
{
EggEncounter,
WildEncounter,
StaticEncounter,
SpecialEncounter,
TradeEncounterG1,
TradeEncounterG2,
}
/// <summary>
/// Generation 1/2 Encounter Data wrapper for storing supplemental information about the encounter.
/// </summary>
public class GBEncounterData : IEncounterable
{
private readonly int Level;
public readonly GameVersion Game;
public readonly int Generation;
internal readonly GBEncounterType Type;
public readonly IEncounterable Encounter;
public int Species => Encounter.Species;
public string Name => Encounter.Name;
public bool EggEncounter => Encounter.EggEncounter;
public int LevelMin => Encounter.LevelMin;
public int LevelMax => Encounter.LevelMax;
// Egg encounter
public GBEncounterData(int species, GameVersion game)
{
Generation = 2;
Game = game;
Encounter = new EncounterEgg { Species = species, Game = game, Level = Level };
Type = GBEncounterType.EggEncounter;
}
public GBEncounterData(PKM pkm, int gen, IEncounterable enc, GameVersion game)
{
Game = game;
Generation = gen;
Encounter = enc;
switch (Encounter)
{
case EncounterTrade t:
if (pkm.HasOriginalMetLocation && t.Level < pkm.Met_Level)
Level = pkm.Met_Level; // Crystal
else
Level = t.Level;
Type = Generation == 2
? GBEncounterType.TradeEncounterG2
: GBEncounterType.TradeEncounterG1;
break;
case EncounterStatic s:
Level = s.Level;
Type = s.Moves != null && s.Moves[0] != 0 && pkm.Moves.Contains(s.Moves[0])
? GBEncounterType.SpecialEncounter
: GBEncounterType.StaticEncounter;
break;
case EncounterSlot w:
Level = pkm.HasOriginalMetLocation && w.LevelMin >= pkm.Met_Level && pkm.Met_Level <= w.LevelMax
? pkm.Met_Level // Crystal
: w.LevelMin;
Type = GBEncounterType.WildEncounter;
break;
}
}
}
}