Remove nodesToAvoid, mustStayPut

Author: kjbranch

logicalRequirements.md

@@ -557,14 +557,10 @@ __Example:__
 #### resetRoom object
 A `resetRoom` object represents the need for the room to be in an initial state in order to perform a strat. A `resetRoom` object can have the following properties:
 * _nodes:_ An array containing the in-room ID of nodes at which entering the room can work.
-* _nodesToAvoid:_ An array containing the in-room ID of nodes that Samus must not visit after resetting the room. If any of those nodes have to be visited, the `resetRoom` object cannot be fulfilled, regardless of where Samus entered the room.
-* _mustStayPut:_ This property is mutually exclusive with `nodesToAvoid` and is only meaningful for `resetRoom` objects whose only `nodes` is the one they are at. If it is present and `true`, it is equivalent to having a `nodesToAvoid` property containing all other nodes in the room.
 
 In order to fulfill a `resetRoom` object, Samus must be able to do all of the following:
 * Enter the room at one of the listed `nodes`
 * Reach the node where the logic contains the `resetRoom` object
-  * If `mustStayPut` is true, Samus should be entering the room at the correct node and staying there
-* Do this while visiting none of the listed `nodesToAvoid`. However, it's ok if a node to avoid ends up being visited directly afterwards, as a result of fulfilling the `resetRoom` object.
 * If Samus is already in the room and has done one of the actions to avoid, she must be able to exit at one of the listed `nodes` and re-enter, following all other rules.
   * Please note that if fulfilling a `resetRoom` object involves exiting and re-entering, it will indeed reset the room and cause all obstacles to respawn.
 

region/brinstar/pink/Big Pink.json

@@ -1139,12 +1139,7 @@
         "canXRayClimb"
       ],
       "flashSuitChecked": true,
-      "note": "Climb up 1 screen.",
-      "devNote": [
-        "Normally, an XRayClimb's resetRoom has mustStayPut true, but because node 5 is configured to spawn at 14, Samus will be expected to visit 14 before 5 when setting up.",
-        "This is a technicality based on the spawnAt at 14, since in reality Samus just gets doorstuck at 5 immediately in this scenario.",
-        "It's also possible to X-Ray Climb to 13, but that's reachable for free just by falling down the crumble blocks anyway."
-      ]
+      "note": "Climb up 1 screen."
     },
     {
       "id": 41,

region/crateria/west/Green Pirates Shaft.json

@@ -1337,16 +1337,9 @@
           "hits": 9,
           "type": "contact"
         }},
-        {"or": [
-          {"resetRoom": {
-            "nodes": [1, 2, 3, 4],
-            "nodesToAvoid": [5]
-          }},
-          {"resetRoom": {
-            "nodes": [1, 2, 3, 4],
-            "nodesToAvoid": [6]
-          }}
-        ]}
+        {"resetRoom": {
+          "nodes": [2, 3, 4]
+        }}
       ],
       "flashSuitChecked": true,
       "note": [

region/maridia/outer/Mt. Everest.json

@@ -1862,8 +1862,7 @@
         "canTrickyUseFrozenEnemies",
         {"or": [
           {"resetRoom": {
-            "nodes": [3],
-            "mustStayPut": true
+            "nodes": [3]
           }},
           "canPrepareForNextRoom"
         ]},

region/norfair/east/Volcano Room.json

@@ -241,12 +241,10 @@
       "id": 8,
       "link": [2, 2],
       "name": "Leave with Runway",
-      "requires": [
-        {"resetRoom": {
-          "nodes": [2],
-          "mustStayPut": true
-        }}
-      ],
+      "entranceCondition": {
+        "comeInNormally": {}
+      },
+      "requires": [],
       "exitCondition": {
         "leaveWithRunway": {
           "length": 6,

schema/m3-requirements.schema.json

@@ -862,24 +862,6 @@
                   "title": "Node ID",
                   "description": "The in-room ID of a node."
                 }
-              },
-              "nodesToAvoid": {
-                "$id": "#/definitions/logicalRequirement/items/properties/resetRoom/properties/nodesToAvoid",
-                "type": "array",
-                "title": "Nodes to Avoid",
-                "description": "The list of nodes that must not have been visited since entering the room in order to fulfill this logical element.",
-                "items": {
-                  "$id": "#/definitions/logicalRequirement/items/properties/resetRoom/properties/nodesToAvoid/items",
-                  "type": "integer",
-                  "title": "Node ID",
-                  "description": "The in-room ID of a node."
-                }
-              },
-              "mustStayPut": {
-                "$id": "#/definitions/logicalRequirement/items/properties/resetRoom/properties/mustStayPut",
-                "type": "boolean",
-                "title": "Must Stay Put",
-                "description": "Indicates that no other node but the entry node may be visited in order to fulfill this logical element. Must not be defined when it is intended to be false, unless there are no nodes or obstacles to avoid."
               }
             }
           },

tests/asserts/keywords.py

@@ -641,7 +641,6 @@ def process_strats(src, paramData):
                             "fromNodes.",
                             "inRoomPath.",
                             "resetRoom.nodes.",
-                            "nodesToAvoid.",
                             "itemNotCollectedAtNode"
                         ],
                         "room",