Skip to content

ForceDoor

Force a stuck door open with one member's STR-based open-doors roll (takes no game time).

Full documentation: ForceDoor. Wire type: force_door.

Legal session modes: exploring

JSON Schema

{
  "$defs": {
    "Direction": {
      "description": "The four grid directions the party faces and moves in.\n\nYou use these for the way `MoveParty` steps, the side of a\ncell `OpenDoor` works on, and the way a transition turns the\nparty on arrival. There is no up or down. A\n`TransitionSpec` moves the party between levels.\n\nThe values are lowercase strings, like `\"north\"`, and they appear in commands, events, and saves.",
      "enum": [
        "north",
        "east",
        "south",
        "west"
      ],
      "title": "Direction",
      "type": "string"
    }
  },
  "description": "Force a stuck door open with one member's STR-based open-doors roll (takes no game time).\n\nThe party must be exploring a dungeon (see\n`EnterDungeon`). Every attempt makes noise, so\nthe next wandering-monster check gets the noise bonus. A failed attempt also alerts the\narea beyond the door, so its monsters can't be surprised when the party meets them\nthere. A door that gives way counts as opened: each room trap that triggers on `open`\nin the area on either side gets its 2-in-6 chance to spring, unless the party has found\nit. The trap springs on the member who forced the door, or on the next member standing\nif an earlier spring killed them.\n\nModes:\n    `exploring`\n\nRejections:\n    - `session.command.wrong_mode` - the session is not exploring a dungeon.\n    - `session.command.unknown_member` - `character_id` matches no party member.\n    - `session.command.member_incapacitated` - the member cannot act.\n    - `exploration.door.no_door` - no known door on that side of the cell.\n    - `exploration.door.already_open` - the door already stands open.\n    - `exploration.door.locked` - the door is locked, and forcing doesn't open a\n      lock. Pick it with `PickLock` first.\n    - `exploration.door.not_stuck` - the door isn't stuck. Open it with\n      `OpenDoor`.\n    - `exploration.door.gate_refused` - the door has an authored\n      condition (`GateSpec`) the party doesn't\n      meet. The session checks the gate before the attempt, so a refused attempt\n      makes no noise, alerts nobody, and costs no roll.\n\nEvents:\n    `ItemConsumedEvent` first when\n    the gate takes an item as a toll, then\n    `DoorEvent` with code\n    `exploration.door.forced` on success, which includes the gate's success text\n    when its author wrote one, or `exploration.door.stuck` on failure. A door that\n    gives way is followed by the trap events of each door trap's spring check, as\n    for `OpenDoor`.",
  "properties": {
    "command_type": {
      "const": "force_door",
      "default": "force_door",
      "title": "Command Type",
      "type": "string",
      "description": "The name that identifies the command class in serialized data. Each command class fixes\nit to a distinct snake_case string, like `\"move_party\"` or `\"open_door\"`, and constructing\nthe class sets it, so you never pass it yourself.\n`parse_command` and the\n`AnyCommand` union use it to rebuild the right class\nfrom a serialized mapping. A class's value never changes between releases."
    },
    "source": {
      "anyOf": [
        {
          "minLength": 1,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Source",
      "description": "Who or what issued the command on whose behalf: an authored trigger or quest id, or the\nname of one of your game's systems. The engine never reads it, so a command with a\n`source` does exactly what the same command without one does. The session logs and\nreplays it with the command, so the log alone shows why something happened. Leave it\n`None` when there's nothing to record. An empty string fails validation when the command\nis constructed."
    },
    "direction": {
      "$ref": "#/$defs/Direction",
      "description": "Which side of the party's cell the stuck door is on, from the `door` edges in\n`ExploredLevelView.edges`. The session refuses a door\nthat isn't stuck with `exploration.door.not_stuck`. Open that one with\n`OpenDoor`, which makes no noise."
    },
    "character_id": {
      "title": "Character Id",
      "type": "string",
      "description": "The member who tries to force the door, by\n`MemberView.id`. The member's STR sets the open-doors\nchance, so send the strongest member. If the door gives way, a door trap the party hasn't\nfound springs on this member."
    }
  },
  "required": [
    "direction",
    "character_id"
  ],
  "title": "ForceDoor",
  "type": "object"
}