NpcPartySpawnedEvent

An NPC adventuring party generated and fielded (referee — the full roster).

Full documentation: NpcPartySpawnedEvent. Wire type: npc_party_spawned.

Default visibility: referee

Message codes: encounter.npc_party.spawned

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 NPC adventuring party generated and fielded (referee \u2014 the full roster).\n\nThe player-facing `EncounterStartedEvent` names \"adventurers\" and the count;\nthe roster, classes, and levels are the referee's.",
  "properties": {
    "code": {
      "default": "encounter.npc_party.spawned",
      "title": "Code",
      "type": "string"
    },
    "visibility": {
      "$ref": "#/$defs/Visibility",
      "default": "referee"
    },
    "event_type": {
      "const": "npc_party_spawned",
      "default": "npc_party_spawned",
      "title": "Event Type",
      "type": "string"
    },
    "party_kind": {
      "title": "Party Kind",
      "type": "string"
    },
    "npc_ids": {
      "items": {
        "type": "string"
      },
      "title": "Npc Ids",
      "type": "array"
    },
    "class_ids": {
      "items": {
        "type": "string"
      },
      "title": "Class Ids",
      "type": "array"
    },
    "levels": {
      "items": {
        "type": "integer"
      },
      "title": "Levels",
      "type": "array"
    },
    "alignment": {
      "title": "Alignment",
      "type": "string"
    }
  },
  "required": [
    "party_kind",
    "npc_ids",
    "class_ids",
    "levels",
    "alignment"
  ],
  "title": "NpcPartySpawnedEvent",
  "type": "object"
}