2017-05-28 04:17:53 +00:00
using System.Collections.Generic ;
namespace PKHeX.Core
{
2017-10-24 06:12:58 +00:00
/// <summary>
/// Calculated Information storage with properties useful for parsing the legality of the input <see cref="PKM"/>.
/// </summary>
2018-12-30 06:24:34 +00:00
public sealed class LegalInfo
2017-05-28 04:17:53 +00:00
{
/// <summary>The <see cref="PKM"/> object used for comparisons.</summary>
private readonly PKM pkm ;
2017-09-04 02:51:29 +00:00
/// <summary>The generation of games the <see cref="PKM"/> originated from.</summary>
2019-02-22 04:41:04 +00:00
public int Generation { get ; internal set ; }
2017-05-28 04:17:53 +00:00
2017-09-04 02:51:29 +00:00
/// <summary>The Game the <see cref="PKM"/> originated from.</summary>
2019-02-22 04:41:04 +00:00
public GameVersion Game { get ; internal set ; }
2017-05-28 23:56:51 +00:00
2017-05-28 04:17:53 +00:00
/// <summary>The matched Encounter details for the <see cref="PKM"/>. </summary>
public IEncounterable EncounterMatch
{
get = > _match ;
set
{
2018-06-20 00:14:22 +00:00
if ( _match ! = null & & ( value . LevelMin ! = _match . LevelMin | | value . Species ! = _match . Species ) )
_evochains = null ; // clear if evo chain has the potential to be different
2017-05-28 04:17:53 +00:00
_match = value ;
Parse . Clear ( ) ;
}
}
2018-08-03 03:11:42 +00:00
2017-09-04 02:51:29 +00:00
private IEncounterable _match ;
2017-05-28 04:17:53 +00:00
2017-09-04 02:51:29 +00:00
/// <summary>Indicates whether or not the <see cref="PKM"/> originated from <see cref="GameVersion.XD"/>.</summary>
2018-04-29 15:31:57 +00:00
public bool WasXD = > pkm ? . Version = = 15 & & EncounterMatch is IVersion v & & v . Version = = GameVersion . XD ;
2017-09-04 02:51:29 +00:00
/// <summary>Base Relearn Moves for the <see cref="EncounterMatch"/>.</summary>
2019-09-10 07:21:51 +00:00
public IReadOnlyList < int > RelearnBase { get ; internal set ; }
2017-05-28 04:17:53 +00:00
2017-09-04 02:51:29 +00:00
/// <summary>Top level Legality Check result list for the <see cref="EncounterMatch"/>.</summary>
2017-05-28 04:17:53 +00:00
public readonly List < CheckResult > Parse = new List < CheckResult > ( ) ;
2019-02-22 04:41:04 +00:00
public CheckResult [ ] Relearn { get ; internal set ; } = new CheckResult [ 4 ] ;
public CheckMoveResult [ ] Moves { get ; internal set ; } = new CheckMoveResult [ 4 ] ;
2017-05-28 04:17:53 +00:00
2019-02-22 04:41:04 +00:00
public ValidEncounterMoves EncounterMoves { get ; internal set ; }
2018-06-23 00:59:02 +00:00
public IReadOnlyList < EvoCriteria > [ ] EvoChainsAllGens = > _evochains ? ? ( _evochains = EvolutionChain . GetEvolutionChainsAllGens ( pkm , EncounterMatch ) ) ;
private IReadOnlyList < EvoCriteria > [ ] _evochains ;
2017-09-04 02:51:29 +00:00
/// <summary><see cref="RNG"/> related information that generated the <see cref="PKM.PID"/>/<see cref="PKM.IVs"/> value(s).</summary>
2019-02-22 04:41:04 +00:00
public PIDIV PIDIV { get ; internal set ; }
2017-07-29 18:54:52 +00:00
2017-09-04 02:51:29 +00:00
/// <summary>Indicates whether or not the <see cref="PIDIV"/> can originate from the <see cref="EncounterMatch"/>.</summary>
2017-11-29 05:30:53 +00:00
/// <remarks>This boolean is true until all valid <see cref="PIDIV"/> encounters are tested, after which it is false.</remarks>
2019-02-22 04:41:04 +00:00
public bool PIDIVMatches { get ; internal set ; } = true ;
2017-05-28 04:17:53 +00:00
2017-11-29 05:30:53 +00:00
/// <summary>Indicates whether or not the <see cref="PIDIV"/> can originate from the <see cref="EncounterMatch"/> with explicit <see cref="RNG"/> <see cref="Frame"/> matching.</summary>
/// <remarks>This boolean is true until all valid <see cref="Frame"/> entries are tested for all possible <see cref="EncounterSlot"/> matches, after which it is false.</remarks>
2019-02-22 04:41:04 +00:00
public bool FrameMatches { get ; internal set ; } = true ;
2017-11-29 05:30:53 +00:00
2017-09-23 23:24:22 +00:00
public readonly bool Korean ;
2017-05-28 23:56:51 +00:00
public LegalInfo ( PKM pk )
{
pkm = pk ;
2017-09-23 23:24:22 +00:00
Korean = pk . Korean ;
2017-09-04 02:51:29 +00:00
// Store repeatedly accessed values
Game = ( GameVersion ) pkm . Version ;
2017-05-28 23:56:51 +00:00
Generation = pkm . GenNumber ;
}
2017-07-12 16:02:03 +00:00
2017-09-04 02:51:29 +00:00
/// <summary>List of all near-matches that were rejected for a given reason.</summary>
public List < EncounterRejected > InvalidMatches ;
2018-08-03 03:11:42 +00:00
2017-07-12 16:02:03 +00:00
internal void Reject ( CheckResult c )
{
2018-05-12 19:28:48 +00:00
( InvalidMatches ? ? ( InvalidMatches = new List < EncounterRejected > ( ) ) ) . Add ( new EncounterRejected ( EncounterMatch , c ) ) ;
2017-07-12 16:02:03 +00:00
}
2017-05-28 04:17:53 +00:00
}
}