MonsterFledEvent
A monster group fled the battle.
Full documentation: MonsterFledEvent. Wire type: monster_fled.
Default visibility: player
Message codes: battle.side.fled
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 monster group fled the battle.\n\nEmitted by `ResolveBattleRound` when\na group fails its morale check and flees. When a battle opens, it's also emitted for a\ngroup whose morale is so low that it never fights at all.\n\nWhen a cleric turns only some of a group, the turned members leave the group and flee as\na new group, and `group_id` is the new group's id.\n\nA fleeing group moves away each round. It has left the battle once it's more than\n`FLEE_EXIT_FEET` from the party. Its members\nstill count as defeated for the experience award.",
"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 sees them break."
},
"event_type": {
"const": "monster_fled",
"default": "monster_fled",
"title": "Event Type",
"type": "string",
"description": "The event type, `monster_fled`, which identifies this class in serialized form."
},
"group_id": {
"title": "Group Id",
"type": "string",
"description": "Which group broke, as its encounter group id."
}
},
"required": [
"code",
"group_id"
],
"title": "MonsterFledEvent",
"type": "object"
}