Skip to content

WanderingCheckEvent

A wandering-monster check fired (referee bookkeeping).

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.\n\nThe wire values are `\"player\"` and `\"referee\"` \u2014 lowercase, serialized into every\nevent; changing them is a `schema_version` bump.",
      "enum": [
        "player",
        "referee"
      ],
      "title": "Visibility",
      "type": "string"
    }
  },
  "description": "A wandering-monster check fired (referee bookkeeping).\n\n`roll` is `None` when the clamped chance was 0 and the roll was skipped.",
  "properties": {
    "code": {
      "default": "exploration.wandering.checked",
      "title": "Code",
      "type": "string"
    },
    "visibility": {
      "$ref": "#/$defs/Visibility",
      "default": "referee"
    },
    "event_type": {
      "const": "wandering_check",
      "default": "wandering_check",
      "title": "Event Type",
      "type": "string"
    },
    "chance": {
      "title": "Chance",
      "type": "integer"
    },
    "roll": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Roll"
    },
    "encounter": {
      "title": "Encounter",
      "type": "boolean"
    }
  },
  "required": [
    "chance",
    "encounter"
  ],
  "title": "WanderingCheckEvent",
  "type": "object"
}