FatigueEvent
The party gained the penalty for going without rest, or recovered from it.
Full documentation: FatigueEvent. Wire type: fatigue.
Default visibility: player
Message codes: exploration.fatigue.gained, exploration.fatigue.recovered
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 party gained the penalty for going without rest, or recovered from it.\n\nThe B/X rules require a party to rest one turn in every six while it's in a dungeon. A\nturn is 10 minutes of game time, or 60 rounds. A party that goes six turns without a rest\ntakes \u22121 to attack and damage rolls until it rests. These two codes mark when the penalty\nstarts and when it lifts.\n\n`exploration.fatigue.gained` comes from any command that passes a turn while the session\nis in `exploring` mode, once the party has gone six turns without a rest. Under the\n`deprivation_penalties` ruleset flag, three turns are enough when a living member has gone\na full day without food or water. See\n`check_fatigue`.\n\n`exploration.fatigue.recovered` comes from a `Rest` once the\nparty has rested one full turn. One full turn of rest is enough, even if a wandering\nmonster interrupts the rest after that.",
"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 feels it, and the penalty is on their sheets."
},
"event_type": {
"const": "fatigue",
"default": "fatigue",
"title": "Event Type",
"type": "string",
"description": "The event type, `fatigue`, which identifies this class in serialized form."
}
},
"required": [
"code"
],
"title": "FatigueEvent",
"type": "object"
}