Skip to content

EncounterStartedEvent

An encounter opened: visible monster names and counts only.

Full documentation: EncounterStartedEvent. Wire type: encounter_started.

Default visibility: player

Message codes: encounter.started

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": "An encounter opened: visible monster names and counts only.\n\nThe surprise *rolls* are referee events; the outcomes ride here \u2014 being\nsurprised is felt in the fiction.",
  "properties": {
    "code": {
      "default": "encounter.started",
      "title": "Code",
      "type": "string"
    },
    "visibility": {
      "$ref": "#/$defs/Visibility",
      "default": "player"
    },
    "event_type": {
      "const": "encounter_started",
      "default": "encounter_started",
      "title": "Event Type",
      "type": "string"
    },
    "monster_name": {
      "title": "Monster Name",
      "type": "string"
    },
    "count": {
      "title": "Count",
      "type": "integer"
    },
    "distance_feet": {
      "title": "Distance Feet",
      "type": "integer"
    },
    "party_surprised": {
      "default": false,
      "title": "Party Surprised",
      "type": "boolean"
    },
    "monsters_surprised": {
      "default": false,
      "title": "Monsters Surprised",
      "type": "boolean"
    }
  },
  "required": [
    "monster_name",
    "count",
    "distance_feet"
  ],
  "title": "EncounterStartedEvent",
  "type": "object"
}