RestedEvent
A rest finished, or was interrupted before it could.
Full documentation: RestedEvent. Wire type: rested.
Default visibility: player
Message codes: exploration.rest.interrupted, exploration.rest.rested
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 rest finished, or was interrupted before it could.\n\nEmitted by `Rest`. The `code` says how the rest went:\n`exploration.rest.rested` for a rest that ran to its end, and\n`exploration.rest.interrupted` for one a wandering monster cut short.\n\nA completed rest clears the penalty for going without rest, and counts toward recovering\nfrom exhaustion after a chase. A rest of a full day, 144 turns, also heals the party. An interrupted\nrest heals nobody. If the party rested at least one full turn (10 minutes of game\ntime, or 60 rounds) before the monsters came, the rest still clears that penalty, and\neach full turn counts toward recovery.",
"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 knows whether it got its rest."
},
"event_type": {
"const": "rested",
"default": "rested",
"title": "Event Type",
"type": "string",
"description": "The event type, `rested`, which identifies this class in serialized form."
},
"kind": {
"title": "Kind",
"type": "string",
"description": "How long the party tried to rest: `\"turn\"` for the one-turn breather the dungeon rule\ncalls for, `\"night\"`, or `\"day\"`."
}
},
"required": [
"code",
"kind"
],
"title": "RestedEvent",
"type": "object"
}