Skip to content

OpenDoor

Open an unstuck, unlocked door on one side of the party's cell (zero time).

Full documentation: OpenDoor. Wire type: open_door.

Legal session modes: exploring

JSON Schema

{
  "$defs": {
    "Direction": {
      "description": "The four grid directions.\n\nThe wire values are lowercase \u2014 they serialize into commands, events, and\nsaves; changing them is a `schema_version` bump.",
      "enum": [
        "north",
        "east",
        "south",
        "west"
      ],
      "title": "Direction",
      "type": "string"
    }
  },
  "description": "Open an unstuck, unlocked door on one side of the party's cell (zero time).\n\nThe party must be exploring a dungeon (see\n[`EnterDungeon`][osrlib.crawl.commands.EnterDungeon]). An undiscovered secret\ndoor rejects exactly like blank wall \u2014 commands never leak hidden geometry.\n\nModes:\n    `exploring`\n\nRejections:\n    - `session.command.wrong_mode` \u2014 the session is not exploring a dungeon.\n    - `exploration.door.no_door` \u2014 no known door on that side of the cell\n      (undiscovered secret doors included).\n    - `exploration.door.already_open` \u2014 the door already stands open.\n    - `exploration.door.locked` \u2014 the lock has not been picked or otherwise\n      undone.\n    - `exploration.door.stuck` \u2014 a stuck door needs\n      [`ForceDoor`][osrlib.crawl.commands.ForceDoor].\n\nEvents:\n    [`DoorEvent`][osrlib.crawl.events.DoorEvent] with code\n    `exploration.door.opened`.",
  "properties": {
    "command_type": {
      "const": "open_door",
      "default": "open_door",
      "title": "Command Type",
      "type": "string"
    },
    "direction": {
      "$ref": "#/$defs/Direction"
    }
  },
  "required": [
    "direction"
  ],
  "title": "OpenDoor",
  "type": "object"
}