Skip to content

DetectionRolledEvent

A referee-rolled detection die: search, listen, and trap-spring checks.

Full documentation: DetectionRolledEvent. Wire type: detection_rolled.

Default visibility: referee

Message codes: exploration.detection.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": "A referee-rolled detection die: search, listen, and trap-spring checks.\n\nRolled whether or not anything is there (the no-leak convention); `roll` is\n`None` when a zero chance consumed no die.",
  "properties": {
    "code": {
      "default": "exploration.detection.rolled",
      "title": "Code",
      "type": "string"
    },
    "visibility": {
      "$ref": "#/$defs/Visibility",
      "default": "referee"
    },
    "event_type": {
      "const": "detection_rolled",
      "default": "detection_rolled",
      "title": "Event Type",
      "type": "string"
    },
    "character_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Character Id"
    },
    "kind": {
      "title": "Kind",
      "type": "string"
    },
    "chance": {
      "title": "Chance",
      "type": "integer"
    },
    "roll": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Roll"
    },
    "passed": {
      "title": "Passed",
      "type": "boolean"
    }
  },
  "required": [
    "kind",
    "chance",
    "passed"
  ],
  "title": "DetectionRolledEvent",
  "type": "object"
}