MonstersLeftBehindEvent

A group that ran left its helpless members lying where they were.

Full documentation: MonstersLeftBehindEvent. Wire type: monsters_left_behind.

Default visibility: player

Message codes: battle.group.left_behind

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": "A group that ran left its helpless members lying where they were.\n\nEmitted by `ResolveBattleRound` when\na broken group has members who cannot run, because they are asleep, paralysed, or\nheld.\n\nThe runners keep the original group and go on fleeing, and the ones left behind\nbecome a new group at the distance the side broke from, so the party can finish\nthem, take what they carry, or walk past.",
  "properties": {
    "code": {
      "default": "battle.group.left_behind",
      "title": "Code",
      "type": "string",
      "description": "The message code, always `battle.group.left_behind`."
    },
    "visibility": {
      "$ref": "#/$defs/Visibility",
      "default": "player",
      "description": "Player visibility: the party can see who was abandoned."
    },
    "event_type": {
      "const": "monsters_left_behind",
      "default": "monsters_left_behind",
      "title": "Event Type",
      "type": "string",
      "description": "The wire discriminator, `monsters_left_behind`."
    },
    "group_id": {
      "title": "Group Id",
      "type": "string",
      "description": "The new group the helpless members were put into."
    },
    "source_group_id": {
      "title": "Source Group Id",
      "type": "string",
      "description": "The group that ran off without them."
    },
    "count": {
      "title": "Count",
      "type": "integer",
      "description": "How many were left behind."
    }
  },
  "required": [
    "group_id",
    "source_group_id",
    "count"
  ],
  "title": "MonstersLeftBehindEvent",
  "type": "object"
}