using System; using static PKHeX.Core.EntityContext; namespace PKHeX.Core; /// <summary> /// "Context" is an existence island; data format restricts the types of changes that can be made (such as evolving). /// </summary> /// <remarks> /// Starting in the 8th generation games, entities can move between games with wildly different evolution rules. /// Previous implementations of a "Format Generation" were unable to differentiate if a class object was present in one of these different-rule contexts. /// The "Format Generation" is still a useful generalization to check if certain fields are present in the entity data, or if certain mutations are possible. /// </remarks> public enum EntityContext : byte { // Generation numerically so we can cast to and from int for most cases. None = 0, Gen1 = 1, Gen2 = 2, Gen3 = 3, Gen4 = 4, Gen5 = 5, Gen6 = 6, Gen7 = 7, Gen8 = 8, Gen9 = 9, /// <summary> /// Internal separator to pivot between adjacent contexts. /// </summary> SplitInvalid, /// <summary> Let's Go, Pikachu! & Let's Go, Eevee! </summary> Gen7b, /// <summary> Legends: Arceus </summary> Gen8a, /// <summary> Brilliant Diamond & Shining Pearl </summary> Gen8b, /// <summary> /// Internal separator to bounds check count. /// </summary> MaxInvalid, } public static class EntityContextExtensions { /// <summary> /// Get the generation number of the context. /// </summary> public static byte Generation(this EntityContext value) => value < SplitInvalid ? (byte)value : value switch { Gen7b => (byte)7, Gen8a => (byte)8, Gen8b => (byte)8, _ => throw new ArgumentOutOfRangeException(nameof(value), value, null), }; /// <summary> /// Checks if the context is a defined value assigned to a valid context. /// </summary> /// <returns>True if the context is valid.</returns> public static bool IsValid(this EntityContext value) => value is not (0 or SplitInvalid) and < MaxInvalid; /// <summary> /// Get a pre-defined single game version associated with the context. /// </summary> /// <remarks>Game ID choice here is the developer's choice; if multiple game sets exist for a context, one from the most recent was chosen.</remarks> public static GameVersion GetSingleGameVersion(this EntityContext value) => value switch { Gen1 => GameVersion.RD, Gen2 => GameVersion.C, Gen3 => GameVersion.E, Gen4 => GameVersion.SS, Gen5 => GameVersion.W2, Gen6 => GameVersion.AS, Gen7 => GameVersion.UM, Gen8 => GameVersion.SH, Gen9 => GameVersion.VL, Gen7b => GameVersion.GP, Gen8a => GameVersion.PLA, Gen8b => GameVersion.BD, _ => throw new ArgumentOutOfRangeException(nameof(value), value, null), }; /// <summary> /// Get the game console associated with the context. /// </summary> public static GameConsole GetConsole(this EntityContext value) => value switch { Gen1 or Gen2 => GameConsole.GB, Gen3 => GameConsole.GBA, Gen4 or Gen5 => GameConsole.NDS, Gen6 or Gen7 => GameConsole._3DS, Gen7b or Gen8 or Gen8a or Gen8b or Gen9 => GameConsole.NX, _ => throw new ArgumentOutOfRangeException(nameof(value), value, null), }; /// <summary> /// Gets all <see cref="GameVersion"/> values that fall within the context. /// </summary> public static GameVersion[] GetVersionsWithin(this EntityContext value, GameVersion[] source) => value.GetVersionLump().GetVersionsWithinRange(source); /// <summary> /// Gets the corresponding lumped <see cref="GameVersion"/> value for the context. /// </summary> /// <remarks>Shouldn't really use this; see <see cref="GetVersionsWithin"/>.</remarks> public static GameVersion GetVersionLump(this EntityContext value) => value switch { Gen1 => GameVersion.Gen1, Gen2 => GameVersion.Gen2, Gen3 => GameVersion.Gen3, Gen4 => GameVersion.Gen4, Gen5 => GameVersion.Gen5, Gen6 => GameVersion.Gen6, Gen7 => GameVersion.Gen7, Gen8 => GameVersion.Gen8, Gen9 => GameVersion.Gen9, Gen7b => GameVersion.Gen7b, Gen8a => GameVersion.PLA, Gen8b => GameVersion.BDSP, _ => throw new ArgumentOutOfRangeException(nameof(value), value, null), }; /// <summary> /// Gets the corresponding <see cref="EntityContext"/> value for the <see cref="GameVersion"/>. /// </summary> public static EntityContext GetContext(this GameVersion version) => version switch { GameVersion.GP or GameVersion.GE or GameVersion.GO => Gen7b, GameVersion.PLA => Gen8a, GameVersion.BD or GameVersion.SP => Gen8b, _ => (EntityContext)version.GetGeneration(), }; }