Merge pull request #1790 from blkerby/door-closing-animation

Add isDoorImmediatelyClosed property

Author: kjbranch

region/brinstar/green/Green Brinstar Main Shaft.json

@@ -100,10 +100,9 @@
       "nodeAddress": "0x0018d06",
       "doorOrientation": "left",
       "doorEnvironments": [{"physics": "air"}],
-      "spawnAt": 9,
+      "isDoorImmediatelyClosed": true,
       "devNote": [
-        "When entering this room in direct g-mode, the door is closed because of it being placed on the wrong location.",
-        "The spawn at node here to its self, is to document that you can not return back to the left without exiting g-mode."
+        "This door has a closing animation but it is wrongly placed a screen to the left."
       ]
     },
     {

region/brinstar/pink/Pink Brinstar Power Bomb Room.json

@@ -15,6 +15,7 @@
       "nodeAddress": "0x0018e62",
       "doorOrientation": "right",
       "doorEnvironments": [{"physics": "air"}],
+      "isDoorImmediatelyClosed": true,
       "locks": [
         {
           "name": "Mission Impossible Gray Lock (to Big Pink Upper)",

region/maridia/inner-pink/Halfie Climb Room.json

@@ -56,7 +56,8 @@
       "nodeSubType": "blue",
       "nodeAddress": "0x001a8e8",
       "doorOrientation": "right",
-      "doorEnvironments": [{"physics": "air"}]
+      "doorEnvironments": [{"physics": "air"}],
+      "isDoorImmediatelyClosed": true
     }
   ],
   "enemies": [

region/region-readme.md

@@ -47,6 +47,10 @@ Door environments are mandatory on door nodes (except elevators). They are forbi
 
 By default every door node has an implicit strat from the node to itself, for [unlocking the door](../strats.md#implicit-unlock-strats) in a standard way. This can be disabled by setting the node property `useImplicitDoorUnlocks` to false.
 
+#### isDoorImmediatelyClosed
+
+Most doors have a closing animation that occurs when entering through them. However, certain doors are immediately closed when the room is loaded. When entering through such a door in direct G-mode, the door will be closed, making it not possible to return back through the door without first exiting G-mode. It would also not be possible to get stuck inside the door shell using an X-ray climb setup.
+
 #### spawnAt
 The `spawnAt` property is used to represent situations where Samus enters a room via a node, but can quickly end up at another node without user input. This is only relevant in situations where there are requirements for getting back to the door Samus entered through. When a node has a `null` value for this property, Samus simply spawns at that node as normal.
 

schema/m3-room.schema.json

@@ -1593,6 +1593,11 @@
             "default": true,
             "description": "Whether a standard strat should implicitly be included for unlocking this node if it is a door node."
           },
+          "isDoorImmediatelyClosed": {
+            "type": "boolean",
+            "default": false,
+            "description": "Whether this door is immediately closed on entry, rather than having a closing animation."
+          },
           "spawnAt": {
             "type": "integer",
             "title": "Node to spawn at",