WedgeDoor

Wedge a door with an iron spike so it cannot swing shut (zero time).

Full documentation: WedgeDoor. Wire type: wedge_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": "Wedge a door with an iron spike so it cannot swing shut (zero time).\n\nThe party must be exploring a dungeon (see\n[`EnterDungeon`][osrlib.crawl.commands.EnterDungeon]). Any living member's\nspike serves; one iron spike is consumed.\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    - `exploration.door.wedged` \u2014 the door is already wedged.\n    - `exploration.door.no_spike` \u2014 no living member carries iron spikes.\n\nEvents:\n    [`DoorEvent`][osrlib.crawl.events.DoorEvent] with code\n    `exploration.door.wedged`.",
  "properties": {
    "command_type": {
      "const": "wedge_door",
      "default": "wedge_door",
      "title": "Command Type",
      "type": "string"
    },
    "direction": {
      "$ref": "#/$defs/Direction"
    }
  },
  "required": [
    "direction"
  ],
  "title": "WedgeDoor",
  "type": "object"
}