Simplify some legality checks

wurmple check expanded to work for all gens, ECPID broken up into smaller methods silcoon/cascoon string use the specieslist to fetch localized name
2024-11-10 22:54:14 +00:00 · 2017-04-10 19:00:58 -07:00 · 2017-04-10 19:00:58 -07:00 · 4fec00dceb
commit 4fec00dceb
parent c45a9f0428
4 changed files with 55 additions and 68 deletions
--- a/PKHeX/Legality/Checks.cs
+++ b/PKHeX/Legality/Checks.cs
@ -106,91 +106,89 @@ namespace PKHeX.Core
        }
        private void verifyEReaderBerry()
        {
-            if (Legal.EReaderBerryIsEnigma)
+            if (Legal.EReaderBerryIsEnigma) // no E-Reader berry data provided, can't hold berry.
            {
                AddLine(Severity.Invalid, V204, CheckIdentifier.Form);
                return;
            }
+
            var matchUSA = Legal.EReaderBerriesNames_USA.Contains(Legal.EReaderBerryName);
            var matchJP = Legal.EReaderBerriesNames_JP.Contains(Legal.EReaderBerryName);
-            // Do not match any released e-reader berry
-            if (!matchJP && !matchUSA)
-            {
+            if (!matchJP && !matchUSA) // Does not match any released E-Reader berry
                AddLine(Severity.Invalid, V369, CheckIdentifier.Form);
-                return;
-            }
-            // Ereader is region locked
-            if (matchJP && !Legal.SavegameJapanese)
-            {
+            else if (matchJP && !Legal.SavegameJapanese) // E-Reader is region locked
                AddLine(Severity.Invalid, V370, CheckIdentifier.Form);
-                return;
-            }
-            if (matchUSA && Legal.SavegameJapanese)
-            {
+            else if (matchUSA && Legal.SavegameJapanese) // E-Reader is region locked
                AddLine(Severity.Invalid, V371, CheckIdentifier.Form);
-                return;
-            }
        }
        private void verifyECPID()
        {
-            if (pkm.EncryptionConstant == 0)
-                AddLine(Severity.Fishy, V201, CheckIdentifier.EC);
+            if (pkm.Format >= 6)
+                verifyEC();
+            if (265 <= pkm.Species && pkm.Species <= 269)
+                verifyECPIDWurmple();

            if (pkm.PID == 0)
                AddLine(Severity.Fishy, V207, CheckIdentifier.PID);

            if (pkm.GenNumber >= 6 && pkm.PID == pkm.EncryptionConstant)
-                AddLine(Severity.Fishy, V208, CheckIdentifier.PID);
+                AddLine(Severity.Invalid, V208, CheckIdentifier.PID); // better to flag than 1:2^32 odds since RNG is not feasible to yield match

            if (EncounterType == typeof (EncounterStatic))
            {
-                var enc = (EncounterStatic) EncounterMatch;
+                var enc = (EncounterStatic)EncounterMatch;
                if (enc.Shiny != null && (bool) enc.Shiny ^ pkm.IsShiny)
-                {
                    AddLine(Severity.Invalid, V209, CheckIdentifier.Shiny);
-                    return;
-                }
            }
-            if (EncounterType == typeof(EncounterSlot[]))
+            else if (EncounterType == typeof(EncounterSlot[]))
            {
-                if (pkm.IsShiny && (EncounterMatch as EncounterSlot[]).All(slot => slot.Type == SlotType.HiddenGrotto))
-                {
+                var slots = (EncounterSlot[])EncounterMatch;
+                if (pkm.IsShiny && slots.All(slot => slot.Type == SlotType.HiddenGrotto))
                    AddLine(Severity.Invalid, V221, CheckIdentifier.Shiny);
-                    return;
-                }
+            }
+        }
+        private void verifyECPIDWurmple()
+        {
+            uint evoVal;
+            switch (pkm.GenNumber)
+            {
+                case 3: evoVal = pkm.PID & 0xFFFF; break;
+                case 4:
+                case 5: evoVal = pkm.PID >> 16; break;
+                default: evoVal = pkm.EncryptionConstant >> 16; break;
+            }
+            evoVal = evoVal%10/2;
+
+            if (pkm.Species == 265)
+            {
+                AddLine(Severity.Valid, string.Format(V212, evoVal == 0 ? specieslist[267] : specieslist[269]), CheckIdentifier.EC);
+                return;
            }

-            int wIndex = Array.IndexOf(Legal.WurmpleEvolutions, pkm.Species);
-            if (pkm.GenNumber >= 6)
-            {
-                // Wurmple -> Silcoon/Cascoon
-                if (wIndex > -1)
-                {
-                    // Check if Wurmple was the origin (only Egg and Wild Encounter)
-                    if (pkm.WasEgg || (EncounterType == typeof(EncounterSlot[]) && (EncounterMatch as EncounterSlot[]).All(slot => slot.Species == 265)))
-                        if ((pkm.EncryptionConstant >> 16)%10/5 != wIndex/2)
-                        {
-                            AddLine(Severity.Invalid, V210, CheckIdentifier.EC);
-                            return;
-                        }
-                }
-                else if (pkm.Species == 265)
-                {
-                    AddLine(Severity.Valid, string.Format(V212, (pkm.EncryptionConstant >> 16)%10/5 == 0 ? V213 : V214), CheckIdentifier.EC);
-                }
-                
-                int xor = pkm.TSV ^ pkm.PSV;
-                if (xor < 16 && xor >= 8 && (pkm.PID ^ 0x80000000) == pkm.EncryptionConstant)
-                {
-                    AddLine(Severity.Fishy, V211, CheckIdentifier.EC);
-                    return;
-                }
-            }
-            
-            // abort if specimen wasn't transferred x->6
-            if (pkm.Format < 6 || !(3 <= pkm.GenNumber && pkm.GenNumber <= 5))
+            // Check if Wurmple was the origin (only Egg and Wild Encounter)
+            bool wasWurmple = pkm.WasEgg || (EncounterType == typeof (EncounterSlot[]) && ((EncounterSlot[])EncounterMatch).Any(slot => slot.Species == 265));
+            if (!wasWurmple)
                return;

+            int wIndex = Array.IndexOf(Legal.WurmpleEvolutions, pkm.Species)/2;
+            if (evoVal != wIndex)
+                AddLine(Severity.Invalid, V210, CheckIdentifier.EC);
+        }
+        private void verifyEC()
+        {
+            if (pkm.EncryptionConstant == 0)
+                AddLine(Severity.Fishy, V201, CheckIdentifier.EC);
+            if (3 <= pkm.GenNumber && pkm.GenNumber <= 5)
+                verifyTransferEC();
+            else
+            {
+                int xor = pkm.TSV ^ pkm.PSV;
+                if (xor < 16 && xor >= 8 && (pkm.PID ^ 0x80000000) == pkm.EncryptionConstant)
+                    AddLine(Severity.Fishy, V211, CheckIdentifier.EC);
+            }
+        }
+        private void verifyTransferEC()
+        {
            // When transferred to Generation 6, the Encryption Constant is copied from the PID.
            // The PID is then checked to see if it becomes shiny with the new Shiny rules (>>4 instead of >>3)
            // If the PID is nonshiny->shiny, the top bit is flipped.
@ -202,12 +200,7 @@ namespace PKHeX.Core
                : pkm.EncryptionConstant == pkm.PID;

            if (!valid)
-            {
-                AddLine(Severity.Invalid,
-                    xorPID 
-                    ? V215
-                    : V216, CheckIdentifier.ECPID);
-            }
+                AddLine(Severity.Invalid, xorPID ? V215 : V216, CheckIdentifier.ECPID);
        }
        #region verifyNickname
        private void verifyNickname()
--- a/PKHeX/Legality/LegalityCheckStrings.cs
+++ b/PKHeX/Legality/LegalityCheckStrings.cs
@ -84,8 +84,6 @@ namespace PKHeX.Core
        public static string V210 {get; set;} = "Wurmple evolution Encryption Constant mismatch.";
        public static string V211 {get; set;} = "Encryption Constant matches shinyxored PID.";
        public static string V212 {get; set;} = "Wurmple Evolution: {0}";
-        public static string V213 {get; set;} = "Silcoon";
-        public static string V214 {get; set;} = "Cascoon";
        public static string V215 {get; set;} = "PID should be equal to EC [with top bit flipped]!";
        public static string V216 {get; set;} = "PID should be equal to EC!";
        public static string V220 {get; set;} = "N's Pokemon cannot be shiny.";
--- a/PKHeX/Resources/text/en/LegalityCheckStrings_en.txt
+++ b/PKHeX/Resources/text/en/LegalityCheckStrings_en.txt
@ -49,8 +49,6 @@ V209 = Static Encounter shiny mismatch.
 V210 = Wurmple evolution Encryption Constant mismatch.
 V211 = Encryption Constant matches shinyxored PID.
 V212 = Wurmple Evolution: {0}
-V213 = Silcoon
-V214 = Cascoon
 V215 = PID should be equal to EC [with top bit flipped]!
 V216 = PID should be equal to EC!
 V220 = N's Pokemon cannot be shiny.
--- a/PKHeX/Resources/text/zh/LegalityCheckStrings_zh.txt
+++ b/PKHeX/Resources/text/zh/LegalityCheckStrings_zh.txt
@ -49,8 +49,6 @@ V209 = 定点相遇闪光条件不匹配。
 V210 = 刺尾虫进化形态与加密常数不一致。
 V211 = 加密常数与闪光xor的PID匹配。
 V212 = 刺尾虫进化形态: {0}
-V213 = 甲壳茧
-V214 = 盾甲茧
 V215 = PID应与加密常数相等[第一位反转]!
 V216 = PID应与加密常数相等!
 V220 = N的宝可梦不能为闪。