add canXModeSpikeSuit to logic. (#2324)

Author: nn357

helpers.json

@@ -1550,7 +1550,33 @@
             "canRModeKnockbackSpark",
             {"shinespark": {"frames": 4, "excessFrames": 4}}
           ]
-        }
+        },
+        {
+          "name": "h_SpikeXModeSpikeSuit",
+          "requires": [
+            "h_XModeSpikeHit",
+            "h_XModeSpikeHit",
+            "h_spikeSuitSpikeHitLeniency",
+            "h_spikeSuitSpikeHitLeniency",
+            "h_spikeSuitSpikeHitLeniency",
+            "h_shinechargeMaxRunway",
+            "canXModeSpikeSuit",
+            {"spikeHits": 1}
+          ]
+        },
+                {
+          "name": "h_ThornXModeSpikeSuit",
+          "requires": [
+            "h_XModeThornHit",
+            "h_XModeThornHit",
+            "h_XModeThornHitLeniency",
+            "h_XModeThornHitLeniency",
+            "h_XModeThornHitLeniency",
+            "h_shinechargeMaxRunway",
+            "canXModeSpikeSuit",
+            {"thornHits": 1}
+          ]
+        }           
       ]
     }
   ]

region/brinstar/pink/Pink Brinstar Wave Gate Room.json

@@ -700,6 +700,41 @@
       "gModeRegainMobility": {},
       "flashSuitChecked": true
     },
+    {
+      "link": [1, 1],
+      "name": "Gain Flash Suit (X-Mode Spikesuit)",
+      "requires": [
+        {"obstaclesCleared": ["A"]},
+        "h_destroyBombWalls",
+        "canBeVeryPatient",
+        "h_SpikeXModeSpikeSuit",
+        {"shinespark": {"frames": 3, "excessFrames": 3}}
+      ],
+        "resetsObstacles": ["C"],
+        "note": [
+        "A one frame dash jump will give Samus 4 pixels of leniency for the bounce position, two frames is pixel perfect and more than two frames it doesn't work.",
+        "Samus will jump approximately two tiles higher with a one frame jump compared to a two frame jump."
+      ]
+    },
+    {
+      "link": [1, 1],
+      "name": "Gain Flash Suit (X-Mode Spikesuit) - Leave With Shinespark",
+      "requires": [
+        {"obstaclesCleared": ["A"]},
+        "canFlashSuitDoubleSpark",
+        "h_destroyBombWalls",
+        "canBeVeryPatient",
+        "h_SpikeXModeSpikeSuit",
+        {"shinespark": {"frames": 26}}
+      ],
+      "exitCondition": {
+        "leaveWithSpark": {"position": "top"}
+      },
+      "note": [
+        "A one frame dash jump will give Samus 4 pixels of leniency for the bounce position, two frames is pixel perfect and more than two frames it doesn't work.",
+        "Samus will jump approximately two tiles higher with a one frame jump compared to a two frame jump."
+      ]
+    },
     {
       "id": 21,
       "link": [1, 2],
@@ -1192,6 +1227,55 @@
         "Two hits from the big Sidehopper appears to be a worst-case scenario."
       ]
     },
+    {
+      "link": [1, 3],
+      "name": "Gain Flash Suit (X-Mode Spikesuit) - Shinespark Up",
+      "requires": [
+          {"or": [
+          "Wave",
+          {"obstaclesCleared": ["B"]}
+        ]},
+        {"obstaclesCleared": ["A"]},
+        {"obstaclesNotCleared": ["C"]},
+        "canFlashSuitDoubleSpark",
+        "h_destroyBombWalls",
+        "canBeVeryPatient",
+        "h_SpikeXModeSpikeSuit",
+        {"shinespark": {"frames": 26}}
+      ],
+      "resetsObstacles": ["C"],
+      "clearsObstacles": ["B"],
+      "wallJumpAvoid": true,
+      "note": [
+        "A one frame dash jump will give Samus 4 pixels of leniency for the bounce position, two frames is pixel perfect and more than two frames it doesn't work.",
+        "Samus will jump approximately two tiles higher with a one frame jump compared to a two frame jump."
+      ]
+    },
+    {
+      "link": [1, 3],
+      "name": "X-Mode, Shinespark Up",
+      "requires": [
+        {"or": [
+          "Wave",
+          {"obstaclesCleared": ["B"]}
+      ]},
+        {"obstaclesCleared": ["A"]},
+        {"obstaclesNotCleared": ["C"]},
+        "canXMode",
+        "h_XModeSpikeHit",
+        "h_XModeSpikeHit",
+        "h_shinechargeMaxRunway",
+        "canBeVeryPatient",
+        {"shinespark": {"frames": 16}}
+      ],
+      "resetsObstacles": ["C"],
+      "clearsObstacles": ["B"],
+      "wallJumpAvoid": true,
+      "note": [
+        "A one frame dash jump will give Samus 4 pixels of leniency for the bounce position, two frames is pixel perfect and more than two frames it doesn't work.",
+        "Samus will jump approximately two tiles higher with a one frame jump compared to a two frame jump."
+      ]
+    },
     {
       "id": 39,
       "link": [1, 4],
@@ -1285,8 +1369,8 @@
           ]}
         ]}
       ],
-      "clearsObstacles": ["A", "B"],
-      "resetsObstacles": ["C"],
+      "clearsObstacles": ["A"],
+      "resetsObstacles": ["C", "B"],
       "farmCycleDrops": [
         {"enemy": "Sidehopper", "count": 1},
         {"enemy": "Sm. Sidehopper", "count": 2}

tech.json

@@ -2402,6 +2402,17 @@
                 "Damage from a slow moving enemy will usually kill Samus after i-frames expire; for this type of enemy shinespark away as soon as Samus starts to turn blue."
               ]
             },
+            {
+              "name": "canXModeSpikeSuit",
+              "techRequires": [
+                "canXMode",
+                "canSpikeSuit"
+              ],
+              "otherRequires": [],
+              "note": [
+                "The ability to gain a flash suit by using spike X-Mode to gain the initial shinecharge instead of a runway."
+              ]
+            },
             {
               "id": 208,
               "name": "canComplexCarryFlashSuit",
@@ -2826,10 +2837,15 @@
             {"noFlashSuit": {}}
           ],
           "note": [
-            "Ability to enter X-Mode using spikes by unmorphing frame perfectly before knockback ends with X-Ray ready to activate.",
+            "Ability to enter X-Mode using spikes by unmorphing within a 2-frame window after contact with spikes while holding forwards with X-Ray ready to activate.",
             "This can be used to charge a shinespark or to slowly move forward by armpumping.",
             "Walking into a solid tile while in X-Mode will crash the game."
           ],
+          "detailNote": [
+            "Samus must bounce once while morphed before unmorphing, or have collided horizontally with a solid object like a platform. If bouncing, this can be a platform above the spikes, or if there is room even the spikes themselves.",
+            "To build a shinecharge with X-Mode, Samus must enter X-Mode with dash speed, such as a stationary spinjump and selecting X-Ray before landing on the spikes.",
+            "After selecting X-ray the dash button can be held to automatically activate X-Ray after unmorphing. "
+          ],
           "devNote": [
             "A flash suit can be used while in X-Mode, but any unused flash suit will be lost when X-Ray is released.",
             "Using a flash suit during X-Mode should be represented by a `useFlashSuit` immediately before `canXMode`."

tests/asserts/keywords.py

@@ -494,7 +494,7 @@ def process_req_speed_state(req, states, err_fn):
             # Note: "canSpeedKeep" can be used for other purposes than obtaining blue, but its presence should be
             # enough to satisfy the test as a way that blue may be obtained.
             states = {"blue"}
-        elif req in ["h_flashSuitIceClip"]:
+        elif req in ["h_flashSuitIceClip", "h_SpikeXModeSpikeSuit", "h_ThornXModeSpikeSuit"]:
             states = {"preshinespark"}
         elif req in ["h_CrystalSpark", "h_heatedCrystalSpark", "canRModeSparkInterrupt", "h_RModeKnockbackSpark"]:
             if not states.issubset(["shinecharging", "shinecharged"]):