Merge branch 'master' into norfair-remote-runway-1

Author: blkerby

helpers.json

@@ -385,6 +385,13 @@
           ],
           "devNote": "1 Power bomb leniency per attempt, 9 leniency attempts."
         },
+        {
+          "name": "h_CrystalSparkLeniency",
+          "requires": [
+            {"ammo": {"type": "PowerBomb","count": 8}}
+          ],
+          "devNote": "1 Power Bomb leniency per attempt, 8 leniency attempts."
+        },
         {
           "name": "h_ElevatorCrystalFlashLeniency",
           "requires": [
@@ -1021,6 +1028,23 @@
             {"partialRefill": {"type": "Energy", "limit": 1500}}
           ]
         },
+        {
+          "name": "h_CrystalSpark",
+          "requires": [
+            {"tech": "canCrystalSpark"},
+            "canMidAirMorph",
+            "h_CrystalFlash",
+            "h_CrystalSparkLeniency",
+            {"gainBlueSuit": {}}
+          ]
+        },
+        {
+          "name": "h_heatedCrystalSpark",
+          "requires": [
+            "h_heatProof",
+            "h_CrystalSpark"
+          ]
+        },
         {
           "name": "h_elevatorCrystalFlash",
           "requires": [
@@ -1545,6 +1569,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

@@ -127,6 +127,8 @@ A `shinespark` object represents the need for Samus to spend energy performing a
 * _frames_: The duration of the shinespark in frames, assuming the spark is completed without being interrupted by reaching 29 energy. The shinespark frames equals the amount of energy spent, as a shinespark uses 1 energy per frame. 
 * _excessFrames_: The shinespark duration (in frames) that is not required to complete the objective of the shinespark. Subtracting this from the `frames` defines the lower limit of the shinespark energy cost.
 
+A `shinespark` requirement causes a blue suit to be lost.
+
 #### acidFrames object
 An `acidFrames` object represents the need for Samus to spend time (measured in frames) in a pool of acid. This is meant to be converted to a flat health value based on item loadout. The vanilla damage for acid is 6 damage every 4 frames, halved by Varia (3 damage every 4 frames), and halved again by Gravity Suit (3 damage every 8 frames).
 
@@ -516,13 +518,12 @@ __Example:__
 
 __Additional considerations__
 
-* A `canShineCharge` object implicitly requires the Speed Booster. Energy requirements for the shinespark (if applicable) are specified separately using a `shinespark` object. A `canShineCharge` requirement causes a flash suit to be lost.
+* A `canShineCharge` object implicitly requires the Speed Booster item and `canDash` tech. Energy requirements for the shinespark (if applicable) are specified separately using a `shinespark` object. A `canShineCharge` requirement causes a loss of any flash suit or blue suit.
 
 #### getBlueSpeed object
 
-A `getBlueSpeed` object represents the need for Samus to be able to gain blue speed using a specified runway. It is very similar to `canShineCharge`, including the same set of properties, except that `getBlueSpeed` does not involve crouching to enter a shinecharge state for performing a shinespark. Instead, `getBlueSpeed` involves using the blue speed directly, such as to destroy enemies, bomb blocks, or Speed blocks.
+A `getBlueSpeed` object represents the need for Samus to be able to gain blue speed using a specified runway. It is very similar to `canShineCharge`, including the same set of properties and the same implicit requirements, except that `getBlueSpeed` does not result in the loss of flash suit (it does still result in loss of blue suit). Instead of crouching to enter a shinecharge state for performing a shinespark, `getBlueSpeed` involves using the blue speed directly, such as to destroy enemies, bomb blocks, or Speed blocks.
 
-Note that a `getBlueSpeed` requirement is compatible with preserving a flash suit, while `canShinecharge` is not.
 
 __Example:__
 ```json
@@ -534,10 +535,9 @@ __Example:__
 }},
 ```
 
-
 #### speedBall object
 
-A `speedBall` object represents the need for Samus to be able to gain blue speed and jump into a speedball using a specified runway. It includes a `canSpeedball` tech requirement. Whether a speedball can performed within a given runway length depends on the player's ability to shortcharge as well as to perform a short-hop mockball. The [blue run speed table](strats.md#blue-run-speed-table) describes several tiers of shortcharging skill, their associated runway lengths over which blue speed can be attained, and the resulting run speed. For determining whether a speedball is logically possible, the lowest run speed should be used within the range of what is possible for that skill level; this corresponds to using the "Ideal speed" from the table. The total runway length required can then be computed as follows:
+A `speedBall` object represents the need for Samus to be able to gain blue speed and jump into a speedball using a specified runway. It includes a `canSpeedball` requirement. Whether a speedball can performed within a given runway length depends on the player's ability to shortcharge as well as to perform a short-hop mockball. The [blue run speed table](strats.md#blue-run-speed-table) describes several tiers of shortcharging skill, their associated runway lengths over which blue speed can be attained, and the resulting run speed. For determining whether a speedball is logically possible, the lowest run speed should be used within the range of what is possible for that skill level; this corresponds to using the "Ideal speed" from the table. The total runway length required can then be computed as follows:
 
 $$\text{minimum speedball runway} = \text{minimal blue speed runway} + \text{short-hop mockball frames} * \text{mid-air speed}$$
 
@@ -677,6 +677,52 @@ __Example:__
 {"noFlashSuit": {}}
 ```
 
+#### gainBlueSuit object
+
+A `gainBlueSuit` object represents that Samus gains a blue suit as part of executing this strat. A blue suit is a special state in which Samus remains blue indefinitely, being able to pass through and destroy bomb blocks, Speed blocks, and most enemies. This state can potentially be carried to distant rooms from where the blue suit was gained. 
+
+A `gainBlueSuit` object has no properties.
+
+With certain exceptions explained below, a blue suit can generally be carried around by any sequence of strats until some action is taken which would cause the blue suit to be lost. The need to perform actions that cannot preserve a blue suit are indicated by a `noBlueSuit` logical requirement; typically this is expressed indirectly through tech or helpers, most notably `canDash`.
+
+The process of verifying which strats allow preserving a blue suit is not yet complete. Strats which have been checked are indicated by a property `"blueSuitChecked": true`. Any strat without this property should be assumed to be logically unusable for carrying a blue suit, as though the strat had an extra requirement `{"noBlueSuit": {}}` appended. Note that a strat with `"blueSuitChecked": true` may or may not be able to preserve a blue suit, depending on its logical requirements.
+
+__Example:__
+```json
+{"gainBlueSuit": {}}
+```
+
+#### haveBlueSuit object
+
+A `haveBlueSuit` indicates a need to have a blue suit. This does not consume the blue suit.
+
+__Example:__
+```json
+{"haveBlueSuit": {}}
+```
+
+#### blueSuitShinecharge object
+
+A `blueSuitShinecharge` indicates a need to have a blue suit, in order to perform a shinecharge. A strat with `blueSuitShinecharge` should have a subsequent `shinespark` logical requirement to specify the energy loss from shinesparking, and the `shinespark` requirement will result in the loss of the blue suit.
+
+A `blueSuitShinecharge` object has no properties.
+
+__Example:__
+```json
+{"blueSuitShinecharge": {}}
+```
+
+#### noBlueSuit
+
+A `noBlueSuit` indicates a need to perform actions that are incompatible with preserving a blue suit; it therefore requires that Samus not be in a blue suit state.
+
+A `noBlueSuit` object has no properties.
+
+__Example:__
+```json
+{"noBlueSuit": {}}
+```
+
 ### Boss requirements
 
 #### Ridley kill
@@ -730,3 +776,7 @@ __Example:__
 ```json
 {"disableEquipment": "HiJump"}
 ```
+
+While carrying a blue suit, disabling Speed Booster would result in a loss of the blue suit.
+
+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/brinstar/pink/Spore Spawn Farming Room.json

@@ -84,7 +84,8 @@
         {"cycleFrames": 20}
       ],
       "farmCycleDrops": [{"enemy": "Zeb", "count": 1}],
-      "flashSuitChecked": true
+      "flashSuitChecked": true,
+      "blueSuitChecked": true
     },
     {
       "id": 19,
@@ -96,6 +97,7 @@
       ],
       "farmCycleDrops": [{"enemy": "Zeb", "count": 2}],
       "flashSuitChecked": true,
+      "blueSuitChecked": true,
       "note": [
         "Jump back and forth between the left two bug pipes to farm them simultaneously."
       ],
@@ -115,7 +117,8 @@
           "steepUpTiles": 2
         }
       },
-      "flashSuitChecked": true
+      "flashSuitChecked": true,
+      "blueSuitChecked": true
     },
     {
       "id": 3,
@@ -130,6 +133,7 @@
         "leaveShinecharged": {}
       },
       "flashSuitChecked": true,
+      "blueSuitChecked": true,
       "note": [
         "Stand to the right of the right-most bug pipe, and run to the right to gain a shortcharge.",
         "Run back to the left, jump over the bug pipes with one jump, and exit through the left door."
@@ -149,6 +153,7 @@
         "leaveShinecharged": {}
       },
       "flashSuitChecked": true,
+      "blueSuitChecked": true,
       "note": [
         "Stand to the right of the right-most bug pipe, and run to the right to gain a shortcharge.",
         "Run back to the left, Space Jump over the bug pipes, and exit through the left door."
@@ -167,6 +172,7 @@
         "leaveWithSpark": {}
       },
       "flashSuitChecked": true,
+      "blueSuitChecked": true,
       "note": [
         "Stand to the right of the right-most bug pipe, and run to the right to gain a shortcharge.",
         "Run back to the left, jump over the bug pipes, and shinespark through the left door."
@@ -188,6 +194,7 @@
         }
       },
       "flashSuitChecked": true,
+      "blueSuitChecked": true,
       "devNote": "A variation with 1 more runway tile could be added for if the door at node 2 is unlocked, and the same for the other remote runway strats."
     },
     {
@@ -208,7 +215,8 @@
           "minExtraRunSpeed": "$1.6"
         }
       },
-      "flashSuitChecked": true
+      "flashSuitChecked": true,
+      "blueSuitChecked": true
     },
     {
       "id": 8,
@@ -223,7 +231,8 @@
           }
         }
       },
-      "flashSuitChecked": true
+      "flashSuitChecked": true,
+      "blueSuitChecked": true
     },
     {
       "id": 9,
@@ -236,7 +245,8 @@
       "exitCondition": {
         "leaveWithTemporaryBlue": {}
       },
-      "flashSuitChecked": true
+      "flashSuitChecked": true,
+      "blueSuitChecked": true
     },
     {
       "id": 10,
@@ -246,21 +256,35 @@
       "exitCondition": {
         "leaveWithGModeSetup": {}
       },
-      "flashSuitChecked": true
+      "flashSuitChecked": true,
+      "blueSuitChecked": true
+    },
+    {
+      "link": [1, 1],
+      "name": "Gain Blue Suit (R-Mode Spark Interrupt)",
+      "entranceCondition": {
+        "comeInWithRMode": {}
+      },
+      "requires": [
+        {"canShineCharge": {"usedTiles": 21, "steepUpTiles": 2, "openEnd": 0}},        
+        "canRModeSparkInterrupt"
+      ]
     },
     {
       "id": 11,
       "link": [1, 2],
       "name": "Base",
       "requires": [],
-      "flashSuitChecked": true
+      "flashSuitChecked": true,
+      "blueSuitChecked": true
     },
     {
       "id": 12,
       "link": [2, 1],
       "name": "Base",
       "requires": [],
-      "flashSuitChecked": true
+      "flashSuitChecked": true,
+      "blueSuitChecked": true
     },
     {
       "id": 13,
@@ -273,7 +297,8 @@
       },
       "requires": [],
       "bypassesDoorShell": true,
-      "flashSuitChecked": true
+      "flashSuitChecked": true,
+      "blueSuitChecked": true
     },
     {
       "id": 14,
@@ -291,7 +316,8 @@
         }
       },
       "bypassesDoorShell": true,
-      "flashSuitChecked": true
+      "flashSuitChecked": true,
+      "blueSuitChecked": true
     },
     {
       "id": 15,
@@ -309,7 +335,8 @@
         }
       },
       "bypassesDoorShell": true,
-      "flashSuitChecked": true
+      "flashSuitChecked": true,
+      "blueSuitChecked": true
     },
     {
       "id": 18,
@@ -341,6 +368,7 @@
       },
       "bypassesDoorShell": true,
       "flashSuitChecked": true,
+      "blueSuitChecked": true,
       "note": [
         "Build up to full run speed and speedball towards the left door.",
         "With a little luck, Samus will accelerate through the slope tiles and pass under the door."
@@ -358,7 +386,8 @@
           "steepUpTiles": 2
         }
       },
-      "flashSuitChecked": true
+      "flashSuitChecked": true,
+      "blueSuitChecked": true
     },
     {
       "id": 17,
@@ -368,7 +397,8 @@
       "exitCondition": {
         "leaveWithGModeSetup": {}
       },
-      "flashSuitChecked": true
+      "flashSuitChecked": true,
+      "blueSuitChecked": true
     },
     {
       "id": 20,
@@ -387,6 +417,8 @@
         "canSlopeSpark",
         {"shinespark": {"frames": 4, "excessFrames": 4}}
       ],
+      "flashSuitChecked": true,
+      "blueSuitChecked": true,
       "note": [
         "After shinecharging, lure a Zeb and use it to slopespark on the first slope right of the pipe."
       ],
@@ -411,12 +443,37 @@
           "position": "bottom"
         }
       },
+      "flashSuitChecked": true,
+      "blueSuitChecked": true,
       "note": [
         "After shinecharging, lure a Zeb and use it to slopespark on the first slope right of the pipe."
       ],
       "devNote": [
         "No leniency is given as this is a farm room and the Zebs do little damage, even suitless."
       ]
+    },
+    {
+      "link": [2, 2],
+      "name": "Gain Blue Suit (R-Mode Spark Interrupt)",
+      "entranceCondition": {
+        "comeInWithRMode": {}
+      },
+      "requires": [
+        {"canShineCharge": {"usedTiles": 21, "steepUpTiles": 2, "openEnd": 0}},
+        "canRModeSparkInterrupt"
+      ],
+      "flashSuitChecked": true,
+      "blueSuitChecked": true
+    },
+    {
+      "link": [2, 2],
+      "name": "Gain Blue Suit (Crystal Spark)",
+      "requires": [
+        {"canShineCharge": {"usedTiles": 21, "steepUpTiles": 2, "openEnd": 0}},
+        "h_CrystalSpark"
+      ],
+      "flashSuitChecked": true,
+      "blueSuitChecked": true
     }
   ],
   "notables": [