ForceDoor

Force a stuck door: the character's STR open-doors check; noise is the cost.

Full documentation: ForceDoor. Wire type: force_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": "Force a stuck door: the character's STR open-doors check; noise is the cost.\n\nThe party must be exploring a dungeon (see\n[`EnterDungeon`][osrlib.crawl.commands.EnterDungeon]). Any attempt bangs on the\ndoor \u2014 the next wandering check takes the noise bonus \u2014 and a failed attempt\nalerts the room beyond, denying the party surprise there.\n\nModes:\n    `exploring`\n\nRejections:\n    - `session.command.wrong_mode` \u2014 the session is not exploring a dungeon.\n    - `session.command.unknown_member` \u2014 `character_id` names no party member.\n    - `session.command.member_incapacitated` \u2014 the member cannot act.\n    - `exploration.door.no_door` \u2014 no known door on that side of the cell.\n    - `exploration.door.already_open` \u2014 the door already stands open.\n    - `exploration.door.locked` \u2014 locked doors need\n      [`PickLock`][osrlib.crawl.commands.PickLock], not muscle.\n    - `exploration.door.not_stuck` \u2014 an unstuck door opens with\n      [`OpenDoor`][osrlib.crawl.commands.OpenDoor].\n\nEvents:\n    [`DoorEvent`][osrlib.crawl.events.DoorEvent] with code\n    `exploration.door.forced` on success or `exploration.door.stuck` on\n    failure.",
  "properties": {
    "command_type": {
      "const": "force_door",
      "default": "force_door",
      "title": "Command Type",
      "type": "string"
    },
    "direction": {
      "$ref": "#/$defs/Direction"
    },
    "character_id": {
      "title": "Character Id",
      "type": "string"
    }
  },
  "required": [
    "direction",
    "character_id"
  ],
  "title": "ForceDoor",
  "type": "object"
}