ProvisionsEvent
A day passed, and a character either ate and drank or went without.
Full documentation: ProvisionsEvent. Wire type: provisions.
Default visibility: player
Message codes: exploration.provisions.consumed, exploration.provisions.short
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 day passed, and a character either ate and drank or went without.\n\nEmitted once per living member per kind whenever a day boundary passes, which can\nhappen inside any command that passes time, and most often inside a\n`Rest`.\n\nGoing short adds a day to a count the session keeps for that member (see\n`consume_provisions`). Whether the\ncount brings a penalty depends on\n`Ruleset.deprivation_penalties`,\nwhich is off by default. [The adaptations\nregister](https://mmacy.github.io/osrlib-python/adaptations/), the page that lists\nwhere osrlib settles an ambiguous rule or supplies a default, describes the\npenalties. In town nobody runs short.",
"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 ate and drank."
},
"event_type": {
"const": "provisions",
"default": "provisions",
"title": "Event Type",
"type": "string",
"description": "The event type, `provisions`, which identifies this class in serialized form."
},
"character_id": {
"title": "Character Id",
"type": "string",
"description": "The member whose rations or water this was."
},
"kind": {
"title": "Kind",
"type": "string",
"description": "Which supply the event is about: `\"food\"` or `\"water\"`. Each member gets one of each per\nday."
}
},
"required": [
"code",
"character_id",
"kind"
],
"title": "ProvisionsEvent",
"type": "object"
}