TimeAdvancedEvent
The referee moved the clock.
Full documentation: TimeAdvancedEvent. Wire type: time_advanced.
Default visibility: referee
Message codes: session.time.advanced
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 referee moved the clock.\n\nEmitted by `AdvanceTime`, after the events of the\ntime that passed. Effects run out, lights burn out, and the session uses up provisions\nfor each day crossed, and those events arrive in the same result. No wandering-monster\ncheck and no fatigue check runs: a referee moving the clock decides what happens.",
"properties": {
"code": {
"default": "session.time.advanced",
"title": "Code",
"type": "string",
"description": "The message code, always `session.time.advanced`."
},
"visibility": {
"$ref": "#/$defs/Visibility",
"default": "referee",
"description": "Referee visibility: the players see what the time passing does, not the command that passed it."
},
"event_type": {
"const": "time_advanced",
"default": "time_advanced",
"title": "Event Type",
"type": "string",
"description": "The event type, `time_advanced`, which identifies this class in serialized form."
},
"n": {
"title": "N",
"type": "integer",
"description": "How many units were asked for."
},
"unit": {
"title": "Unit",
"type": "string",
"description": "Which unit, as a lowercase `TimeUnit` value: `\"round\"`,\n`\"turn\"`, or `\"day\"`."
},
"rounds_total": {
"title": "Rounds Total",
"type": "integer",
"description": "Where the clock now stands, in rounds since the session began. It's the same number as\n`GameSession.clock.rounds`."
}
},
"required": [
"n",
"unit",
"rounds_total"
],
"title": "TimeAdvancedEvent",
"type": "object"
}