feedback updates

Author: blkerby

logicalRequirements.md

@@ -7,6 +7,7 @@ A logical requirement is an array of logical elements, which are implicitly link
 * _The name of a tech._ Techs are defined in [tech.json](tech.json).  Those represent a technique that players can perform, which may also imply logical requirements of their own. By convention, a tech's name should start with `can`.
 * _The name of an item._ Those are defined in [items.json](items.json).
 * _The name of a game flag._ Those are defined in [items.json](items.json), and are used to represent game events such as defeating a boss, or breaking the Maridia tube. By convention, a game flag's name should start with `f_`.
+* _"free"._ This indicates a logical element that is automatically fulfilled.
 * _"never"._ This indicates a logical element that cannot be fulfilled under any conditions.
 * More complex elements which will be defined in their own sub-sections
 
@@ -658,8 +659,8 @@ __Example:__
 A `ridleyKill` requirement represents the need to kill Ridley, including ammo and energy requirements depending on the player's assumed skill level and available items. The expected duration of the fight can be estimated based on the following assumptions:
 - Supers can be used once every 0.5 seconds.
 - Missiles can be used once every 0.34 seconds.
-- Power Bombs can be used once every 3 seconds.
 - A charged beam shot can be used once every 1.4 seconds.
+- Power Bombs can be used once every 3 seconds.
 
 Heat frames are included based on the expected duration of the fight. Patience requirements `canBePatient`, `canBeVeryPatient`, and `canBeExtremelyPatient` are likewise also included. In both cases, a leniency multiplier should be applied to the time taken between shots. Leniency should also be applied based on the assumed accuracy rate of shots hitting Ridley successfully.
 
@@ -673,8 +674,8 @@ A `ridleyKill` requirement has the following optional properties which modify th
 - _stuck_: An enum with possible values "top" or "bottom", indicating the part of the room where Ridley gets stuck, allowing Samus to freely avoid damage from Ridley while inflicting damage to Ridley. If Ridley is stuck at the bottom of the room, then damage can be inflicted at a higher rate (not taking into account lag, which may be increased if a Crystal Flash is used in G-mode):
   - Supers can be used once every 0.34 seconds.
   - Missiles can be used once every 0.17 seconds.
-  - Power Bombs can be used once every 2.65 seconds.
   - A charged beam shot can be used once every 1.1 seconds.
+  - Power Bombs can be used once every 2.65 seconds, though because there is no known way to keep Ridley stuck while using Power Bombs, strats should set `powerBombs` to `false` when `stuck` is `true`.
 
 ### Other requirements
 

region/lowernorfair/east/Ridley's Room.json

@@ -407,6 +407,7 @@
       },
       "requires": [
         {"notable": "G-Mode Crystal Flash Stuck Ridley"},
+        "h_heatedGMode",
         "h_CrystalFlash",
         "h_usePowerBomb",
         {"or": [
@@ -430,7 +431,7 @@
           }}
         ]},
         {"autoReserveTrigger": {}},
-        {"heatFrames": 720},
+        {"heatFrames": 520},
         {"partialRefill": {"type": "Energy", "limit": 100}}
       ],
       "setsFlags": ["f_DefeatedRidley"],
@@ -456,9 +457,17 @@
       },
       "requires": [
         {"notable": "G-Mode Ridley with 30 Supers"},
+        "h_heatedGMode",
         {"heatFrames": 0},
         {"ammo": {"type": "Super", "count": 30}},
-        {"partialRefill": {"type": "Energy", "limit": 100}}
+        {"or": [
+          {"and": [
+            "canPauseAbuse",
+            {"resourceAtMost": [{"type": "Energy", "count": 1}]},
+            {"partialRefill": {"type": "Energy", "limit": 100}}
+          ]},
+          "free"
+        ]}
       ],
       "setsFlags": ["f_DefeatedRidley"],
       "note": [
@@ -467,11 +476,10 @@
         "As long as Ridley is swooping, not many fireballs will be placed, so delaying Ridley from pogoing can be helpful.",
         "Once Ridley begins pogoing, it generally becomes unsafe for Samus to jump high because of the risk of touching a fireball.",
         "By the end of the fight, projectiles will probably be overloaded, causing Ridley's drops not to spawn;",
-        "to solve this, exit G-mode just before drops spawn, and pause abuse in order to collect them."
+        "they can be collected by exiting G-mode just before drops spawn, and pause abusing if necessary."
       ],
       "devNote": [
-        "Leaving back through the open door while still in G-Mode can also be possible,",
-        "but the risk of hitting a fireball is probably too high for that to be reasonable."
+        "FIXME: Leaving back through the open door while still in G-Mode is also possible, and free to do."
       ]
     },
     {
@@ -667,6 +675,7 @@
       },
       "requires": [
         {"notable": "G-Mode Crystal Flash Stuck Ridley"},
+        "h_heatedGMode",
         "h_CrystalFlash",
         "h_usePowerBomb",
         {"or": [
@@ -690,7 +699,7 @@
           }}
         ]},
         {"autoReserveTrigger": {}},
-        {"heatFrames": 720},
+        {"heatFrames": 520},
         {"partialRefill": {"type": "Energy", "limit": 100}}
       ],
       "setsFlags": ["f_DefeatedRidley"],
@@ -706,7 +715,7 @@
       ],
       "devNote": [
         "FIXME: artificial morph with direct G-mode is another option for laying a Power Bomb at the top of the room,",
-        "by landing on the door ledge on entry."
+        "by landing on the door ledge on entry (the Morph item would still be needed since the Crystal Flash forces Samus out of being morphed)."
       ]
     },
     {
@@ -720,9 +729,17 @@
       },
       "requires": [
         {"notable": "G-Mode Ridley with 30 Supers"},
+        "h_heatedGMode",
         {"heatFrames": 0},
         {"ammo": {"type": "Super", "count": 30}},
-        {"partialRefill": {"type": "Energy", "limit": 100}}
+        {"or": [
+          {"and": [
+            "canPauseAbuse",
+            {"resourceAtMost": [{"type": "Energy", "count": 1}]},
+            {"partialRefill": {"type": "Energy", "limit": 100}}
+          ]},
+          "free"
+        ]}
       ],
       "setsFlags": ["f_DefeatedRidley"],
       "note": [
@@ -731,8 +748,11 @@
         "As long as Ridley is swooping, not many fireballs will be placed, so delaying Ridley from pogoing can be helpful.",
         "Once Ridley begins pogoing, it generally becomes unsafe for Samus to jump high because of the risk of touching a fireball.",
         "By the end of the fight, projectiles will probably be overloaded, causing Ridley's drops not to spawn;",
-        "to solve this, exit G-mode just before drops spawn, and pause abuse in order to collect them.",
-        "Leaving back through the open door while still in G-mode is also possible."
+        "they can be collected by exiting G-mode just before drops spawn, and pause abusing if necessary."
+      ],
+      "devNote": [
+        "FIXME: Leaving back through the open door while still in G-Mode is also possible,",
+        "but difficult to do without touching an invisible fireball."
       ]
     },
     {
@@ -857,7 +877,7 @@
       "id": 2,
       "name": "G-Mode Crystal Flash Stuck Ridley",
       "note": [
-        "In G-mode, use a Crystal Flash and additional Power Bomb to get Ridley stuck at the bottom-left of the room.",
+        "In G-mode, use a Crystal Flash and an additional Power Bomb to get Ridley stuck in a corner of the room.",
         "To end the fight, exit G-mode by using damage from Ridley to trigger auto-reserves."
       ]
     },

tests/asserts/keywords.py

@@ -588,6 +588,7 @@ def check_speed_states(strat, err_fn):
 
 keywords["values"] = [
     "never",
+    "free",
     "spinjump"
 ]