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 is allowed to see an event.\n\nEvery event has one of these two values, and the split exists because B/X keeps some rolls behind the\nreferee's screen. Filter a log on it before you show anything to a player, or call\n`GameSession.view`, which builds the player's and the referee's\nviews for you. A narrator playing referee reads both.\n\nThe values are the lowercase strings and they serialize into every event, so a renamed value is a\n`schema_version` bump.\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`. The time passes\nwith all its usual bookkeeping, so effect expiries, light burning out, and\nprovisions for a day crossed all arrive in the same result, but no wandering\ncheck runs: a referee moving the clock decides for themselves what walks in.",
  "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 clock is the referee's instrument."
    },
    "event_type": {
      "const": "time_advanced",
      "default": "time_advanced",
      "title": "Event Type",
      "type": "string",
      "description": "The wire discriminator, `time_advanced`."
    },
    "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\n`GameSession.clock.rounds` holds."
    }
  },
  "required": [
    "n",
    "unit",
    "rounds_total"
  ],
  "title": "TimeAdvancedEvent",
  "type": "object"
}