MonstersSpawnedEvent

Monsters were put into the session by the referee.

Full documentation: MonstersSpawnedEvent. Wire type: monsters_spawned.

Default visibility: referee

Message codes: session.monsters.spawned

JSON Schema

{
  "$defs": {
    "Visibility": {
      "description": "Who is allowed to see an event.\n\nEvery event has one of these two values, and the split exists because B/X keeps some rolls behind the\nreferee's screen. Filter a log on it before you show anything to a player, or call\n`GameSession.view`, which builds the player's and the referee's\nviews for you. A narrator playing referee reads both.\n\nThe values are the lowercase strings and they serialize into every event, so a renamed value is a\n`schema_version` bump.\n\nExamples:\n    ```python\n    from osrlib.core.events import DamageDealtEvent, HitPointsReportedEvent, Visibility\n\n    log = [\n        DamageDealtEvent(target_id=\"monster-0001\", amount=5),\n        HitPointsReportedEvent(target_id=\"monster-0001\", current_hp=2, max_hp=7),\n    ]\n    shown = [event.code for event in log if event.visibility is Visibility.PLAYER]\n    assert shown == [\"combat.damage.dealt\"]  # the goblin's remaining hit points stay hidden\n    ```",
      "enum": [
        "player",
        "referee"
      ],
      "title": "Visibility",
      "type": "string"
    }
  },
  "description": "Monsters were put into the session by the referee.\n\nEmitted by `SpawnMonsters`, before the\nencounter that fields them opens in the same result.\n\nIt's referee visibility and contains ids rather than a description. The party\nlearns what walked in from\n`EncounterStartedEvent`.",
  "properties": {
    "code": {
      "default": "session.monsters.spawned",
      "title": "Code",
      "type": "string",
      "description": "The message code, always `session.monsters.spawned`."
    },
    "visibility": {
      "$ref": "#/$defs/Visibility",
      "default": "referee",
      "description": "Referee visibility: this is bookkeeping, not a moment in the fiction."
    },
    "event_type": {
      "const": "monsters_spawned",
      "default": "monsters_spawned",
      "title": "Event Type",
      "type": "string",
      "description": "The wire discriminator, `monsters_spawned`."
    },
    "template_id": {
      "title": "Template Id",
      "type": "string",
      "description": "What was spawned, as a monster catalog id."
    },
    "monster_ids": {
      "items": {
        "type": "string"
      },
      "title": "Monster Ids",
      "type": "array",
      "description": "The session ids of the new instances, in spawn order. They are what every later event about\nthose creatures names."
    }
  },
  "required": [
    "template_id",
    "monster_ids"
  ],
  "title": "MonstersSpawnedEvent",
  "type": "object"
}