Update hyperspace encounters, misc checks

Adds pickle from all possible random encounter sets in hyperspace
Updates some formarg checks for certain species
Updates plus move checks for movesets that were revised by DLC

Hyperspace encounters are in a separate array, with a different slot type

Add note for Teensy/Humungo for wild encounters causing a fixed scale value rather than random.

Should be noted that this is a first-stab at encounters, and things have not been tested sufficiently to ensure the level ranges/etc are actually good data. please don't use the encounters yet; this just gets it out to testers for finding more edge cases.

PKHeX.Core/Legality/Encounters/Data/Gen9/Encounters9a.cs

@@ -5,7 +5,8 @@ namespace PKHeX.Core;
 
 internal static class Encounters9a
 {
-    internal static readonly EncounterArea9a[] Slots = EncounterArea9a.GetAreas(Get16("za", "za"u8));
+    internal static readonly EncounterArea9a[] Slots = EncounterArea9a.GetAreas(Get16("za", "za"u8), SlotType9a.Standard);
+    internal static readonly EncounterArea9a[] Hyperspace = EncounterArea9a.GetAreas(Get16("hyperspace_za", "za"u8), SlotType9a.Hyperspace);
 
     internal static readonly EncounterGift9a[] Gifts =
     [

PKHeX.Core/Legality/Encounters/Generator/Possible/EncounterPossible9a.cs

@@ -33,6 +33,7 @@ private enum YieldState : byte
 
         SlotStart,
         Slot,
+        Hyperspace,
         SlotEnd,
 
         StaticCapture,
@@ -91,10 +92,16 @@ public bool MoveNext()
             case YieldState.SlotStart:
                 if (!Flags.HasFlag(EncounterTypeGroup.Slot))
                     goto case YieldState.End;
+                State = YieldState.Slot;
                 goto case YieldState.Slot;
             case YieldState.Slot:
                 if (TryGetNext<EncounterArea9a, EncounterSlot9a>(Encounters9a.Slots))
                     return true;
+                Index = 0; State = YieldState.Hyperspace;
+                goto case YieldState.Hyperspace;
+            case YieldState.Hyperspace:
+                if (TryGetNext<EncounterArea9a, EncounterSlot9a>(Encounters9a.Hyperspace))
+                    return true;
                 goto case YieldState.SlotEnd;
             case YieldState.SlotEnd:
                 goto case YieldState.End;

PKHeX.Core/Legality/Encounters/Generator/Search/EncounterEnumerator9a.cs

@@ -38,6 +38,7 @@ private enum YieldState : byte
 
         SlotStart,
         Slot,
+        Hyperspace,
         SlotEnd,
 
         StaticCapture,
@@ -95,6 +96,10 @@ public bool MoveNext()
             case YieldState.Slot:
                 if (TryGetNext<EncounterArea9a, EncounterSlot9a>(Encounters9a.Slots))
                     return true;
+                Index = 0; State = YieldState.Hyperspace; goto case YieldState.Hyperspace;
+            case YieldState.Hyperspace:
+                if (TryGetNext<EncounterArea9a, EncounterSlot9a>(Encounters9a.Hyperspace))
+                    return true;
                 Index = 0; goto case YieldState.SlotEnd;
             case YieldState.SlotEnd:
                 if (!mustBeSlot)

PKHeX.Core/Legality/Encounters/Templates/Gen9a/EncounterArea9a.cs

@@ -8,24 +8,26 @@ namespace PKHeX.Core;
 /// </summary>
 public sealed record EncounterArea9a : IEncounterArea<EncounterSlot9a>, IAreaLocation
 {
+    public const ushort LocationHyperspace = 273;
+
     public EncounterSlot9a[] Slots { get; }
 
-    public readonly byte Location;
+    public readonly ushort Location;
     public readonly SlotType9a Type;
     public bool IsMatchLocation(ushort location) => Location == location; // no crossovers!
 
-    public static EncounterArea9a[] GetAreas(BinLinkerAccessor16 input)
+    public static EncounterArea9a[] GetAreas(BinLinkerAccessor16 input, SlotType9a type)
     {
         var result = new EncounterArea9a[input.Length];
         for (int i = 0; i < result.Length; i++)
-            result[i] = new EncounterArea9a(input[i]);
+            result[i] = new EncounterArea9a(input[i], type);
         return result;
     }
 
-    private EncounterArea9a(ReadOnlySpan<byte> areaData)
+    private EncounterArea9a(ReadOnlySpan<byte> areaData, SlotType9a type)
     {
-        Location = areaData[0]; // 235 max, will overflow in DLC, probably.
-        Type = SlotType9a.Standard;
+        Location = ReadUInt16LittleEndian(areaData);
+        Type = type;
         // 2..3 reserved
         Slots = ReadSlots(areaData[4..]);
     }

PKHeX.Core/Legality/Encounters/Templates/Gen9a/EncounterSlot9a.cs

@@ -10,6 +10,9 @@ public sealed record EncounterSlot9a(EncounterArea9a Parent, ushort Species, byt
 {
     public byte Generation => 9;
     private const GameVersion Version = GameVersion.ZA;
+
+    private bool IsHyperspace => Location == EncounterArea9a.LocationHyperspace;
+
     GameVersion IVersion.Version => GameVersion.ZA;
     public EntityContext Context => EntityContext.Gen9a;
     public bool IsEgg => false;
@@ -65,7 +68,8 @@ public PA9 ConvertToPKM(ITrainerInfo tr, EncounterCriteria criteria)
 
     private void SetPINGA(PA9 pk, EncounterCriteria criteria, PersonalInfo9ZA pi)
     {
-        var param = GetParams(pi, criteria.Shiny.IsShiny());
+        bool shinyPlease = criteria.Shiny.IsShiny();
+        var param = GetParams(pi, shinyPlease, shinyPlease);
         ulong init = Util.Rand.Rand64();
         var success = this.TryApply64(pk, init, param, criteria);
         if (!success && !this.TryApply64(pk, init, param, criteria.WithoutIVs()))
@@ -117,6 +121,9 @@ public EncounterMatchRating GetMatchRating(PKM pk)
         if (Shiny is Shiny.Never && pk.IsShiny) // Some encounters are shiny locked until a sub-quest is completed.
             return EncounterMatchRating.DeferredErrors;
 
+        if (IsFormArgMismatch(pk))
+            return EncounterMatchRating.DeferredErrors;
+
         var pidiv = TryGetSeed(pk, out _);
         if (pidiv is SeedCorrelationResult.Invalid)
             return EncounterMatchRating.DeferredErrors;
@@ -126,17 +133,24 @@ public EncounterMatchRating GetMatchRating(PKM pk)
         return EncounterMatchRating.Match;
     }
 
+    private bool IsFormArgMismatch(PKM pk) => pk.Species switch
+    {
+        (int)Core.Species.Overqwil when Species is not (int)Core.Species.Overqwil && pk is IFormArgument { FormArgument: 0 } and IHomeTrack { HasTracker: false } => true,
+        _ => false,
+    };
+
     #endregion
 
     public SeedCorrelationResult TryGetSeed(PKM pk, out ulong seed)
     {
-        var param = GetParams(PersonalTable.ZA[Species, Form], false);
+        var param = GetParams(PersonalTable.ZA[Species, Form], false, false);
         if (param.TryGetSeed(pk, out seed))
             return SeedCorrelationResult.Success;
         if (pk.IsShiny && !LumioseSolver.SearchShiny1 || !LumioseSolver.SearchShinyN)
             return SeedCorrelationResult.Ignore;
 
-        param = param with { RollCount = 1 + ShinyCharm };
+        var rollCount = (byte)(1 + ShinyCharm + (IsHyperspace ? ShinyHyperspace : 0));
+        param = param with { RollCount = rollCount };
         if (param.TryGetSeed(pk, out seed))
             return SeedCorrelationResult.Success;
         return SeedCorrelationResult.Invalid;
@@ -145,13 +159,14 @@ public SeedCorrelationResult TryGetSeed(PKM pk, out ulong seed)
     public LumioseCorrelation Correlation => IsAlpha ? LumioseCorrelation.PreApplyIVs : LumioseCorrelation.Normal;
 
     private const byte ShinyCharm = 3;
+    private const byte ShinyHyperspace = 3;
 
-    public GenerateParam9a GetParams(PersonalInfo9ZA pi) => GetParams(pi, shinyCharm: false);
+    public GenerateParam9a GetParams(PersonalInfo9ZA pi) => GetParams(pi, shinyCharm: false, activeShinyPower: false);
 
-    public GenerateParam9a GetParams(PersonalInfo9ZA pi, bool shinyCharm)
+    public GenerateParam9a GetParams(PersonalInfo9ZA pi, bool shinyCharm, bool activeShinyPower)
     {
         // Give the +3 for Shiny Charm so that the generator search is more likely to succeed.
-        var rollCount = (byte)(1 + (shinyCharm ? ShinyCharm : 0));
+        var rollCount = (byte)(1 + (shinyCharm ? ShinyCharm : 0) + (IsHyperspace && activeShinyPower ? ShinyHyperspace : 0));
         var scaleValue = IsAlpha ? (byte)255 : (byte)0;
         var scaleType = IsAlpha ? SizeType9.VALUE : SizeType9.RANDOM;
         var gender = Gender switch

PKHeX.Core/Legality/Encounters/Templates/Gen9a/EncounterStatic9a.cs

@@ -35,6 +35,8 @@ public sealed record EncounterStatic9a(ushort Species, byte Form, byte Level, by
 
     ushort ILocation.Location => Location;
 
+    private bool HyperspaceShinyPossible => Shiny != Shiny.Never && Location == EncounterArea9a.LocationHyperspace;
+
     public string Name => "Static Encounter";
     public string LongName => Name;
 
@@ -166,8 +168,10 @@ private EncounterMatchRating IsMatchDeferred(PKM pk)
             return EncounterMatchRating.DeferredErrors;
 
         var pidiv = TryGetSeed(pk, out _);
-        if (pidiv is not SeedCorrelationResult.Success)
+        if (pidiv is SeedCorrelationResult.Invalid)
             return EncounterMatchRating.DeferredErrors;
+        if (pidiv is SeedCorrelationResult.Ignore)
+            return EncounterMatchRating.Deferred; // might be a better match with another template
 
         return EncounterMatchRating.Match;
     }
@@ -191,7 +195,16 @@ private bool IsMatchPartial(PKM pk)
 
     public SeedCorrelationResult TryGetSeed(PKM pk, out ulong seed)
     {
-        if (GetParams(PersonalTable.ZA[Species, Form]).TryGetSeed(pk, out seed))
+        var param = GetParams(PersonalTable.ZA[Species, Form]);
+        if (param.TryGetSeed(pk, out seed))
+            return SeedCorrelationResult.Success;
+        if (!HyperspaceShinyPossible)
+            return SeedCorrelationResult.Invalid;
+        if (pk.IsShiny && !LumioseSolver.SearchShiny1 || !LumioseSolver.SearchShinyN)
+            return SeedCorrelationResult.Ignore;
+
+        param = param with { RollCount = 7 };
+        if (param.TryGetSeed(pk, out seed))
             return SeedCorrelationResult.Success;
         return SeedCorrelationResult.Invalid;
     }
@@ -210,7 +223,7 @@ public LumioseCorrelation Correlation
 
     public GenerateParam9a GetParams(PersonalInfo9ZA pi)
     {
-        const byte rollCount = 1;
+        byte rollCount = HyperspaceShinyPossible ? (byte)7 : (byte)1;
         var gender = Gender switch
         {
             0 => PersonalInfo.RatioMagicMale,

PKHeX.Core/Legality/Encounters/Templates/Gen9a/LumioseRNG.cs

@@ -112,6 +112,8 @@ public static bool GenerateData(PA9 pk, in GenerateParam9a enc, in EncounterCrit
             return false;
         pk.Nature = pk.StatNature = nature;
 
+        // If Hyperspace, the player can have an active Teensy/Humungo boost. The scale is pre-determined outside of the seed=>pa9, consider it not correlated or traceable.
+        // When calling the method to verify the entity, pass SizeType9.VALUE instead.
         pk.Scale = enc.SizeType.GetSizeValue(enc.Scale, ref rand);
         return true;
     }
@@ -268,6 +270,8 @@ private static bool IsMatchIVsAndFollowing(PKM pk, in GenerateParam9a enc, Xoros
             return false;
 
         // Scale
+        // If Hyperspace, the player can have an active Teensy/Humungo boost. The scale is pre-determined outside of the seed=>pa9, consider it not correlated or traceable.
+        // When calling the method to verify the entity, pass SizeType9.VALUE instead.
         {
             var value = enc.SizeType.GetSizeValue(enc.Scale, ref rand);
             if (pk is IScaledSize3 s)

PKHeX.Core/Legality/Encounters/Templates/Gen9a/SlotType9a.cs

@@ -1,6 +1,17 @@
 namespace PKHeX.Core;
 
+/// <summary>
+/// Encounter method for wild encounters in Legends: Z-A
+/// </summary>
 public enum SlotType9a : byte
 {
+    /// <summary>
+    /// Overworld Lumiose
+    /// </summary>
     Standard = 0,
+
+    /// <summary>
+    /// Hyperspace Lumiose
+    /// </summary>
+    Hyperspace = 1,
 }

PKHeX.Core/Legality/Evolutions/EvolutionGroup/EvolutionGroupHOME.cs

@@ -226,7 +226,15 @@ private int EvolveSingle(Span<EvoCriteria> result, PKM pk, in EvolutionOrigin en
         PA8 => LA,
         PB8 => BDSP,
         PK9 => SV,
-        _ => throw new ArgumentOutOfRangeException(nameof(pk), pk, null),
+        _ => pk.Version switch // transferred to another game (Z-A)
+        {
+            GameVersion.PLA => LA,
+            GameVersion.SW or GameVersion.SH => SWSH,
+            GameVersion.BD or GameVersion.SP => BDSP,
+            GameVersion.SL or GameVersion.VL => SV,
+            _ => throw new ArgumentOutOfRangeException(nameof(pk), pk, null),
+        },
+        
     };
 }
 

PKHeX.Core/Legality/Evolutions/Methods/EvolutionType.cs

@@ -74,7 +74,7 @@ public enum EvolutionType : byte
     LevelUpRecoilDamageFemale = 60, // Basculegion-1
 
     Hisui = 61,
-    UseMovePlusStyle = 62,
+    UseMoveBarbBarrage = 62, // Qwilfish (Z-A)
 
     // These are fake IDs as PLA indexes clashed with mainline.
     UseItemFullMoon = 90, // Ursaluna
@@ -173,7 +173,7 @@ public static class EvolutionTypeExtensions
         UseItemFullMoon => false,
         UseMoveAgileStyle => false,
         UseMoveStrongStyle => false,
-        UseMovePlusStyle => false,
+        UseMoveBarbBarrage => false,
         _ => throw new ArgumentOutOfRangeException(nameof(type), type, null),
     };
 }

PKHeX.Core/Legality/Verifiers/FormArgumentVerifier.cs

@@ -91,12 +91,21 @@ private CheckResult VerifyFormArgument(LegalityAnalysis data, IFormArgument f)
             },
             Gimmighoul => arg switch
             {
+                // Z-A evolutions do not set form argument to Gimmighoul.
+                0 when data.Info.EvoChainsAllGens.HasVisitedZA => GetValid(FormArgumentValid),
+
                 // When leveled up, the game copies the save file's current coin count to the arg (clamped to <=999). If >=999, evolution is triggered.
                 // Without being leveled up at least once, it cannot have a form arg value.
                 >= 999 => GetInvalid(FormArgumentLEQ_0, 999),
                 0 => GetValid(FormArgumentValid),
+
+                // S/V sets form argument to match coin count.
+                _ when !data.Info.EvoChainsAllGens.HasVisitedGen9 => GetInvalid(FormArgumentInvalid),
                 _ => pk.CurrentLevel != pk.MetLevel ? GetValid(FormArgumentValid) : GetInvalid(FormArgumentNotAllowed),
             },
+            Gholdengo when !data.Info.EvoChainsAllGens.HasVisitedGen9 => arg == 0 ? GetValid(FormArgumentValid) : GetInvalid(FormArgumentInvalid),
+            Gholdengo => VerifyFormArgumentRange(enc.Species, Gholdengo, arg, 999, 999),
+
             Runerigus   => VerifyFormArgumentRange(enc.Species, Runerigus,   arg,  49, 9999),
             Alcremie    => VerifyFormArgumentRange(enc.Species, Alcremie,    arg,   0, (ushort)AlcremieDecoration.Ribbon),
             Wyrdeer when enc.Species != (int)Wyrdeer && pk.CurrentLevel < 31 => GetInvalid(EvoInvalid),
@@ -104,7 +113,6 @@ private CheckResult VerifyFormArgument(LegalityAnalysis data, IFormArgument f)
             Basculegion => VerifyFormArgumentRange(enc.Species, Basculegion, arg, 294, 9999),
             Annihilape  => VerifyFormArgumentRange(enc.Species, Annihilape,  arg,  20, 9999),
             Kingambit   => VerifyFormArgumentRange(enc.Species, Kingambit,   arg,   3, 9999),
-            Gholdengo   => VerifyFormArgumentRange(enc.Species, Gholdengo,   arg, 999,  999),
             Koraidon or Miraidon => enc switch
             {
                 // Starter Legend has '1' when present in party, to differentiate.

PKHeX.Core/Legality/Verifiers/LegendsZAVerifier.cs

@@ -1,4 +1,7 @@
 using System;
+using static PKHeX.Core.Ball;
+using static PKHeX.Core.Move;
+using static PKHeX.Core.Species;
 using static PKHeX.Core.LegalityCheckResultCode;
 
 namespace PKHeX.Core;
@@ -169,7 +172,7 @@ private void CheckFlagsPlus(LegalityAnalysis la, PA9 pk)
         la.AddLine(msg);
     }
 
-    private void CheckPlusMoveFlags<T>(LegalityAnalysis la, T pk, IPermitPlus permit, Learnset plus, byte currentLevel) where T : IPlusRecord
+    private void CheckPlusMoveFlags<T>(LegalityAnalysis la, T pk, IPermitPlus permit, Learnset plus, byte currentLevel) where T : PKM, IPlusRecord
     {
         var levels = plus.GetAllLevels();
         var moves = plus.GetAllMoves();
@@ -193,6 +196,9 @@ private void CheckFlagsPlus(LegalityAnalysis la, PA9 pk)
             if (IsTradeEvoSkip(la.Info.EvoChainsAllGens.Gen9a, move))
                 continue;
 
+            if (WasPossiblyObtainedBeforeDLC(pk, la.EncounterMatch) && IsPermittedUnsetPlusMove((Species)pk.Species, (Move)move))
+                continue;
+
             la.AddLine(GetInvalid(PlusMoveSufficientLevelMissing_0, move, level));
         }
     }
@@ -229,7 +235,7 @@ private static bool IsTradeEvoSkip(ReadOnlySpan<EvoCriteria> evos, ushort move)
     private const ushort MultipleInvalidPlusMoves = ushort.MaxValue;
 
     private static ushort GetInvalidPlusMove<T>(T pk, int maxIndex, IPermitPlus permit, ReadOnlySpan<EvoCriteria> evos)
-        where T : IPlusRecord
+        where T : PKM, IPlusRecord
     {
         ushort invalid = 0;
         for (int i = 0; i < maxIndex; i++)
@@ -272,4 +278,52 @@ private static ushort GetInvalidPlusMove<T>(T pk, int maxIndex, IPermitPlus perm
         }
         return false;
     }
+
+    private static bool WasPossiblyObtainedBeforeDLC(PKM pk, IEncounterTemplate enc)
+    {
+        if (pk.Version is not GameVersion.ZA)
+            return false; // HOME transfer (after DLC).
+
+        if (pk.Ball is (int)Safari or (int)Beast)
+            return false; // Ball not introduced until DLC.
+        if (enc.Location is (>= EncounterArea9a.LocationHyperspace and <= 3000))
+            return false; // Hyperspace encounter location
+
+        var dex = PersonalTable.ZA[enc.Species, enc.Form];
+        if (!dex.IsLumioseNative)
+            return false; // Additional wild encounter in the overworld not originally present in base game.
+        if (enc is EncounterStatic9a { Species: (int)Sandile or (int)Krokorok })
+            return false; // Additional static encounter in the overworld not originally present in base game.
+
+        return true;
+    }
+
+    /// <summary>
+    /// DLC added new moves to learnsets. Pokémon that could not have been obtained before DLC can lack these automatic plus moves.
+    /// </summary>
+    /// <returns><see langword="true"/> if the Plus move flag is not required to be set.</returns>
+    /// <remarks>
+    /// Pokémon can always be awarded the Plus move flag via the Seed of Mastery manually. The game does not retroactively set the Plus move flag for existing Pokémon.
+    /// </remarks>
+    private static bool IsPermittedUnsetPlusMove(Species species, Move move) => species switch
+    {
+        // Relearn moves added in DLC:
+        Pichu or Pikachu or Raichu when move is DrainingKiss => true,
+        Onix when move is RockBlast => true,
+        Absol when move is Snarl or PhantomForce => true,
+        Roserade or Whirlipede or Scolipede when move is MortalSpin => true,
+        Abomasnow when move is IceHammer => true,
+        Gallade when move is SacredSword => true,
+        Espurr or Meowstic when move is Teleport => true,
+        Meowstic when move is Moonblast => true,
+        Honedge when move is SacredSword => true,
+        Malamar when move is Octolock => true,
+        Heliolisk when move is ShedTail => true,
+        Aurorus when move is IceHammer => true,
+
+        // Level-up moves added in DLC:
+        Absol when move is ConfuseRay or ShadowSneak => true,
+
+        _ => false,
+    };
 }

PKHeX.Core/PersonalInfo/Info/PersonalInfo9ZA.cs

@@ -64,6 +64,8 @@ public sealed class PersonalInfo9ZA(Memory<byte> Raw) : PersonalInfo, IPersonalA
     /// Checks if the entry shows up in any of the built-in Pokédex.
     /// </summary>
     public bool IsInDex => DexIndex != 0;
+    public bool IsLumioseNative => DexIndex is (not 0) and <= 232;
+    public bool IsHyperspaceNative => DexIndex > 232;
 
     public override int AbilityCount => 3;
     public override int GetIndexOfAbility(int abilityID) => abilityID == Ability1 ? 0 : abilityID == Ability2 ? 1 : abilityID == AbilityH ? 2 : -1;

PKHeX.WinForms/Subforms/KChart.cs

@@ -102,7 +102,7 @@ static void Stat(DataGridViewCell cell, int value)
         PersonalInfo8BDSP bs => bs.IsInDex,
         PersonalInfo8LA bs => bs.IsPresentInGame,
         PersonalInfo9SV sv => sv.IsInDex,
-        PersonalInfo9ZA za => za is { IsInDex: true, DexIndex: <= 232 },
+        PersonalInfo9ZA za => za is { IsLumioseNative: true },
         _ => true,
     };