Add canRModeKnockbackSpark to logic (#2318)

Author: nn357

helpers.json

@@ -1517,6 +1517,15 @@
             "Morph will not be a usable alternative to get up very constrained ledges, such as in a morph tunnel.",
             "IBJ is not usable for underwater rooms without Gravity."
           ]
+        },
+        {
+          "name": "h_RModeKnockbackSpark",
+          "requires": [
+            {"partialRefill": {"type": "ReserveEnergy", "limit": 4}},
+            {"autoReserveTrigger": {"minReserveEnergy": 1, "maxReserveEnergy": 4}},
+            "canRModeKnockbackSpark",
+            {"shinespark": {"frames": 4, "excessFrames": 4}}
+          ]
         }
       ]
     }

logicalRequirements.md

@@ -730,3 +730,5 @@ __Example:__
 ```json
 {"disableEquipment": "HiJump"}
 ```
+
+Note that the requirement `{"disableEquipment": "ETank"}` occurs in some strats. This is not a functionality of the vanilla game but may be supported in randomizers or other modifications of the game: it means that the player has a way to control the amount of ETanks that are currently active. It is commonly required in R-mode strats where the player may need to farm non-respawning enemies in the room to put energy back into reserves.

region/wreckedship/main/Basement.json

@@ -336,6 +336,33 @@
       "gModeRegainMobility": {},
       "flashSuitChecked": true
     },
+    {
+      "link": [1, 1],
+      "name": "Gain Flash Suit (R-Mode Knockback Spark)",
+      "entranceCondition": {
+        "comeInWithRMode": {}
+      },
+      "requires": [
+        "f_DefeatedPhantoon",
+        {"or": [
+         {"and": [
+          {"disableEquipment": "ETank"},
+          {"resourceAvailable": [{"type": "Energy", "count": 80}]}
+        ]},
+        "h_CrystalFlash"
+      ]},
+        {"canShineCharge": {"usedTiles": 38, "openEnd": 1}},
+        "h_RModeKnockbackSpark"
+      ],
+      "note": [
+        "Disable E-tanks and with a full Reserve tank enter the room in R-Mode. Farm Energy from the first and if necessary second Atomic to put Energy into reserves.",
+        "Damage down and ensure there is between 1-4 energy in reserves. Lure the third Atomic down towards Samus while shooting the robot to move it back.",
+        "Shinecharge and stop just before the Atomic, allow it to make contact with Samus while stationary, triggering the reserves and an R-Mode forced standup.",
+        "Frame perfectly press jump to shinespark and gain a flash suit. The Atomic will not move out of the way so as soon as Samus starts to turn blue",
+        "shinespark to kill it before i-frames run out and it kills Samus. Sparking too early will not gain a flashsuit."
+      ],
+      "devNote": "If E-tanks cannot be disabled, a crystalflash can be used to put energy into reserves."
+    },
     {
       "id": 13,
       "link": [1, 2],
@@ -724,6 +751,34 @@
       ],
       "devNote": "This is only for indirect G-Mode, because it is trivial while in direct, and would use a different strat."
     },
+    {
+      "link": [2, 2],
+      "name": "Gain Flash Suit (R-Mode Knockback Spark)",
+      "entranceCondition": {
+        "comeInWithRMode": {},
+        "comesThroughToilet": "any"
+      },
+      "requires": [
+        "f_DefeatedPhantoon",
+        {"or": [
+         {"and": [
+          {"disableEquipment": "ETank"},
+          {"resourceAvailable": [{"type": "Energy", "count": 80}]}
+        ]},
+        "h_CrystalFlash"
+      ]},
+        {"canShineCharge": {"usedTiles": 38, "openEnd": 1}},
+        "h_RModeKnockbackSpark"
+      ],
+      "note": [
+        "Disable E-tanks and with a full Reserve tank enter the room in R-Mode. Farm Energy from the first and if necessary second Atomic near the top door to put Energy into reserves.",
+        "Lure the third Atomic near the left door down toward samus and use it damage down if the first two Atomic's were used for farming, shooting the robot to move it back gives more runway.",
+        "Shinecharge and stop just before the Atomic, allow it to make contact with Samus while stationary, triggering the reserves and an R-Mode forced standup.",
+        "Frame perfectly press jump to shinespark and gain a flash suit. The Atomic will not move out of the way so as soon as Samus starts to turn blue",
+        "shinespark to kill it before i-frames run out and it kills Samus. Sparking too early will not gain a flashsuit."
+      ],
+      "devNote": "If E-tanks cannot be disabled, a crystalflash can be used to put energy into reserves."
+    },
     {
       "id": 28,
       "link": [2, 3],
@@ -1233,6 +1288,34 @@
         "leaveWithGModeSetup": {}
       },
       "flashSuitChecked": true
+    },
+    {
+      "link": [3, 3],
+      "name": "Gain Flash Suit (R-Mode Knockback Spark)",
+      "entranceCondition": {
+        "comeInWithRMode": {}
+      },
+      "requires": [
+        "f_DefeatedPhantoon",
+        {"or": [
+         {"and": [
+          {"disableEquipment": "ETank"},
+          {"resourceAvailable": [{"type": "Energy", "count": 80}]}
+        ]},
+        "h_CrystalFlash"
+      ]},
+	      "h_bombThings",
+        {"canShineCharge": {"usedTiles": 38, "openEnd": 1}},
+        "h_RModeKnockbackSpark"
+      ],
+      "note": [
+        "Disable E-tanks and with a full Reserve tank enter the room in R-Mode. Farm Energy from the first and if necessary, second Atomic closest to the right the door to put Energy into reserves.",
+        "Lure the third Atomic near the left door down toward samus and use it damage down if the first two Atomic's were used for farming, shooting the robot to move it back gives more runway.",
+        "Shinecharge and stop just before the Atomic, allow it to make contact with Samus while stationary, triggering the reserves and an R-Mode forced standup.",
+        "Frame perfectly press jump to shinespark and gain a flash suit. The Atomic will not move out of the way so as soon as Samus starts to turn blue",
+        "shinespark to kill it before i-frames run out and it kills Samus. Sparking too early will not gain a flashsuit."
+      ],
+      "devNote": "If E-tanks cannot be disabled, a crystalflash can be used to put energy into reserves."
     }
   ],
   "notables": [

tech.json

@@ -2333,6 +2333,32 @@
                 "Holding back and jump for more than 5 frames will cause Samus to spark horizontally. If the direction switch was exactly one frame late, Samus will land on the slope but no spark will occur."
               ]
             },
+            {
+              "name": "canRModeKnockbackSpark",
+              "techRequires": [
+                "canRMode",
+                "canCarryFlashSuit",
+                "canPreciseReserveRefill"
+              ],
+              "otherRequires": [
+                "SpeedBooster",
+                {"gainFlashSuit": {}}
+              ],
+              "note": [
+                "The ability to gain a flash suit without Morph by using enemy damage to trigger reserves and cause a forced standup.",
+                "After entering a room in R-Mode, farm enemies to add between 1-4 energy into the reserve tank.",
+                "Damage down until the next enemy contact will trigger reserves.",
+                "Shinecharge and get hit by an enemy while stationary.",
+                "Frame perfectly press jump to activate a shinespark on the last frame before the knockback timer expires, 4 frames after the enemy contact."
+              ],
+              "detailNote": [
+                "Pressing jump very early, before the enemy contact, will usually result in an interrupted shinespark resulting in a blue suit.",
+                "Pressing jump early, during the reserve refill (1 to 4 frames depending on reserve energy), will result in no shinespark.",
+                "Pressing jump 1 frame late likewise results in no shinespark.",
+                "Pressing jump 2 or more frames late will result in a vertical shinespark.",
+                "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."
+              ]
+            },
             {
               "id": 208,
               "name": "canComplexCarryFlashSuit",

tests/asserts/keywords.py

@@ -483,6 +483,10 @@ def process_req_speed_state(req, states, err_fn):
             states = {"blue"}
         elif req in ["h_flashSuitIceClip"]:
             states = {"preshinespark"}
+        elif req in ["h_RModeKnockbackSpark"]:
+            if not states.issubset(["shinecharging", "shinecharged"]):
+                err_fn(f"shinespark requirement while not in shinecharging/shinecharged/shinespark state: {req}")
+            states = {"shinespark"}
         elif req in ["canTemporaryBlue", "canChainTemporaryBlue", "canLongChainTemporaryBlue", "canSpeedball", "canXRayCancelShinecharge"]:
             if not states.issubset(["shinecharging", "blue"]):
                 err_fn(f"{req} while not in blue state")