Skip to content

WanderingCheckEvent

A wandering-monster check came due and the referee rolled for it.

Full documentation: WanderingCheckEvent. Wire type: wandering_check.

Default visibility: referee

Message codes: exploration.wandering.checked

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": "A wandering-monster check came due and the referee rolled for it.\n\nEmitted by `wandering_check`, which the\nsession runs every few turns while it's in `exploring` mode (see\n`wandering_interval`). Any command that\npasses those turns can emit it, most often\n`MoveParty` or\n`Rest`. When the check hits, the encounter opens in\nthe same result, and the command passes no more time.\n\nIt has referee visibility because the party can't know a check was made. It knows\nonly what it meets.",
  "properties": {
    "code": {
      "default": "exploration.wandering.checked",
      "title": "Code",
      "type": "string",
      "description": "The message code, always `exploration.wandering.checked`."
    },
    "visibility": {
      "$ref": "#/$defs/Visibility",
      "default": "referee",
      "description": "Referee visibility: the referee makes the check in secret, and the party sees only what it produces."
    },
    "event_type": {
      "const": "wandering_check",
      "default": "wandering_check",
      "title": "Event Type",
      "type": "string",
      "description": "The event type, `wandering_check`, which identifies this class in serialized form."
    },
    "chance": {
      "title": "Chance",
      "type": "integer",
      "description": "The chance in six that the check needed, limited to the range 0 to 6. It's the level's\nchance, adjusted for noise, bright light, and a rest with\n`hidden` set."
    },
    "roll": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Roll",
      "description": "The d6 that was rolled, or `None` when the chance came out at zero and no die was\nrolled."
    },
    "encounter": {
      "title": "Encounter",
      "type": "boolean",
      "description": "Whether the check produced an encounter. When it did, the encounter's events follow in\nthe same result."
    }
  },
  "required": [
    "chance",
    "encounter"
  ],
  "title": "WanderingCheckEvent",
  "type": "object"
}