Rest
Rest the party for one turn, a night (48 turns), or a full day (144 turns).
Full documentation: Rest. Wire type: rest.
Legal session modes: exploring, town
JSON Schema
{
"description": "Rest the party for one turn, a night (48 turns), or a full day (144 turns).\n\nSend it in town or while exploring. Set `kind` to `\"turn\"`, `\"night\"`, or `\"day\"` to choose\nthe length. A turn is ten minutes of game time. A rest clears the party's fatigue, the \u22121\npenalty a party in a dungeon gets when it goes six turns without a turn of rest\n(`FATIGUE_KIND`). Three turns of rest also clear\nexhaustion, the heavier penalty a party gets for running from a long pursuit\n(`EXHAUSTED_KIND`).\n\nA night or a day of rest counts as sleep, which casters need before\n`PrepareSpells`. A full day of rest also applies\nnatural healing to every living member.\n\nIn a dungeon, the wandering-monster checks go on while the party rests. A check that\nturns up monsters interrupts the rest and opens an encounter. To lower the chance of each\ncheck by 1, set `hidden` when the party rests quietly in an out-of-the-way place.\n\nAn interrupted rest isn't sleep, and it heals nobody. It still counts the full turns the\nparty rested before the monsters came. One full turn clears fatigue, and each full turn\ncounts toward the three turns of rest that clear exhaustion. A rest interrupted during\nits first turn clears nothing.\n\nModes:\n `town`, `exploring`\n\nRejections:\n - `session.command.wrong_mode` - an encounter or battle is underway, or the\n session has ended.\n\nEvents:\n The events of the time that passes come first: light burning down, provisions, and\n wandering-monster checks. Then comes a `RestedEvent`\n with code `exploration.rest.rested`. An interrupted rest ends with the encounter's\n opening events and a `RestedEvent` with code `exploration.rest.interrupted`\n instead. A rest that clears fatigue or exhaustion, interrupted or not, adds a\n `FatigueEvent` or an\n `ExhaustionEvent`, and a full day's natural\n healing adds a `HealingAppliedEvent`\n for each member it heals.",
"properties": {
"command_type": {
"const": "rest",
"default": "rest",
"title": "Command Type",
"type": "string",
"description": "The name that identifies the command class in serialized data. Each command class fixes\nit to a distinct snake_case string, like `\"move_party\"` or `\"open_door\"`, and constructing\nthe class sets it, so you never pass it yourself.\n`parse_command` and the\n`AnyCommand` union use it to rebuild the right class\nfrom a serialized mapping. A class's value never changes between releases."
},
"source": {
"anyOf": [
{
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Source",
"description": "Who or what issued the command on whose behalf: an authored trigger or quest id, or the\nname of one of your game's systems. The engine never reads it, so a command with a\n`source` does exactly what the same command without one does. The session logs and\nreplays it with the command, so the log alone shows why something happened. Leave it\n`None` when there's nothing to record. An empty string fails validation when the command\nis constructed."
},
"kind": {
"enum": [
"turn",
"night",
"day"
],
"title": "Kind",
"type": "string",
"description": "How long to rest. `turn` is a single turn, the rest a party in a dungeon needs once every\nsix turns to avoid fatigue. `night` is 48 turns and counts as sleep. `day` is 144 turns,\ncounts as sleep, and applies natural healing to every living member. Sleep is what\n`PrepareSpells` needs, so a caster's day starts with\na `night` or a `day` rest. Exhaustion from a pursuit clears after three turns of rest in\ntotal. In a dungeon, a wandering encounter can cut any of the three short."
},
"hidden": {
"default": false,
"title": "Hidden",
"type": "boolean",
"description": "Whether the party rests quietly in an out-of-the-way place, which the OSE SRD calls hiding.\n\nOn a level with the usual 1-in-6 chance of wandering monsters, a hidden rest makes no\nwandering-monster rolls at all, as long as the party has made no noise and has no bright\nlight. That's because `True` lowers the chance of each check during the rest by 1, after\nnoise and bright light have raised it, and the session makes no roll for a chance of 0 in 6.\nIn town no checks run, so the flag changes nothing there.\n\nYour game or the referee decides whether the place qualifies. The session accepts the flag\nas given. With `False`, the default, the checks run at the level's chance with noise and\nlight added, as they do while the party explores."
}
},
"required": [
"kind"
],
"title": "Rest",
"type": "object"
}