Skip to content

BattleEndedEvent

The battle is over: won, quit, or lost.

Full documentation: BattleEndedEvent. Wire type: battle_ended.

Default visibility: player

Message codes: battle.ended.defeat, battle.ended.fled, battle.ended.victory

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": "The battle is over: won, quit, or lost.\n\nEmitted by `ResolveBattleRound`. A\nbattle can also end in the command that opened it, before any\n`ResolveBattleRound`: every group's morale is too low to fight, or the monsters'\nfree round leaves no party member standing.\n\nA victory ends the encounter in the same result. After a retreat, monsters able to\ngive chase start a chase, and the session goes back to `encounter` mode. Otherwise\nthe encounter ends. A defeat means nobody is left standing, and a\n`GameOverEvent` follows in the same result.",
  "properties": {
    "code": {
      "title": "Code",
      "type": "string",
      "description": "What happened, like `combat.attack.hit`: two or more lowercase parts separated by dots. The first part is\nthe area of the rules the event comes from, like `combat` or `magic`.\n\nBranch on it, and pass the event to `format_message` to turn it into English.\nBuilding an event with a code in any other format raises a pydantic `ValidationError`."
    },
    "visibility": {
      "$ref": "#/$defs/Visibility",
      "default": "player",
      "description": "Player visibility: the party is in the fight and sees how it ends."
    },
    "event_type": {
      "const": "battle_ended",
      "default": "battle_ended",
      "title": "Event Type",
      "type": "string",
      "description": "The event type, `battle_ended`, which identifies this class in serialized form."
    }
  },
  "required": [
    "code"
  ],
  "title": "BattleEndedEvent",
  "type": "object"
}