Merge pull request #2132 from blkerby/simple-frames

simpleHeatFrames and simpleCycleFrames

Author: osse101

logicalRequirements.md

@@ -206,13 +206,18 @@ __Example:__
 ```
 
 #### cycleFrames object
-A `cycleFrames` object represents the need for Samus to spend time (measured as an amount of in-game frames) in a room as part of a farming cycle. Including a `cycleFrames` requirement is mandatory in farming strats with a [`farmCycleDrops`](strats.md#farm-cycle-drops) property. The `cycleFrames` can be used to determine how many cycles of a farm a player can reasonably be expected to perform, based on an assumed amount of "patience".
+A `cycleFrames` object represents the need for Samus to spend time (measured as an amount of in-game frames) in a room as part of a farming cycle. Including a `cycleFrames` requirement is mandatory in farming strats with a [`farmCycleDrops`](strats.md#farm-cycle-drops) property. The `cycleFrames` can be used to determine how many cycles of a farm a player can reasonably be expected to perform, based on an assumed amount of "patience". The frame counts listed tend to be somewhat optimized, so it recommended to apply a lenience factor based on difficulty.
 
 __Example:__
 ```json
 {"cycleFrames": 100}
 ```
 
+#### simpleCycleFrames object
+
+A `simpleCycleFrames` object represents the need for Samus to spend time (measured as an amount of in-game frames) in a room as part of a farming cycle. It is identical to `cycleFrames` except that the time spent in `simpleCycleFrames` is intended to be invariant, not affected by leniency. This can be useful in cases that involve doing something simple for a significant amount of time, such as standing in place while farming bugs.
+
+
 #### heatFrames object
 A `heatFrames` object represents the need for Samus to spend time (measured in frames) in a heated room. This is meant to be converted to a flat health value based on item loadout. The vanilla damage for heated rooms is 1 damage every 4 frames, negated by Varia or Gravity Suit. The effect of Gravity suit on heat damage may be modified by randomizers. A `heatFrames` object implicitly includes a requirement `{"or": ["h_heatProof", "canHeatRun"]}`.
 
@@ -223,7 +228,11 @@ __Example:__
 
 __Additional considerations__
 
-Much like the other logical elements that represent environmental frame damage, the heat frame counts listed in this project might not be strictly "perfect" play, but they are very much unforgiving. Their most significant value is to provide relative lengths to different heat runs. It's recommended to apply a leniency factor to those, possibly as an option that can vary by difficulty.
+Much like the other logical elements that represent environmental frame damage, the heat frame counts listed in this project might not be strictly "perfect" play, but they are very much unforgiving. Their most significant value is to provide relative lengths to different heat runs. It's recommended to apply a lenience factor to those, possibly as an option that can vary by difficulty.
+
+#### simpleHeatFrames object
+
+A `simpleHeatFrames` object represents the need for Samus to spend time (measured in frames) in a heated room. It is identical to `heatFrames` except that the time spent in `simpleHeatFrames` is intended to be invariant, not affected by leniency. This can be useful in cases that involve doing something simple for a significant amount of time, such as standing in place or running through a long hallway.
 
 #### heatFramesWithEnergyDrops object
 

region/crateria/east/West Ocean.json

@@ -2093,7 +2093,8 @@
       "link": [6, 6],
       "name": "Zeb Farm",
       "requires": [
-        {"cycleFrames": 105}        
+        {"simpleCycleFrames": 85},
+        {"cycleFrames": 20}
       ],
       "farmCycleDrops": [
         {"enemy": "Zeb", "count": 1}

region/norfair/east/Speed Booster Hall.json

@@ -176,7 +176,8 @@
       "name": "Base",
       "requires": [
         {"obstaclesNotCleared": ["A"]},
-        {"heatFrames": 650}
+        {"simpleHeatFrames": 560},
+        {"heatFrames": 60}
       ],
       "unlocksDoors": [
         {
@@ -192,7 +193,8 @@
       "name": "Leave with Runway",
       "requires": [
         {"obstaclesNotCleared": ["A"]},
-        {"heatFrames": 630}
+        {"simpleHeatFrames": 560},
+        {"heatFrames": 60}
       ],
       "exitCondition": {
         "leaveWithRunway": {
@@ -229,18 +231,20 @@
       "requires": [
         {"obstaclesNotCleared": ["A"]},
         "SpeedBooster",
-        {"heatFrames": 360}
+        {"simpleHeatFrames": 310},
+        {"heatFrames": 40}
       ],
       "clearsObstacles": ["A"]
     },
     {
       "id": 8,
       "link": [1, 2],
-      "name": "Speed Run and Leave Shinecharged",
+      "name": "Speed Run, Leave Shinecharged",
       "requires": [
         {"obstaclesNotCleared": ["A"]},
         "h_shinechargeMaxRunway",
-        {"heatFrames": 360},
+        {"simpleHeatFrames": 310},
+        {"heatFrames": 40},
         {"shineChargeFrames": 35}
       ],
       "exitCondition": {
@@ -255,12 +259,13 @@
     {
       "id": 9,
       "link": [1, 2],
-      "name": "Speed Run and Leave Running",
+      "name": "Speed Run, Leave With Runway",
       "requires": [
         {"obstaclesNotCleared": ["A"]},
         "SpeedBooster",
         "canHeroShot",
-        {"heatFrames": 290}
+        {"simpleHeatFrames": 250},
+        {"heatFrames": 40}
       ],
       "exitCondition": {
         "leaveWithRunway": {
@@ -285,10 +290,14 @@
       },
       "requires": [
         {"or": [
-          {"heatFrames": 650},
+          {"and": [
+            {"simpleHeatFrames": 560},
+            {"heatFrames": 60}
+          ]},
           {"and": [
             "SpeedBooster",
-            {"heatFrames": 360}
+            {"simpleHeatFrames": 310},
+            {"heatFrames": 40}
           ]}
         ]}
       ],
@@ -314,10 +323,14 @@
       },
       "requires": [
         {"or": [
-          {"heatFrames": 650},
+          {"and": [
+            {"simpleHeatFrames": 560},
+            {"heatFrames": 60}
+          ]},
           {"and": [
             "SpeedBooster",
-            {"heatFrames": 360}
+            {"simpleHeatFrames": 310},
+            {"heatFrames": 40}
           ]}
         ]}
       ],
@@ -396,7 +409,8 @@
       "name": "Base",
       "requires": [
         {"obstaclesNotCleared": ["A"]},
-        {"heatFrames": 650}
+        {"simpleHeatFrames": 560},
+        {"heatFrames": 60}
       ],
       "unlocksDoors": [
         {
@@ -451,7 +465,8 @@
       "name": "Leave with Runway",
       "requires": [
         {"obstaclesNotCleared": ["A"]},
-        {"heatFrames": 630}
+        {"simpleHeatFrames": 560},
+        {"heatFrames": 60}
       ],
       "exitCondition": {
         "leaveWithRunway": {
@@ -478,18 +493,20 @@
       "requires": [
         {"obstaclesNotCleared": ["A"]},
         "SpeedBooster",
-        {"heatFrames": 360}
+        {"simpleHeatFrames": 310},
+        {"heatFrames": 40}
       ],
       "clearsObstacles": ["A"]
     },
     {
       "id": 16,
       "link": [2, 1],
-      "name": "Speed Run and Leave Shinecharged",
+      "name": "Speed Run, Leave Shinecharged",
       "requires": [
         {"obstaclesNotCleared": ["A"]},
         "h_shinechargeMaxRunway",
-        {"heatFrames": 360},
+        {"simpleHeatFrames": 310},
+        {"heatFrames": 40},
         {"shineChargeFrames": 35}
       ],
       "exitCondition": {
@@ -504,12 +521,13 @@
     {
       "id": 17,
       "link": [2, 1],
-      "name": "Speed Run and Leave Running",
+      "name": "Speed Run, Leave With Runway",
       "requires": [
         {"obstaclesNotCleared": ["A"]},
         "SpeedBooster",
         "canHeroShot",
-        {"heatFrames": 290}
+        {"simpleHeatFrames": 250},
+        {"heatFrames": 40}
       ],
       "exitCondition": {
         "leaveWithRunway": {

schema/m3-requirements.schema.json

@@ -248,12 +248,24 @@
             "title": "Cycle Frames",
             "description": "Fulfilled by spending an amount of time in a room, measured in in-game frames, as part of a farming cycle."
           },
+          "simpleCycleFrames": {
+            "type": "integer",
+            "minimum": 0,
+            "title": "Cycle Frames",
+            "description": "Fulfilled by spending an amount of time in a room, measured in in-game frames, as part of a farming cycle, doing a simple action that does not require lenience."
+          },
           "heatFrames": {
             "type": "integer",
             "minimum": 0,
             "title": "Heat Frames",
             "description": "Fulfilled by spending an amount of energy that corresponds to spending a number of frames in a heat room."
           },
+          "simpleHeatFrames": {
+            "type": "integer",
+            "minimum": 0,
+            "title": "Simple Heat Frames",
+            "description": "Fulfilled by spending an amount of energy that corresponds to spending a number of frames in a heat room, doing a simple action that does not require lenience."
+          },
           "heatFramesWithEnergyDrops": {
             "type": "object",
             "title": "Heat Frames With Energy Drops",