PKHeX/PKHeX.Core/Legality/Encounters/IEncounterMatch.cs
Kurt 3c232505e5
Refactoring: Narrow some value types (Species, Move, Form) (#3575)
In this pull request I've changed a ton of method signatures to reflect the more-narrow types of Species, Move# and Form; additionally, I've narrowed other large collections that stored lists of species / permitted values, and reworked them to be more performant with the latest API spaghetti that PKHeX provides. Roamer met locations, usually in a range of [max-min]<64, can be quickly checked using a bitflag operation on a UInt64. Other collections (like "Is this from Colosseum or XD") were eliminated -- shadow state is not transferred COLO<->XD, so having a Shadow ID or matching the met location from a gift/wild encounter is a sufficient check for "originated in XD".
2022-08-26 23:43:36 -07:00

52 lines
1.9 KiB
C#

using static PKHeX.Core.Species;
namespace PKHeX.Core;
/// <summary>
/// Exposes details about the quality of a potential match compared to an input <see cref="PKM"/>.
/// </summary>
public interface IEncounterMatch
{
/// <summary>
/// Checks if the implementing object's details might have been the originator of the current <see cref="pk"/> data.
/// </summary>
bool IsMatchExact(PKM pk, EvoCriteria evo);
/// <summary>
/// Checks if the potential match may not be a perfect match (might be a better match later during iteration).
/// </summary>
EncounterMatchRating GetMatchRating(PKM pk);
}
internal static class EncounterMatchExtensions
{
/// <summary>
/// Some species do not have a Hidden Ability, but can be altered to have the HA slot via pre-evolution.
/// </summary>
/// <param name="_">Match object</param>
/// <param name="species">Species ID</param>
/// <returns>True if it should not originate as this species.</returns>
private static bool IsPartialMatchHidden(this IEncounterMatch _, ushort species)
{
return species is (int)Metapod or (int)Kakuna
or (int)Pupitar
or (int)Silcoon or (int)Cascoon
or (int)Vibrava or (int)Flygon;
}
/// <summary>
/// Some species do not have a Hidden Ability, but can be altered to have the HA slot via pre-evolution.
/// </summary>
/// <param name="_">Match object</param>
/// <param name="current">Current Species ID</param>
/// <param name="original">Original Species ID</param>
/// <returns>True if it should not originate as this species.</returns>
public static bool IsPartialMatchHidden(this IEncounterMatch _, ushort current, ushort original)
{
if (current == original)
return false;
if (!_.IsPartialMatchHidden(original))
return false;
return _.IsPartialMatchHidden(current);
}
}