BattleStartedEvent
The encounter became a battle.
Full documentation: BattleStartedEvent. Wire type: battle_started.
Default visibility: player
Message codes: battle.started
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 encounter became a battle.\n\nEmitted when a fight opens: by `EngageBattle`\nwhen the party attacks, and by whichever command is running when the monsters attack.\nThe monsters can attack the moment an encounter opens, when a parley goes wrong, when\na hostile or uncertain stance turns to attack on a later round, when undead are\npresented with a holy symbol and not turned, or when a chase ends in capture.\n\nThe session mode becomes `battle`, where\n`ResolveBattleRound` is the only play\ncommand the session accepts. In battle, the session doesn't place monsters on cells. Each\nmonster group has a distance from the party, and closing in or pulling back changes it.",
"properties": {
"code": {
"default": "battle.started",
"title": "Code",
"type": "string",
"description": "The message code, always `battle.started`."
},
"visibility": {
"$ref": "#/$defs/Visibility",
"default": "player",
"description": "Player visibility: the party is in it."
},
"event_type": {
"const": "battle_started",
"default": "battle_started",
"title": "Event Type",
"type": "string",
"description": "The event type, `battle_started`, which identifies this class in serialized form."
}
},
"title": "BattleStartedEvent",
"type": "object"
}