PursuitEvent
One round of a chase: the gap, a distraction taken, an escape, or a capture.
Full documentation: PursuitEvent. Wire type: pursuit.
Default visibility: player
Message codes: encounter.pursuit.caught, encounter.pursuit.distracted, encounter.pursuit.escaped, encounter.pursuit.round
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": "One round of a chase: the gap, a distraction taken, an escape, or a capture.\n\nEmitted by `Evade` for the first round of the chase.\nEach further round comes from `Wait`, to keep running,\nor `DropItems`, to drop something behind the party\nas it runs.\n\nA capture opens battle at once. An escape or a distraction ends the encounter. A\nchase that lasts `PURSUIT_ROUND_CAP` rounds\nends in an escape and tires the party out, which arrives as\n`ExhaustionEvent`.",
"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 can see how close the chase is."
},
"event_type": {
"const": "pursuit",
"default": "pursuit",
"title": "Event Type",
"type": "string",
"description": "The event type, `pursuit`, which identifies this class in serialized form."
},
"round": {
"title": "Round",
"type": "integer",
"description": "Which round of the chase this is, counting from one."
},
"gap_feet": {
"title": "Gap Feet",
"type": "integer",
"description": "How far ahead the party is, in feet, at the end of this round. It never goes below zero, and\nat five feet or less the pursuers have caught up."
}
},
"required": [
"code",
"round",
"gap_feet"
],
"title": "PursuitEvent",
"type": "object"
}