Skip to content

SurpriseRolledEvent

One side's surprise die (referee); roll is None when the side never rolls.

Full documentation: SurpriseRolledEvent. Wire type: surprise_rolled.

Default visibility: referee

Message codes: encounter.surprise.rolled

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": "One side's surprise die (referee); `roll` is `None` when the side never rolls.",
  "properties": {
    "code": {
      "default": "encounter.surprise.rolled",
      "title": "Code",
      "type": "string"
    },
    "visibility": {
      "$ref": "#/$defs/Visibility",
      "default": "referee"
    },
    "event_type": {
      "const": "surprise_rolled",
      "default": "surprise_rolled",
      "title": "Event Type",
      "type": "string"
    },
    "side": {
      "title": "Side",
      "type": "string"
    },
    "threshold": {
      "title": "Threshold",
      "type": "integer"
    },
    "roll": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Roll"
    },
    "surprised": {
      "title": "Surprised",
      "type": "boolean"
    }
  },
  "required": [
    "side",
    "threshold",
    "surprised"
  ],
  "title": "SurpriseRolledEvent",
  "type": "object"
}