namespace PKHeX.Core { /// /// Provides information for what values an Egg can have, while it still is an egg. /// public static class EggStateLegality { /// /// Checks if the Egg Entity's hatch counter value is within the confines of game legality. /// /// Egg Entity /// Encounter the egg was generated from /// True if valid, false if invalid. public static bool GetIsEggHatchCyclesValid(PKM pk, IEncounterTemplate enc) { var hatchCounter = pk.OT_Friendship; var max = GetMaximumEggHatchCycles(pk, enc); if (hatchCounter > max) return false; var min = GetMinimumEggHatchCycles(pk); if (hatchCounter < min) return false; return true; } /// /// Gets the minimum hatch counter value allowed for an Egg Entity. /// /// Egg Entity /// Usually 1... public static int GetMinimumEggHatchCycles(PKM pk) => pk switch { PK2 or PB8 => 1, // no grace period between 1 step remaining and hatch _ => 0, // having several Eggs in your party and then hatching one will give the rest 0... they can then be boxed! }; /// /// Will create a new to find the encounter. public static int GetMaximumEggHatchCycles(PKM pk) { var la = new LegalityAnalysis(pk); var enc = la.EncounterMatch; return GetMaximumEggHatchCycles(pk, enc); } /// /// Gets the original Hatch Cycle value for an Egg Entity. /// /// Egg Entity /// Encounter the egg was generated from /// Maximum value the Hatch Counter can be. public static int GetMaximumEggHatchCycles(PKM pk, IEncounterTemplate enc) { if (enc is EncounterStatic { EggCycles: not 0 } s) return s.EggCycles; return pk.PersonalInfo.HatchCycles; } /// /// Level which eggs are given to the player. /// /// Generation the egg is given in public static int GetEggLevel(int generation) => generation >= 4 ? 1 : 5; /// /// Checks if the and associated details can be set for the provided egg . /// /// Egg Entity /// True if valid, false if invalid. public static bool IsValidHTEgg(PKM pk) => pk switch { PB8 { Met_Location: Locations.LinkTrade6NPC } pb8 when pb8.HT_Friendship == PersonalTable.BDSP[pb8.Species].BaseFriendship => true, _ => false, }; /// /// Indicates if the flag should be set for an Egg entity. /// /// Encounter the egg was generated with /// Egg Entity /// True if the flag should be set, otherwise false. public static bool IsNicknameFlagSet(IEncounterTemplate enc, PKM pk) => enc switch { EncounterStatic7 => false, WB8 or EncounterStatic8b when pk.IsUntraded => false, { Generation: 4 } => false, _ => true, }; /// public static bool IsNicknameFlagSet(PKM pk) => IsNicknameFlagSet(new LegalityAnalysis(pk).EncounterMatch, pk); } }