Skip to content

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 may see an event: the players, or only the referee.\n\nEvery event has one of these values, because in B/X the referee makes some rolls behind a screen. Filter\na log on it before you show anything to a player, or call\n`GameSession.view`, which builds the players' view and the referee's\nview for you. A narrator that plays the referee reads every event.\n\nA serialized event contains the lowercase value. The values stay fixed within a `schema_version`, the version\nstamp of the saved format.\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 can't move, like those asleep, paralysed, or held.\n\nThe runners stay in the original group and go on fleeing. The ones left behind become\na new group at the distance where the side broke, so the party can finish them,\ntake 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 event type, `monsters_left_behind`, which identifies this class in serialized form."
    },
    "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"
}