Skip to content

SpawnNpcParty

Referee: generate an NPC adventuring party and open an encounter.

Full documentation: SpawnNpcParty. Wire type: spawn_npc_party.

Legal session modes: battle, encounter, exploring, game_over, town

JSON Schema

{
  "description": "Referee: generate an NPC adventuring party and open an encounter.\n\n`count_dice=None` rolls the compiled composition dice (Basic 1d4+4, Expert\n1d6+3) \u2014 the surface for keyed content, quest listeners, and tests. Referee\ncommands are legal in every mode, but the party must be standing in a dungeon\nwith no encounter already open.\n\nModes:\n    `town`, `exploring`, `encounter`, `battle`, `game_over`\n\nRejections:\n    - `session.command.encounter_in_progress` \u2014 an encounter or battle is\n      already open.\n    - `session.command.not_in_dungeon` \u2014 the party is not on a dungeon cell.\n\nEvents:\n    [`NpcPartySpawnedEvent`][osrlib.crawl.events.NpcPartySpawnedEvent] (the\n    referee-visibility roster), then the encounter opening as with\n    [`SpawnMonsters`][osrlib.crawl.commands.SpawnMonsters].",
  "properties": {
    "command_type": {
      "const": "spawn_npc_party",
      "default": "spawn_npc_party",
      "title": "Command Type",
      "type": "string"
    },
    "party_kind": {
      "enum": [
        "basic",
        "expert"
      ],
      "title": "Party Kind",
      "type": "string"
    },
    "count_dice": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Count Dice"
    },
    "distance_feet": {
      "minimum": 0,
      "title": "Distance Feet",
      "type": "integer"
    }
  },
  "required": [
    "party_kind",
    "distance_feet"
  ],
  "title": "SpawnNpcParty",
  "type": "object"
}