CloseDoor

Close an open door on one side of the party's cell (zero time).

Full documentation: CloseDoor. Wire type: close_door.

Legal session modes: exploring

JSON Schema

{
  "$defs": {
    "Direction": {
      "description": "The four grid directions the party faces and moves in.\n\nThis is the direction vocabulary the whole crawl uses: which way\n`MoveParty` steps, which side of a cell\n`OpenDoor` works on, which way a transition faces the party on\narrival. There is no up or down here. Between levels is a\n`TransitionSpec`.\n\nThe wire values are lowercase and they serialize into commands, events, and saves, so changing\none is a `schema_version` bump.",
      "enum": [
        "north",
        "east",
        "south",
        "west"
      ],
      "title": "Direction",
      "type": "string"
    }
  },
  "description": "Close an open door on one side of the party's cell (zero time).\n\nThe party must be exploring a dungeon (see\n`EnterDungeon`).\n\nModes:\n    `exploring`\n\nRejections:\n    - `session.command.wrong_mode` - the session is not exploring a dungeon.\n    - `exploration.door.no_door` - no known door on that side of the cell.\n    - `exploration.door.already_closed` - the door is already closed.\n    - `exploration.door.wedged` - a wedged door cannot swing.\n\nEvents:\n    `DoorEvent` with code\n    `exploration.door.closed`.",
  "properties": {
    "command_type": {
      "const": "close_door",
      "default": "close_door",
      "title": "Command Type",
      "type": "string",
      "description": "The wire discriminator. Each subclass fixes it to its own snake_case literal, like\n`\"move_party\"` or `\"open_door\"`, so you never set it yourself: constructing the subclass\ndoes. It's what `parse_command` and the\n`AnyCommand` union read to rebuild the right class\nfrom a serialized mapping, and it stays the same across releases."
    },
    "source": {
      "anyOf": [
        {
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Source",
      "description": "An annotation naming the authored object (a trigger or quest id) or the game\nsystem on whose behalf the command was issued. Execution never reads it: a stamped\ncommand does exactly what the same command unstamped does. It is logged and replayed\nwith the command, so the log alone answers \"why did this happen\". Absent is `None`,\nand the empty string is not a value."
    },
    "direction": {
      "$ref": "#/$defs/Direction",
      "description": "Which side of the party's cell the door is on. Only a door the party can see counts, so\nthis is one of the `door` edges in\n`ExploredLevelView.edges`. A wedged door\nwon't swing, so pull the spike before you close it."
    }
  },
  "required": [
    "direction"
  ],
  "title": "CloseDoor",
  "type": "object"
}