Skip to content

ListenedEvent

Someone listened at a door, and either heard something or heard nothing.

Full documentation: ListenedEvent. Wire type: listened.

Default visibility: player

Message codes: exploration.listen.heard, exploration.listen.silent

JSON Schema

{
  "$defs": {
    "Visibility": {
      "description": "Who may see an event: the players, or only the referee.\n\nEvery event has one of these values, because in B/X the referee makes some rolls behind a screen. Filter\na log on it before you show anything to a player, or call\n`GameSession.view`, which builds the players' view and the referee's\nview for you. A narrator that plays the referee reads every event.\n\nA serialized event contains the lowercase value. The values stay fixed within a `schema_version`, the version\nstamp of the saved format.\n\nExamples:\n    ```python\n    from osrlib.core.events import DamageDealtEvent, HitPointsReportedEvent, Visibility\n\n    log = [\n        DamageDealtEvent(target_id=\"monster-0001\", amount=5),\n        HitPointsReportedEvent(target_id=\"monster-0001\", current_hp=2, max_hp=7),\n    ]\n    shown = [event.code for event in log if event.visibility is Visibility.PLAYER]\n    assert shown == [\"combat.damage.dealt\"]  # the goblin's remaining hit points stay hidden\n    ```",
      "enum": [
        "player",
        "referee"
      ],
      "title": "Visibility",
      "type": "string"
    }
  },
  "description": "Someone listened at a door, and either heard something or heard nothing.\n\nEmitted by `ListenAtDoor`, after the\nreferee-visibility `DetectionRolledEvent`\nthat reports the die.\n\n`exploration.listen.heard` means the listener heard monsters in the area past the\ndoor. When the party later meets those monsters, it can't be surprised.\n\n`exploration.listen.silent` gives the party no information about what is there. Undead\nmake no noise, and the session rolls the die whether or not anything is on the other\nside. Show it as \"nothing heard\", not as a sign that the way is clear.",
  "properties": {
    "code": {
      "title": "Code",
      "type": "string",
      "description": "What happened, like `combat.attack.hit`: two or more lowercase parts separated by dots. The first part is\nthe area of the rules the event comes from, like `combat` or `magic`.\n\nBranch on it, and pass the event to `format_message` to turn it into English.\nBuilding an event with a code in any other format raises a pydantic `ValidationError`."
    },
    "visibility": {
      "$ref": "#/$defs/Visibility",
      "default": "player",
      "description": "Player visibility: what a character heard is theirs to know, while the die behind it is\nnot."
    },
    "event_type": {
      "const": "listened",
      "default": "listened",
      "title": "Event Type",
      "type": "string",
      "description": "The event type, `listened`, which identifies this class in serialized form."
    },
    "character_id": {
      "title": "Character Id",
      "type": "string",
      "description": "The member who listened."
    },
    "direction": {
      "title": "Direction",
      "type": "string",
      "description": "The side of the party's cell that was listened at, as a lowercase\n`Direction` value."
    }
  },
  "required": [
    "code",
    "character_id",
    "direction"
  ],
  "title": "ListenedEvent",
  "type": "object"
}