Skip to content

ListenAtDoor

Listen at a door: once per character per door, ever (zero time).

Full documentation: ListenAtDoor. Wire type: listen_at_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": "Listen at a door: once per character per door, ever (zero time).\n\nThe party must be exploring a dungeon (see\n[`EnterDungeon`][osrlib.crawl.commands.EnterDungeon]), and the listener needs\nlight (infravision suffices). Hearing occupants marks the party aware for the\nroom's eventual encounter.\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.action.requires_light` \u2014 the party is in the dark and the\n      listener lacks infravision.\n    - `exploration.listen.already_tried` \u2014 this character has already listened\n      at this door.\n\nEvents:\n    [`DetectionRolledEvent`][osrlib.crawl.events.DetectionRolledEvent] with the\n    roll, then [`ListenedEvent`][osrlib.crawl.events.ListenedEvent] with code\n    `exploration.listen.heard` or `exploration.listen.silent`.",
  "properties": {
    "command_type": {
      "const": "listen_at_door",
      "default": "listen_at_door",
      "title": "Command Type",
      "type": "string"
    },
    "direction": {
      "$ref": "#/$defs/Direction"
    },
    "character_id": {
      "title": "Character Id",
      "type": "string"
    }
  },
  "required": [
    "direction",
    "character_id"
  ],
  "title": "ListenAtDoor",
  "type": "object"
}